Invoice

  • amount_due_cents
    Type: integer · Amount Due Cents
    required

    Amount still owed, in the smallest currency unit

  • amount_paid_cents
    Type: integer · Amount Paid Cents
    required

    Amount already paid, in the smallest currency unit

  • created
    Type: string · CreatedFormat: date-time
    required

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

  • currency
    Type: string · Currency
    required

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

  • id
    Type: string · Id
    required

    Stripe invoice ID. Pass this to the PDF endpoint.

  • total_cents
    Type: integer · Total Cents
    required

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

  • hosted_invoice_url
    Type: string · Hosted Invoice Urlnullable

    Stripe-hosted invoice page. Null on draft invoices.

  • invoice_pdf
    Type: string · Invoice Pdfnullable

    Direct link to the invoice PDF. Null on draft invoices.

  • number
    Type: string · Numbernullable

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

  • period_end
    Type: string · Period EndFormat: date-timenullable

    End of the billing period the invoice covers (UTC)

  • period_start
    Type: string · Period StartFormat: date-timenullable

    Start of the billing period the invoice covers (UTC)

  • status
    Type: string · Statusnullable

    One of: draft, open, paid, uncollectible, void