Skip to main content
POST
Lançar cobrança extra
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.
Prepaid ou postpaid decide qual fatura recolhe o item, não se ele será cobrado. Em cobrança antecipada (o padrão), a fatura do ciclo corrente já foi emitida quando você lança o item — ele espera o ciclo seguinte. Em cobrança postecipada, a fatura do ciclo corrente só fecha no fim do período — um item lançado a qualquer momento durante esse período ainda entra nela.
Cancelar a assinatura não descarta a fila. O que ainda está 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

Resposta 201

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Headers

Idempotency-Key
string

Chave única para garantir idempotência da requisição

Path Parameters

id
string
required

ID da assinatura

Body

application/json
description
string
required

O que está sendo cobrado (aparece na linha da fatura).

Required string length: 1 - 255
amount
integer
required

Valor unitário, em centavos (menor unidade da moeda). A moeda é a da assinatura.

Required range: x > 0
reason
enum<string>
required

Classificaçã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.

Available options:
extra_service,
adjustment,
penalty,
other
reasonDetails
string
required

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.

Required string length: 1 - 500
quantity
integer
default:1

Quantidade. Default 1 — o total lançado é amount * quantity.

Required range: x >= 1

Response

Cobrança extra lançada, com status pending