Skip to main content
Uma fatura representa um documento de cobranca emitido para uma organizacao. Faturas sao geradas automaticamente a partir de assinaturas (renovacoes de plano) ou cobracas de taxas, e rastreiam itens, descontos, detalhes de metodo de pagamento e status ao longo de seu ciclo de vida. Voce encontrara objetos de fatura ao listar historico de cobrancas, pagar faturas pendentes ou visualizar cobracas futuras.
​
invoiceId
string
O identificador unico da fatura (UUIDv7).
​
organizationId
string
O ID da organizacao.
​
subscriptionId
string|null
O ID da assinatura associada (UUIDv7). Null para faturas avulsas.
​
externalRef
string
A referencia externa da fatura.
​
type
string
O tipo da fatura. Um de: PLAN, FEE.
​
paymentMethod
string|null
O metodo de pagamento utilizado.
​
card
object|null
Detalhes do cartao quando o metodo de pagamento e um cartao.
​
boleto
object|null
Detalhes do boleto quando o metodo de pagamento e um boleto.
​
currency
string
O codigo da moeda (ex.: BRL, USD).
​
totalAmount
integer
O valor total em centavos.
​
discountAmount
integer
O valor do desconto em centavos.
​
payableAmount
integer
O valor a pagar em centavos (total menos descontos).
​
discounts
array
Os descontos aplicados a esta fatura.
​
lines
array
Os itens da fatura.
​
status
string
O status da fatura. Um de: DRAFT, OPEN, PAID, PAYMENT_FAILED, REFUNDED, PARTIALLY_REFUNDED, DISPUTED, CHARGEBACK, CHARGEBACK_RESOLVED, UNCOLLECTIBLE, VOID, EXPIRED.
​
issuedAt
string
Timestamp de quando a fatura foi emitida (ISO 8601).
​
dueDate
string
A data de vencimento da fatura (ISO 8601).
​
paidAt
string|null
Timestamp de quando a fatura foi paga (ISO 8601).
​
createdAt
string
Timestamp de criacao (ISO 8601).
​
updatedAt
string
Timestamp da ultima atualizacao (ISO 8601).
{
  "invoiceId": "019525fd-c290-7a9e-f6b2-8c0d2e4a6b8e",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "subscriptionId": "019525fd-b17c-7f8d-e5a1-7b9c1d3f5a7d",
  "externalRef": "inv_1Oy2pL2eZvKYlo2C0vIqMZ8y",
  "type": "PLAN",
  "paymentMethod": "CARD",
  "card": {
    "brand": "visa",
    "last4": "4242",
    "expMonth": 12,
    "expYear": 2027
  },
  "boleto": null,
  "currency": "BRL",
  "totalAmount": 29900,
  "discountAmount": 5000,
  "payableAmount": 24900,
  "discounts": [],
  "lines": [
    {
      "id": "li_01HQZC8G2T9YX5J8VQBW3KPQ",
      "name": "Pro Plan - Monthly",
      "unitPrice": 29900,
      "quantity": 1,
      "amount": 29900
    }
  ],
  "status": "PAID",
  "issuedAt": "2026-03-01T00:00:00.000Z",
  "dueDate": "2026-03-10T00:00:00.000Z",
  "paidAt": "2026-03-02T14:30:00.000Z",
  "createdAt": "2026-03-01T00:00:00.000Z",
  "updatedAt": "2026-03-02T14:30:00.000Z"
}