Attribute | Description |
---|---|
id | The unique internal ID of the invoice |
subscription_id | Unique identifier of the subscription expandable |
amount_due | 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_paid | The amount that was paid, in cents. |
amount_remaining | The amount remaining that is due, in cents. |
auto_advance | Controls whether automatic collection is enabled for this invoice. When false, the invoice’s state will not automatically advance without an explicit action. |
billing | The collection method of this Invoice. Possible values are either |
billing_reason | Indicates the reason why the invoice was created. Most common values are
|
currency | Three-letter ISO currency code. |
description | An arbitrary string attached to the object. Often useful for displaying to customers. |
due_date | The date on which payment for this invoice is due. This value will be empty for invoices with |
ending_balance | 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 | 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 | The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. |
is_imported | Will be set to true if invoices was generated following and import process or a migration. |
number | A unique, identifying string that appears on emails sent to the customer for this invoice. |
paid | Will be set to |
period_start | If set, represents the start of the line item's billing period. Measured in seconds since the Unix epoch. |
period_end | If set, represents the end of the line item's billing period. Measured in seconds since the Unix epoch. |
post_payment_credit_notes_amount | Total amount of all post-payment credit notes issued for this invoice, in cents. |
pre_payment_credit_notes_amount | Total amount of all pre-payment credit notes issued for this invoice, in cents. |
starting_balance | Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. |
status | The status of the invoice, one of: |
subtotal | Total of all subscriptions, invoice items, and prorations on the invoice before any discount or tax is applied. |
tax | The amount of tax on this invoice, in cents. This is the sum of all the tax amounts on this invoice. |
customer_address | The object represent customer address which be referred to on invoice level, when null the default will be customer's default billing address, contains (country, city, state, line1, line2, postal_code) |
total | Total after discounts and taxes, in cents. |
finalized_at | Time at which the invoice status transitioned to |
marked_uncollectible_at | Time at which the invoice status transitioned to |
paid_at | Time at which the invoice status transitioned to |
voided_at | Time at which the invoice status transitioned to |
created_at | Time at which the object was created. Measured in seconds since the Unix epoch. |
updated_at | Time at which the object was last updated. Measured in seconds since the Unix epoch. |
deleted_at | If set, the time at which the object was deleted. Measured in seconds since the Unix epoch. |
charge_id | Unique identifier of the charge expandable |
user_id | Unique identifier of the customer expandable |