Skip to main content
POST
Criar fatura avulsa
POST /invoices Faz parte do recurso Faturas — o conceito, os oito estados e os links hospedados estão lá. Cria uma cobrança fora do ciclo, atrelada a uma assinatura: uma taxa de implantação, um acordo de dívida, um serviço pontual. O cliente recebe uma cobrança própria, com vencimento e formas de pagamento independentes da mensalidade. Para valores pequenos que podem esperar a virada do ciclo, prefira lançar uma cobrança extra — ela entra na fatura da mensalidade, sem gerar uma segunda cobrança.
O vencimento decide quando a cobrança dispara. dueAt precisa ser futuro; a cobrança é disparada em dueAt - chargeLeadTimeDays da assinatura. Com folga, a fatura nasce scheduled e vira open na hora certa; vencimento próximo nasce open e cobra já. Se a data cair em fim de semana ou feriado e a conta só cobra em dia útil, o vencimento desliza para o próximo dia útil.
A fatura participa do split da assinatura como qualquer outra e sai nos mesmos webhooks de fatura. Funciona também em contrato encerrado — é o caminho para cobrar um valor renegociado ou uma dívida remanescente.

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

Body

application/json
subscriptionId
string
required

Assinatura dona da fatura. Aceita contratos encerrados — é o caminho para cobrar um valor renegociado ou dívida remanescente.

Minimum string length: 1
description
string
required

O que está sendo cobrado (aparece na linha da fatura e na página de pagamento).

Required string length: 1 - 200
amount
integer
required

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

Required range: x > 0
dueAt
string<date-time>
required

Vencimento (ISO 8601 com timezone), estritamente no futuro. A cobrança dispara em dueAt - chargeLeadTimeDays da assinatura; se a data cair em fim de semana ou feriado e a política da conta só cobrar em dia útil, o vencimento desliza para o próximo dia útil.

reason
enum<string>
required

Classificação da cobrança, para auditoria e relatório.

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

Justificativa em texto livre (1 a 500 caracteres). Fica na trilha de auditoria — o pagador não vê; o que ele vê é description.

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

Quantidade. Default 1 — o total da fatura é amount * quantity.

Required range: x > 0
allowedPaymentMethods
enum<string>[]

Formas de pagamento oferecidas na página de pagamento 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 criada