Skip to main content
GET
Get a product

Authorizations

Authorization
string
header
required

Your account's secret key: Authorization: Bearer sk_test_… or sk_live_…. Server-side only.

Path Parameters

productID
string
required

Product ID.

Pattern: ^prod_[0-9A-Za-z]{22}$
Example:

"prod_1d4YogBuw00jAySh5mbUpk"

Response

The product.

A catalog entry. Pricing lives on the product's versions.

id
string
required
Pattern: ^prod_[0-9A-Za-z]{22}$
Example:

"prod_1d4YogBuw00jAySh5mbUpk"

name
string
required
type
enum<string>
required

item (default) or agent.

Available options:
agent,
item
pricingModel
enum<string>
required

How the product is charged: subscription, one_time, usage or prepaid.

Available options:
subscription,
one_time,
usage,
prepaid
currency
string
required

3-letter ISO 4217 code, such as BRL.

Example:

"BRL"

status
string
required

active or archived.

Example:

"active"

guaranteeDays
integer
required
Required range: 7 <= x <= 30
accentColor
string | null
required
Pattern: ^#[0-9A-Fa-f]{6}$
media
object[]
required
faq
object[]
required
purchaseButtonText
string | null
required
postPurchaseRedirectUrl
string | null
required
draftSavedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
key
string | null

A stable key you choose for the product, unique in your account. Lets you create the same product again without duplicating it.

description
string | null
imageUrl
string | null

Public address of the product photo.