Skip to main content
POST
Fechar as cobranças extras agora
POST /subscriptions/:id/extra-items/settle Faz parte do recurso Assinaturas. Os itens são criados em Lançar cobrança extra e a fila inteira está em Listar cobranças extras. Emite uma fatura avulsa com todas as cobranças extras pending da assinatura, sem esperar a próxima fatura de ciclo — que, numa recorrência anual, pode estar a doze meses. Os itens passam a consumed, com consumedInvoiceId apontando para a fatura emitida, e não entram mais na fatura do ciclo. O contrato não muda: nem o ciclo, nem a data da próxima fatura, nem o valor da mensalidade. O corpo é opcional — as linhas e o valor vêm da fila. Sem corpo, a fatura vence hoje e a cobrança dispara no ato.

O vencimento decide quando a cobrança acontece

A fatura resultante é uma avulsa como qualquer outra: a cobrança dispara em dueAt - chargeLeadTimeDays da assinatura. Com dueAt no futuro, a fatura nasce scheduled; sem dueAt, nasce open. O que acontece na abertura depende da forma de pagamento da assinatura:
Em PIX e boleto, um vencimento distante adia o e-mail. O link é enviado quando a fatura abre — chargeLeadTimeDays antes do vencimento —, e não no momento desta chamada. Para que ele saia agora, omita o dueAt.

Recusas

Fila vazia responde 409. Não há o que faturar quando nenhum item está pending.
Assinatura inexistente ou de outra conta responde 404. dueAt no passado responde 400.

Depois de emitida

A fatura participa do split da assinatura, dispara os mesmos webhooks invoice.* e tem a mesma página de pagamento hospedada. Cada item recolhido dispara um extra_item.billed. Anular a fatura devolve os itens para a fila — eles voltam a pending e entram no próximo fechamento, seja o do ciclo ou outra chamada desta rota.

Exemplo

Resposta 201
As linhas da fatura podem não estar disponíveis imediatamente. O total desta resposta já é o definitivo; a composição aparece em GET /invoices/{id}, que pode devolver items vazio nos instantes seguintes. O webhook invoice.issued marca o momento em que ela está completa.

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
dueAt
string<date-time>

Vencimento da fatura de fechamento (ISO 8601 com timezone), estritamente no futuro. Ausente = vence hoje, e a cobrança dispara no ato.

reasonDetails
string

Justificativa do fechamento antecipado, para a trilha de auditoria (1 a 500 caracteres). Ausente = texto padrão. O pagador não vê — o que ele vê é a description de cada item.

Required string length: 1 - 500
allowedPaymentMethods
enum<string>[]

Formas de pagamento oferecidas na página desta fatura. Ausente = o método padrão da assinatura.

Required array length: 1 - 3 elements
Available options:
card,
pix,
boleto
installmentsConfig
object | null

Parcelamento oferecido ao pagador no cartão — só faz sentido com card em allowedPaymentMethods. Ausente/null = à vista.

Response

Fatura de fechamento emitida