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.
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
productId deve ser um produto sem ciclo (cycle: null). Produtos de assinatura (com ciclo) retornam erro.Resposta
Retorna o registro de uso criado, já vinculado à próxima parcela do ciclo (installmentNumber).
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"