Skip to main content
GET
Retrieve invoice
This page documents the Legacy API. For new integrations, use Retrieve Invoice in the Current API.
Required permissions:
  • invoice:basic:read
  • member:email:read
  • member:basic:read
  • payment:basic:read

인증

Authorization
string
header
필수

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

invoice:basic:read
member:email:read
member:basic:read
payment:basic:read

경로 매개변수

id
string
필수

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

예시:

"inv_xxxxxxxxxxxxxx"

응답

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
필수

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"

charge_buyer_fee
boolean
필수

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

collection_method
enum<string>
필수

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

사용 가능한 옵션:
send_invoice,
charge_automatically
company
object
필수

The company that issued this invoice.

created_at
string<date-time>
필수

The datetime the invoice was created.

예시:

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

current_plan
object
필수

The plan that this invoice charges for.

customer_name
string | null
필수

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

예시:

"Jane Doe"

due_date
string<date-time> | null
필수

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

예시:

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

email_address
string | null
필수

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

예시:

"customer@example.com"

fetch_invoice_token
string
필수

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

예시:

"eyJhbGciOiJIUzI1NiJ9..."

id
string
필수

The unique identifier for the invoice.

예시:

"inv_xxxxxxxxxxxxxx"

line_items
object[]
필수

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

mailing_address
object | null
필수

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

member
object | null
필수

The member that the invoice was created for. Null when the invoice is addressed to an email address with no member record behind it.

number
string
필수

The sequential invoice number for display purposes.

예시:

"#0001"

pay_online_url
string | null
필수

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

payment
object | null
필수

The payment that settled this invoice. Null while the invoice is unpaid, when the invoice was marked paid manually, and on a subscription renewal invoice, where the settling payment cannot yet be identified.

payment_processing
boolean
필수

Whether a payment on this invoice is still clearing. True while a delayed payment method such as ACH or SEPA settles, during which the invoice stays open and is not marked past due.

product
object
필수

The product that this invoice was generated for.

status
enum<string>
필수

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

사용 가능한 옵션:
draft,
open,
paid,
past_due,
uncollectible,
void
subscription_billing_anchor_at
string<date-time> | null
필수

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"

updated_at
string<date-time>
필수

The datetime the invoice was last updated.

예시:

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

user
object | null
필수

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