Attributes

Attribute

Description

id int

The unique internal ID of the invoice

amount_due int

Final amount due for this invoice. If the invoice’s total is smaller than the minimum charge amount or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.

amount_paid int

The amount that was paid, in cents.

amount_remaining int

The amount remaining that is due, in cents.

auto_advance bool

Controls whether automatic collection is enabled for this invoice. When false, the invoice’s state will not automatically advance without an explicit action.

billing string

The collection method of this Invoice. Possible values are either charge_automatically, or send_invoice. When set to charge_automatically payment for this Invoice will be automatically attempted using the default source attached to the Customer. When set to send_invoice, emails will be sent to the Customer.

billing_reason string

Indicates the reason why the invoice was created. Most common values are subscription_create, subscription_cycle or subscription_update.

subscription_create indicates an invoice created due to creating a subscription.

subscription_cycle indicates an invoice created by a subscription advancing into a new period.

subscription_update indicates an invoice created due to updating a subscription.

subscription is set for all old invoices to indicate either a change to a subscription or a period advancement.

manual is set for all invoices unrelated to a subscription (for example: created via the invoice editor).

upcoming is reserved for simulated invoices per the upcoming invoice endpoint.

currency string

Three-letter ISO currency code.

description string

An arbitrary string attached to the object. Often useful for displaying to customers.

due_date timestamp

The date on which payment for this invoice is due. This value will be empty for invoices with billing=charged automatically

ending_balance int

Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.

hosted_invoice_url string

The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.

invoice_pdf string

The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.

is_imported bool

Will be set to true if invoices was generated following and import process or a migration.

number string

A unique, identifying string that appears on emails sent to the customer for this invoice.

paid bool

Will be set to true if payment was successfully collected for this invoice, either via a successful a charge or using available credit from the customer’s account balance. Still available for legacy purposes, please look for paid value on status attribute instead.

period_start timestamp

If set, represents the start of the line item's billing period. Measured in seconds since the Unix epoch.

period_end timestamp

If set, represents the end of the line item's billing period. Measured in seconds since the Unix epoch.

post_payment_credit_notes_amount int

Total amount of all post-payment credit notes issued for this invoice, in cents.

pre_payment_credit_notes_amount int

Total amount of all pre-payment credit notes issued for this invoice, in cents.

starting_balance int

Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance.

status string

The status of the invoice, one of: draft, open, paid, past_due, uncollectible, or void

subtotal int

Total of all subscriptions, invoice items, and prorations on the invoice before any discount or tax is applied.

tax int

The amount of tax on this invoice, in cents. This is the sum of all the tax amounts on this invoice.

total int

Total after discounts and taxes, in cents.

finalized_at timestamp

Time at which the invoice status transitioned to open. Measured in seconds since the Unix epoch.

marked_uncollectible_at timestamp

Time at which the invoice status transitioned to uncollectible. Measured in seconds since the Unix epoch.

paid_at timestamp

Time at which the invoice status transitioned to paid. Measured in seconds since the Unix epoch.

voided_at timestamp

Time at which the invoice status transitioned to void. Measured in seconds since the Unix epoch.

created_at timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at timestamp

Time at which the object was last updated. Measured in seconds since the Unix epoch.

deleted_at timestamp

If set, the time at which the object was deleted. Measured in seconds since the Unix epoch.