Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

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

id
string
required

The unique identifier of the invoice, or a secure token.

Example:

"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.

automatically_finalizes_at
string<date-time> | null
required

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.

Example:

"2023-12-01T05:00:00.401Z"

charge_buyer_fee
boolean
required

Whether the invoice includes a buyer processing fee on top of the plan price.

collection_method
enum<string>
required

The method used to collect payment for this invoice, such as automatic charging or manual payment.

Available options:
send_invoice,
charge_automatically
company
object
required

The company that issued this invoice.

created_at
string<date-time>
required

The datetime the invoice was created.

Example:

"2023-12-01T05:00:00.401Z"

current_plan
object
required

The plan that this invoice charges for.

customer_name
string | null
required

The full name of the customer this invoice is addressed to. Null if no name is on file.

Example:

"Jane Doe"

due_date
string<date-time> | null
required

The deadline by which payment is expected. Null if the invoice is collected automatically.

Example:

"2023-12-01T05:00:00.401Z"

email_address
string | null
required

The email address of the customer this invoice is addressed to. Null if no email is on file.

Example:

"customer@example.com"

fetch_invoice_token
string
required

A signed token that allows fetching invoice data publicly without authentication.

Example:

"eyJhbGciOiJIUzI1NiJ9..."

id
string
required

The unique identifier for the invoice.

Example:

"inv_xxxxxxxxxxxxxx"

line_items
object[]
required

Optional line items that break down the invoice total into individual charges.

mailing_address
object | null
required

The billing/mailing address associated with this invoice, if one was provided at creation time.

number
string
required

The sequential invoice number for display purposes.

Example:

"#0001"

pay_online_url
string | null
required

The checkout URL where the customer can pay this invoice online, with their email address pre-filled and locked.

product
object
required

The product that this invoice was generated for.

status
enum<string>
required

The current payment status of the invoice, such as draft, open, paid, or void.

Available options:
draft,
open,
paid,
past_due,
uncollectible,
void
subscription_billing_anchor_at
string<date-time> | null
required

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.

Example:

"2023-12-01T05:00:00.401Z"

updated_at
string<date-time>
required

The datetime the invoice was last updated.

Example:

"2023-12-01T05:00:00.401Z"

user
object | null
required

The user this invoice is addressed to. Null if the user account has been removed.