Skip to main content
GET
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id
string
required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Query Parameters

expand
string

Comma-separated relations to expand: customer, price_variant, order

Response

Invoice details

id
string
required
object
string
required
status
enum<string>
required
Available options:
open,
paid,
past_due,
void
number
string
required
description
string | null
required
customer_name
string | null
required
email_address
string | null
required
due_at
string<date-time>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
amount
number | null
required
currency
string | null
required
paid_at
string | null
required
price_variant
required

ID by default, full object when expanded

customer

ID by default, full object when expanded

order

ID by default, full object when expanded