The product object
string
Unique identifier. Prefixed with
prod_.string
Always
"product".string
Display name of the product.
string
Optional description.
array
Array of image URLs.
string
Billing type. One of
one_time, subscription, or metered.string
active or archived.string
The asset this product is priced in.
string
The currency code this product is priced in, e.g “NGN”
number
Price in the product’s asset.
string
For
subscription products. One of day, week, month, or year.string
For
metered products. The unit being measured (e.g. "token", "request").number
Units consumed per credit.
number
Total credits granted to the customer when this product is purchased.
object
Arbitrary key-value data.
string
testnet or mainnet.string
ISO 8601 timestamp.
string
ISO 8601 timestamp.
Create a product
POST /product
Body
string
required
Product name.
string
required
one_time, subscription, or metered.string
required
Currency code to charge in, e.g “NGN”.
number
required
Price amount in the asset.
string
Required for
subscription type. One of day, week, month, year.string
Product description.
array
Array of image URLs.
string
For
metered products. The unit label.number
Units consumed per credit.
number
Total credits granted on purchase.
object
Arbitrary key-value data.
Update a product
PUT /product/{id}
Body
string
New name.
string
New description.
number
New price amount.
string
New billing interval.
array
New image URLs.
object
Merged with existing metadata.
Delete a product
DELETE /product/{id}