v2

latestOpenAPI 3.1.02026-07-314524165.2 KB

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.

post/subscriptions/record-usage

Request body

idstring required

Identificador único da assinatura.

productIdstring required

Identificador do produto de uso. Não deve ter ciclo de cobrança.

unitsinteger required

Quantidade de unidades a registrar.

action'add' | 'subtract' required

add para acrescentar unidades à próxima cobrança; subtract para estornar unidades já registradas no ciclo.

Example request

{
  "id": "subs_abc123xyz",
  "productId": "prod_api_calls",
  "units": 50,
  "action": "add"
}

Response

Uso registrado com sucesso.

errorstring nullable
successboolean

Se a requisição obteve sucesso ou não.

Example response

{
  "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
}