Retrieve invoice
Retrieves the details of an existing invoice.
Required permissions:
invoice:basic:readmember:email:read
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Path Parameters
The unique identifier of the invoice, or a secure token.
"inv_xxxxxxxxxxxxxx"
Response
A successful response
An invoice represents an itemized bill sent by a company to a customer for a specific product and plan, tracking the amount owed, due date, and payment status.
The date and time when the invoice will be automatically finalized. For charge_automatically, triggers an automatic charge. For send_invoice, sends the invoice email at the specified time.
"2023-12-01T05:00:00.401Z"
Whether the invoice includes a buyer processing fee on top of the plan price.
The method used to collect payment for this invoice, such as automatic charging or manual payment.
send_invoice, charge_automatically The company that issued this invoice.
The datetime the invoice was created.
"2023-12-01T05:00:00.401Z"
The plan that this invoice charges for.
The full name of the customer this invoice is addressed to. Null if no name is on file.
"Jane Doe"
The deadline by which payment is expected. Null if the invoice is collected automatically.
"2023-12-01T05:00:00.401Z"
The email address of the customer this invoice is addressed to. Null if no email is on file.
"customer@example.com"
A signed token that allows fetching invoice data publicly without authentication.
"eyJhbGciOiJIUzI1NiJ9..."
The unique identifier for the invoice.
"inv_xxxxxxxxxxxxxx"
Optional line items that break down the invoice total into individual charges.
The billing/mailing address associated with this invoice, if one was provided at creation time.
The sequential invoice number for display purposes.
"#0001"
The checkout URL where the customer can pay this invoice online, with their email address pre-filled and locked.
The product that this invoice was generated for.
The current payment status of the invoice, such as draft, open, paid, or void.
draft, open, paid, past_due, uncollectible, void The date that defines when the subscription billing cycle starts. When set on a renewal plan invoice, all future billing periods anchor to this date.
"2023-12-01T05:00:00.401Z"
The datetime the invoice was last updated.
"2023-12-01T05:00:00.401Z"
The user this invoice is addressed to. Null if the user account has been removed.

