Credits
Consume Credits
Consume credits with given parameters
POST
/
companies
/
{company_id}
/
credits
/
consume
Consume Credits
curl --request POST \
--url https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customer_id": "<string>",
"type": "<string>",
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"credit_id": "<string>",
"item_id": "<string>",
"note": "<string>",
"subscription_id": "<string>",
"units": 1
}
'import requests
url = "https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume"
payload = {
"customer_id": "<string>",
"type": "<string>",
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"credit_id": "<string>",
"item_id": "<string>",
"note": "<string>",
"subscription_id": "<string>",
"units": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_id: '<string>',
type: '<string>',
amount: {currency: '<string>', value_in_cents: 123},
credit_id: '<string>',
item_id: '<string>',
note: '<string>',
subscription_id: '<string>',
units: 1
})
};
fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'customer_id' => '<string>',
'type' => '<string>',
'amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'credit_id' => '<string>',
'item_id' => '<string>',
'note' => '<string>',
'subscription_id' => '<string>',
'units' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume"
payload := strings.NewReader("{\n \"customer_id\": \"<string>\",\n \"type\": \"<string>\",\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"credit_id\": \"<string>\",\n \"item_id\": \"<string>\",\n \"note\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"units\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"<string>\",\n \"type\": \"<string>\",\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"credit_id\": \"<string>\",\n \"item_id\": \"<string>\",\n \"note\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"units\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"<string>\",\n \"type\": \"<string>\",\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"credit_id\": \"<string>\",\n \"item_id\": \"<string>\",\n \"note\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"units\": 1\n}"
response = http.request(request)
puts response.read_body{
"total_amount": {},
"total_units": {},
"total_units_with_meta": {}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The idempotency key that will be used to ensure the request is only performed once
Path Parameters
The company ID with the prefix 'cmp_'.
Body
application/json
The customer ID to consume credits
The type of the credit to be consumed, can be one of AMOUNT or UNITS
The amount to be consumed
Show child attributes
Show child attributes
The specific credit ID to consume
The billable item ID whose units are to be consumed
Add any notes attached to the credit consumption
The specific subscription to consume credits from
The units to consume
Required range:
x >= 0⌘I
Consume Credits
curl --request POST \
--url https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"customer_id": "<string>",
"type": "<string>",
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"credit_id": "<string>",
"item_id": "<string>",
"note": "<string>",
"subscription_id": "<string>",
"units": 1
}
'import requests
url = "https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume"
payload = {
"customer_id": "<string>",
"type": "<string>",
"amount": {
"currency": "<string>",
"value_in_cents": 123
},
"credit_id": "<string>",
"item_id": "<string>",
"note": "<string>",
"subscription_id": "<string>",
"units": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
customer_id: '<string>',
type: '<string>',
amount: {currency: '<string>', value_in_cents: 123},
credit_id: '<string>',
item_id: '<string>',
note: '<string>',
subscription_id: '<string>',
units: 1
})
};
fetch('https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'customer_id' => '<string>',
'type' => '<string>',
'amount' => [
'currency' => '<string>',
'value_in_cents' => 123
],
'credit_id' => '<string>',
'item_id' => '<string>',
'note' => '<string>',
'subscription_id' => '<string>',
'units' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume"
payload := strings.NewReader("{\n \"customer_id\": \"<string>\",\n \"type\": \"<string>\",\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"credit_id\": \"<string>\",\n \"item_id\": \"<string>\",\n \"note\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"units\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customer_id\": \"<string>\",\n \"type\": \"<string>\",\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"credit_id\": \"<string>\",\n \"item_id\": \"<string>\",\n \"note\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"units\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmeasure.com/api/v1/companies/{company_id}/credits/consume")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_id\": \"<string>\",\n \"type\": \"<string>\",\n \"amount\": {\n \"currency\": \"<string>\",\n \"value_in_cents\": 123\n },\n \"credit_id\": \"<string>\",\n \"item_id\": \"<string>\",\n \"note\": \"<string>\",\n \"subscription_id\": \"<string>\",\n \"units\": 1\n}"
response = http.request(request)
puts response.read_body{
"total_amount": {},
"total_units": {},
"total_units_with_meta": {}
}
