Skip to main content
POST
Create a product

Authorizations

Authorization
string
header
required

Your secret key: sk_test_… for test mode, sk_live_… for live. Server-side only.

Body

application/json
name
string
required
Required string length: 1 - 200
rate_usd_per_second
string
required

USD per second as a decimal string. Never a float.

Pattern: ^\d+(\.\d+)?$
Example:

"0.004"

description
string
Maximum string length: 1000
allow_pause
boolean
start_mode
enum<string>

Default checkout. Use merchant when billing should begin once your resource is ready.

Available options:
checkout,
merchant

Response

The created product.

id
string
required
Example:

"prod_9Xk2mQ1pL0vRsT"

object
enum<string>
required
Available options:
product
name
string
required
description
string | null
required
rate_usd_per_second
string
required

USD per second as a decimal string. Never a float.

Pattern: ^\d+(\.\d+)?$
Example:

"0.004"

rate_per_second_wei
string
required

Rate in token base units (6 decimals for AUSD).

Example:

"4000"

currency
enum<string>
required
Available options:
ausd
allow_pause
boolean
required
start_mode
enum<string>
required

checkout starts the meter when the subscriber authorises; merchant waits until you call subscriptions.start.

Available options:
checkout,
merchant
active
boolean
required
active_subscriptions
integer
required

Running or paused meters on this product.

livemode
boolean
required
created
integer
required

Unix seconds.