Skip to main content
POST
Create a product

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

A unique key per operation (a UUID works). Retrying with the same key returns the original response.

Body

application/json
name
string
required
pricingModel
enum<string>
required

subscription, one_time, usage or prepaid.

Available options:
subscription,
one_time,
usage,
prepaid
key
string | null

Stable product key, unique in your account. Creating twice with the same key returns the same product; pricing different from the current version is refused with 422 pricing_immutable.

type
enum<string>

item (default) or agent.

Available options:
agent,
item
description
string | null
currency
string

3-letter ISO 4217 code. Default: BRL.

Example:

"BRL"

billingCycle
enum<string> | null

weekly, monthly or annual. Required for subscription and prepaid; omit it for other models.

Available options:
weekly,
monthly,
annual,
null
basePrice
string | null

Version 1's base price, as a decimal string ("49.90").

Response

Product created (or the existing product with the same key).

product
object

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

version
object

A product version: a snapshot of its pricing. A published version never changes; to change the price, create another.