Skip to main content
POST
Create a product

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json
name
string
required
price
number
default:0
required

Monetary amount in WHOLE currency units (the displayed amount, e.g. 1000.00 = one thousand) — NOT minor units/cents. Do NOT divide or multiply by 100; send and show the amount as-is.

billing_type
enum<string>
default:one_time
required
Available options:
one_time,
recurring
status
enum<string>
default:draft
required
Available options:
live,
draft,
archived
sku
string | null
description
string | null
currency_uuid
string
billing_period
enum<string> | null
Available options:
monthly,
quarterly,
yearly

Response

201 - application/json

Default Response

uuid
string
required
name
string
required
sku
string | null
required
description
string | null
required
price
number
required

Monetary amount in WHOLE currency units (the displayed amount, e.g. 1000.00 = one thousand) — NOT minor units/cents. Do NOT divide or multiply by 100; send and show the amount as-is.

billing_type
enum<string>
required
Available options:
one_time,
recurring
billing_period
enum<string> | null
required
Available options:
monthly,
quarterly,
yearly
status
enum<string>
required
Available options:
live,
draft,
archived
currency
object
required
created_at
string
required
updated_at
string
required