Skip to main content
The invoice object represents a billing document generated for an organization. Invoices can be for plan subscriptions or usage fees, and support multiple payment methods including credit card and boleto. All monetary values are in cents.
​
invoiceId
string
O identificador unico da fatura (UUIDv7).
​
organizationId
string
O ID da organizacao.
​
subscriptionId
string|null
The associated subscription ID (UUIDv7). Null for standalone invoices.
​
externalRef
string
The external reference for the invoice.
​
type
string
O tipo da fatura. One of: PLAN, FEE.
​
paymentMethod
string|null
O metodo de pagamento utilizado.
​
card
object|null
Card details when the payment method is a card.
​
boleto
object|null
Boleto details when the payment method is a boleto.
​
currency
string
O codigo da moeda (ex: BRL, USD).
​
totalAmount
integer
O valor total em centavos.
​
discountAmount
integer
O valor de desconto em centavos.
​
payableAmount
integer
The payable amount in cents (total minus discounts).
​
discounts
array
The discounts applied to this invoice.
​
lines
array
The invoice line items.
​
status
string
O status da fatura. One of: DRAFT, OPEN, PAID, PAYMENT_FAILED, REFUNDED, PARTIALLY_REFUNDED, DISPUTED, CHARGEBACK, CHARGEBACK_RESOLVED, UNCOLLECTIBLE, VOID, EXPIRED.
​
issuedAt
string
Timestamp when the invoice was issued (ISO 8601).
​
dueDate
string
The invoice due date (ISO 8601).
​
paidAt
string|null
Timestamp when the invoice was paid (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"
}