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<uuid>
required

Product ID.

Response

The product.

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

id
string<uuid>
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.

name
string
type
enum<string>

item (default) or agent.

Available options:
agent,
item
description
string | null
pricingModel
enum<string>

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

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

3-letter ISO 4217 code, such as BRL.

Example:

"BRL"

status
string

active or archived.

Example:

"active"

imageUrl
string | null

Public address of the product photo.

requiresShipping
boolean

Whether the purchase requires physical delivery; when true, the checkout asks for an address.

createdAt
string<date-time>
updatedAt
string<date-time>