Invoice

  • amount_due_cents
    Type: integer
    required

    Amount still owed, in the smallest currency unit

  • amount_paid_cents
    Type: integer
    required

    Amount already paid, in the smallest currency unit

  • created
    Type: stringFormat: date-time
    required

    When the invoice was issued (UTC). This is what start/end filter on.

  • currency
    Type: string
    required

    Three-letter ISO currency code, e.g. 'usd'

  • id
    Type: string
    required

    Stripe invoice ID. Pass this to the PDF endpoint.

  • total_cents
    Type: integer
    required

    Invoice total in the smallest currency unit. 103500 is $1,035.00.

  • hosted_invoice_url
    Type: stringnullable

    Stripe-hosted invoice page. Null on the rare finalized invoice Stripe has not yet published a page for.

  • invoice_pdf
    Type: stringnullable

    Direct link to the invoice PDF. The signed token embeds when it was issued, so this is not a stable identifier; GET /v1/payments/invoices/{invoice_id}/pdf returns a freshly-issued link to the same PDF.

  • number
    Type: stringnullable

    Human-readable invoice number, e.g. 'HSLNEQJJ-0006'

  • period_end
    Type: stringFormat: date-timenullable

    End of the billing period the invoice covers (UTC)

  • period_start
    Type: stringFormat: date-timenullable

    Start of the billing period the invoice covers (UTC)

  • status
    Type: stringnullable

    The invoice's Stripe status. Never draft. In practice open, paid, uncollectible or void, but this API filters on draft specifically rather than allowlisting the rest, so accept an unfamiliar non-draft status rather than rejecting it.