curl --request POST \
--url https://api.abacatepay.com/v2/subscriptions/record-usage \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "subs_abc123xyz",
"productId": "prod_api_calls",
"units": 50,
"action": "add"
}
'import requests
url = "https://api.abacatepay.com/v2/subscriptions/record-usage"
payload = {
"id": "subs_abc123xyz",
"productId": "prod_api_calls",
"units": 50,
"action": "add"
}
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({id: 'subs_abc123xyz', productId: 'prod_api_calls', units: 50, action: 'add'})
};
fetch('https://api.abacatepay.com/v2/subscriptions/record-usage', 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.abacatepay.com/v2/subscriptions/record-usage",
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([
'id' => 'subs_abc123xyz',
'productId' => 'prod_api_calls',
'units' => 50,
'action' => 'add'
]),
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.abacatepay.com/v2/subscriptions/record-usage"
payload := strings.NewReader("{\n \"id\": \"subs_abc123xyz\",\n \"productId\": \"prod_api_calls\",\n \"units\": 50,\n \"action\": \"add\"\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.abacatepay.com/v2/subscriptions/record-usage")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"subs_abc123xyz\",\n \"productId\": \"prod_api_calls\",\n \"units\": 50,\n \"action\": \"add\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/subscriptions/record-usage")
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 \"id\": \"subs_abc123xyz\",\n \"productId\": \"prod_api_calls\",\n \"units\": 50,\n \"action\": \"add\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "usgr_abc123xyz",
"subscriptionId": "subs_abc123xyz",
"productId": "prod_api_calls",
"units": 50,
"unitPrice": 100,
"action": "add",
"installmentNumber": 2,
"recordedAt": "2024-12-06T20:10:00.000Z"
},
"error": null,
"success": true
}{
"error": "Token de autenticação inválido ou ausente."
}{
"error": "Subscription not found or not active"
}{
"error": "Product must not have a billing cycle"
}Registrar uso
Registra unidades de uso de um produto avulso (pay-as-you-go) em uma assinatura ativa.
O registro é vinculado à próxima parcela pendente da assinatura e incluído na cobrança do ciclo atual. Use action: "add" para acrescentar unidades e action: "subtract" para estornar unidades já registradas.
O produto informado em productId não deve ter ciclo de cobrança. Produtos de assinatura (com ciclo) retornam erro.
curl --request POST \
--url https://api.abacatepay.com/v2/subscriptions/record-usage \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "subs_abc123xyz",
"productId": "prod_api_calls",
"units": 50,
"action": "add"
}
'import requests
url = "https://api.abacatepay.com/v2/subscriptions/record-usage"
payload = {
"id": "subs_abc123xyz",
"productId": "prod_api_calls",
"units": 50,
"action": "add"
}
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({id: 'subs_abc123xyz', productId: 'prod_api_calls', units: 50, action: 'add'})
};
fetch('https://api.abacatepay.com/v2/subscriptions/record-usage', 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.abacatepay.com/v2/subscriptions/record-usage",
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([
'id' => 'subs_abc123xyz',
'productId' => 'prod_api_calls',
'units' => 50,
'action' => 'add'
]),
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.abacatepay.com/v2/subscriptions/record-usage"
payload := strings.NewReader("{\n \"id\": \"subs_abc123xyz\",\n \"productId\": \"prod_api_calls\",\n \"units\": 50,\n \"action\": \"add\"\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.abacatepay.com/v2/subscriptions/record-usage")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"subs_abc123xyz\",\n \"productId\": \"prod_api_calls\",\n \"units\": 50,\n \"action\": \"add\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.abacatepay.com/v2/subscriptions/record-usage")
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 \"id\": \"subs_abc123xyz\",\n \"productId\": \"prod_api_calls\",\n \"units\": 50,\n \"action\": \"add\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "usgr_abc123xyz",
"subscriptionId": "subs_abc123xyz",
"productId": "prod_api_calls",
"units": 50,
"unitPrice": 100,
"action": "add",
"installmentNumber": 2,
"recordedAt": "2024-12-06T20:10:00.000Z"
},
"error": null,
"success": true
}{
"error": "Token de autenticação inválido ou ausente."
}{
"error": "Subscription not found or not active"
}{
"error": "Product must not have a billing cycle"
}SUBSCRIPTION:CREATE.Como funciona
Diferente do produto principal da assinatura (que tem ciclo fixo), produtos de uso são cobrados de acordo com o consumo real registrado via este endpoint. Cada registro é vinculado à próxima parcela pendente da assinatura. Useaction: "add" para adicionar unidades e action: "subtract" para estornar unidades já registradas no mesmo ciclo.
Corpo da requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | string | Sim | ID da assinatura (subs_...) |
productId | string | Sim | ID do produto de uso (prod_...) — não deve ter ciclo |
units | integer | Sim | Quantidade de unidades (mínimo 1) |
action | string | Sim | "add" para adicionar ou "subtract" para remover unidades |
productId deve ser um produto sem ciclo (cycle: null). Produtos de assinatura (com ciclo) retornam erro.{
"id": "subs_abc123xyz",
"productId": "prod_api_calls",
"units": 50,
"action": "add"
}
{
"id": "subs_abc123xyz",
"productId": "prod_api_calls",
"units": 10,
"action": "subtract"
}
Resposta
Retorna o registro de uso criado, já vinculado à próxima parcela do ciclo (installmentNumber).
{
"data": {
"id": "usgr_abc123xyz",
"subscriptionId": "subs_abc123xyz",
"productId": "prod_api_calls",
"units": 50,
"unitPrice": 100,
"action": "add",
"installmentNumber": 2,
"recordedAt": "2024-12-06T20:10:00.000Z"
},
"success": true,
"error": null
}
| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID do registro de uso (usgr_...) |
subscriptionId | string | ID da assinatura |
productId | string | ID do produto |
units | integer | Quantidade de unidades registradas |
unitPrice | integer | Preço unitário em centavos no momento do registro |
action | string | "add" ou "subtract" |
installmentNumber | integer | Número da parcela onde este uso será cobrado |
recordedAt | string | Data/hora do registro |
action: "add" menos os com action: "subtract" do mesmo ciclo: Σ(add × unitPrice) − Σ(subtract × unitPrice).Authorizations
Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.
Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.
Body
Identificador único da assinatura.
"subs_abc123xyz"
Identificador do produto de uso. Não deve ter ciclo de cobrança.
"prod_api_calls"
Quantidade de unidades a registrar.
x >= 150
add para acrescentar unidades à próxima cobrança; subtract para estornar unidades já registradas no ciclo.
add, subtract "add"
Was this page helpful?