Referência

id:

{
  "id": "inv_abc123xyz",
}

id : string.
Identificador único da fatura, começando com inv_

livemode:

{
  "livemode": false,
}

livemode : boolean.
Indica se a fatura está em modo de produção (true) ou teste (false)

customerId:

{
  "customerId": "cus_ahwDXrgYvur89iPs",
}

customerId : string.
ID do cliente associado à fatura. Veja a referência completa aqui

paymentMethodId:

{
  "paymentMethodId": "pm_abc123xyz",
}

paymentMethodId : string | null.
ID do método de pagamento utilizado. Veja a referência completa aqui

status:

{
  "status": "open",
}

status : string.
Status atual da fatura

Status	Descrição
`draft`	A fatura está em rascunho
`open`	A fatura foi emitida e aguarda pagamento
`paid`	A fatura foi paga
`uncollectible`	A fatura não pode ser cobrada
`void`	A fatura foi cancelada

currency:

{
  "currency": "BRL",
}

currency : string.
Código da moeda (ex.: BRL)

number:

{
  "number": "INV-001",
}

number : string | null.
Número sequencial da fatura gerado automaticamente ao ser emitida

description:

{
  "description": null,
}

description : string | null.
Descrição interna da fatura

dueDate:

{
  "dueDate": "2024-12-15T00:00:00.000Z",
}

dueDate : string | null.
Data de vencimento da fatura em formato ISO 8601

paidAt:

{
  "paidAt": null,
}

paidAt : string | null.
Data em que a fatura foi paga. null se ainda não paga

amountDue:

{
  "amountDue": 9900,
}

amountDue : number.
Valor total a ser cobrado em centavos

amountPaid:

{
  "amountPaid": 0,
}

amountPaid : number.
Valor já pago em centavos

attemptCount:

{
  "attemptCount": 0,
}

attemptCount : number.
Número de tentativas de cobrança realizadas

subscriptionId:

{
  "subscriptionId": null,
}

subscriptionId : string | null.
ID da assinatura que gerou esta fatura. null para faturas criadas manualmente

items:

{
  "items": [
    {
      "id": "ii_abc123xyz",
      "priceId": "price_def456ghi",
      "quantity": 1,
      "amount": 9900
    }
  ]
}

items : array.
Lista de itens da fatura. Cada item contém id, priceId, quantity e amount (em centavos)

payments:

{
  "payments": [],
}

payments : array.
Lista de pagamentos associados a esta fatura

createdAt:

{
  "createdAt": "2024-11-15T10:00:00.000Z",
}

createdAt : string.
Data de criação da fatura em formato ISO 8601

updatedAt:

{
  "updatedAt": "2024-11-15T10:00:00.000Z",
}

updatedAt : string.
Data da última atualização da fatura em formato ISO 8601

Primeiros passos

Clientes

Métodos de Pagamento

Pagamentos

Sessões de Checkout

Faturas

Assinaturas

Webhooks

Estrutura

Atributos:

​ Estrutura

​Atributos:

Estrutura

Atributos: