Skip to main content
POST
Create a product

Authorizations

Authorization
string
header
required

OAuth 2.1 access token.

Body

application/json
name
string
required

Product name.

Required string length: 1 - 80
Example:

"Enterprise Plan"

currency
enum<string>
required

ISO 4217 currency code supported by Vendaze.

Available options:
AED,
ARS,
AUD,
BRL,
CAD,
CHF,
CLP,
CNY,
COP,
DKK,
EGP,
EUR,
GBP,
HKD,
ILS,
INR,
JPY,
KWD,
MAD,
MXN,
MYR,
NGN,
NOK,
NZD,
PEN,
QAR,
SAR,
SEK,
SGD,
TRY,
USD,
UYU,
ZAR
Example:

"USD"

price_cts
integer

Price in the smallest currency unit. Defaults to 0.

Required range: 0 <= x <= 1000000000000000
Example:

99900

description
string

Product description.

Maximum string length: 1000
Example:

"Full-featured plan for large teams."

code
string

Internal product code or SKU.

Maximum string length: 60
Example:

"PLAN-ENT"

is_active
boolean

Whether the product is active. Defaults to true.

Example:

true

billing_cycle
enum<string>

Billing cycle. Defaults to one_time.

Available options:
one_time,
monthly,
quarterly,
annually
Example:

"monthly"

image
string

Product image. Accepts a public HTTPS URL, a raw Base64 string, or a full data URI (data:image/png;base64,...). Maximum 2 MB.

Example:

"https://example.com/product.png"

Response

Product created successfully.

data
object