Skip to main content
GET
Retrieve a product

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your API key as Authorization: Bearer sk_.... See Authentication for keys, scopes, and sandbox vs production.

Path Parameters

product_id
string
required

Response

Success

id
string

Unique identifier for the product, prefixed with prod_.

Example:

"prod_1a2b3c4d5e6f"

organization_id
string

The account that owns the product.

Example:

"acct_7KpQ2mNv4XbR9dLc"

name
string

Display name of the product.

Example:

"Pro Plan"

description
string | null

Optional description of the product. null when not set.

Example:

"Monthly access to all Pro features."

price
object

Primary price for the product, in the product's default currency.

Example:
status
enum<string>

Status of the product. active: Live and available for use in checkouts and subscriptions. archived: Retired. Kept for reference but not available for new purchases.

Available options:
active,
archived
Example:

"active"

metadata
object | null

Your own key-value data attached to the product, returned unchanged.

Example:
media
object[]

Media items (images) attached to the product. Empty when none are set.

actor_id
string

Identifier of the user or key that created the product.

Example:

"usr_abc123"

created_at
string<date-time>

ISO 8601 timestamp when the product was created.

Example:

"2026-07-13T14:00:00.000Z"

updated_at
string<date-time>

ISO 8601 timestamp when the product was last updated.

Example:

"2026-07-13T14:00:00.000Z"

archived_at
string<date-time> | null

When set, the product is archived and cannot be used in new checkouts. null while the product is active.

Example:

null

billing_cycle
object | null

How often the product bills. Provide a cadence to make the product recurring, or omit it for a one-time product.

trial_period
object | null

A free trial before the first charge, given as a duration like { "interval": "day", "frequency": 14 } for 14 days. The customer isn't charged until the trial ends. Only valid on a recurring product. Currently in beta.

prices
object[]

All prices configured on the product, one per currency. Each has currency, amount, optional minimum_amount and maximum_amount, and is_default.

total_payments
integer

Running count of completed payments for this product. Starts at 0 and increments as customers pay.

Example:

0

total_amount
string

Running total collected for this product, as a decimal string in the product currency. Starts at "0.00".

Example:

"0.00"