Skip to main content
POST
Enviar fatura por e-mail

Autorizações

Authorization
string
header
obrigatório

Chave secreta da conta: Authorization: Bearer sk_test_… ou sk_live_…. Use só no servidor.

Cabeçalhos

Idempotency-Key
string

Chave única por operação (um UUID serve). Repetir com a mesma chave devolve a resposta original.

Parâmetros de caminho

invoiceID
string<uuid>
obrigatório

ID da fatura.

Resposta

Sucesso.

O que um cliente deve: itens, totais e status. Status: draft → open → paid, ou void / uncollectible.

id
string<uuid>
customerId
string<uuid> | null

Id da inscrição do cliente no produto. Preenchido em faturas de produto, uso ou assinatura.

payerId
string<uuid> | null

Id do cliente que paga. Preenchido em faturas avulsas.

subscriptionId
string<uuid> | null

Assinatura que gerou a fatura

invoiceNumber
string | null

Número sequencial da fatura

status
enum<string>

draft (em montagem), open (emitida, aguardando pagamento), paid, void (cancelada) ou uncollectible (dada como perdida).

Opções disponíveis:
draft,
open,
paid,
void,
uncollectible
currency
string

Moeda, em código ISO 4217 (BRL).

subtotal
string

Soma dos itens antes de impostos e descontos.

tax
string

Impostos da fatura.

total
string

Valor final da fatura.

amountDue
string

Quanto ainda falta pagar.

periodStart
string<date-time> | null

Início do período cobrado

periodEnd
string<date-time> | null

Fim do período cobrado

dueDate
string<date-time> | null

Data de vencimento.

finalizedAt
string<date-time> | null

Quando a fatura foi emitida.

paidAt
string<date-time> | null

Quando a fatura foi paga.

successUrl
string | null

Para onde o checkout leva o comprador depois do pagamento.

cancelUrl
string | null

Para onde o checkout leva o comprador se ele desistir.

createdAt
string<date-time>
lineItems
object[]