Lançar cobrança extra
Enfileira um item avulso que entra na próxima fatura de ciclo da assinatura, junto da mensalidade.
POST /subscriptions/:id/extra-items
Faz parte do recurso Assinaturas — o conceito e os dez estados estão lá. As
faturas que essa fila alimenta são o recurso Faturas.
Cria um item com description, amount (centavos) e quantity opcional (default 1). O item não
gera cobrança nem fatura própria: fica pending até a próxima fatura de ciclo recolhê-lo, como uma
linha one_time ao lado da mensalidade.
Para cobrar antes da virada do ciclo há dois caminhos:
criar uma fatura avulsa, que é uma cobrança separada com
vencimento próprio, ou fechar a fila inteira agora, que
emite uma fatura com tudo que está pendente.
pending no momento do
cancelamento vira uma fatura avulsa final, uma linha por item — pela mesma régua que decide o
destino das faturas vencidas em cancel: com
keepOverdueInvoices: false, as vencidas e a fila são descartadas juntas.Exemplo
Authorizations
API Key da Credential (gerada no Backoffice)
Headers
Chave única para garantir idempotência da requisição
Path Parameters
ID da assinatura
Body
O que está sendo cobrado (aparece na linha da fatura).
1 - 255Valor unitário, em centavos (menor unidade da moeda). A moeda é a da assinatura.
x > 0Classificação da cobrança, para auditoria e relatório. Mesmo vocabulário da fatura avulsa, sem ad_hoc — um item que entra na fatura do ciclo não é avulso.
extra_service, adjustment, penalty, other Justificativa em texto livre (1 a 500 caracteres). Fica na trilha de auditoria do lançamento, não aparece na fatura do pagador — o que o pagador vê é description.
1 - 500Quantidade. Default 1 — o total lançado é amount * quantity.
x >= 1Response
Cobrança extra lançada, com status pending