Skip to main content
POST
Create Price

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId
string
required

The organization's id (UUID) or slug — either form is accepted.

projectId
string
required

The project's id (UUID) or slug — either form is accepted.

Query Parameters

environment
string

Environment slug. Defaults to "production"; unknown environment slugs return 404.

Pattern: ^[a-z][a-z0-9-]{0,38}$

Body

application/json
productId
string<uuid>
required
currency
string
required
Pattern: ^[A-Za-z]{3}$
unitAmount
integer
required
Required range: x >= 1
mode
enum<string>
required
Available options:
one_time,
subscription
interval
enum<string>
Available options:
day,
week,
month,
year
intervalCount
integer
Required range: 1 <= x <= 365
metadata
object

At most 20 application-defined string entries.

Response

Created price.

id
string<uuid>
required
productId
string<uuid>
required
currency
string
required
Pattern: ^[a-z]{3}$
unitAmount
integer
required
Required range: x >= 1
mode
enum<string>
required
Available options:
one_time,
subscription
interval
enum<string> | null
required
Available options:
day,
week,
month,
year,
null
intervalCount
integer | null
required
Required range: 1 <= x <= 365
active
boolean
required
metadata
object
required

At most 20 application-defined string entries.

createdAt
string<date-time>
required