POST
/
v1
/
products

Authorizations

Authorization
string
headerrequired

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

Body

application/json
name
string
required

Product name.

description
string

Product description.

public_description
string

Public description of the product.

translations
object | null

Product name and description translations.

is_available_on_demand
boolean
default: true
is_available_on_subscription
boolean
default: true
custom_properties
object

A list of key value with the ID or the name of the custom property as the key and the custom property value as value.

accounting
object

Mapping invoicing entity ID/accounting settings.

type
enum<string>
required
Available options:
flat_fee
price_configurations
object[]
required

Response

201 - application/json
id
string
required

Product ID.

type
enum<string>
required
Available options:
flat_fee
name
string
required

Product name.

description
string | null
required

Product description.

public_description
string | null
required

Public description of the product.

translations
object | null
required

Product name and description translations.

properties
object | null
required

Key/value pairs to store any information you find useful.

custom_properties
object
required

A list of key value with the ID or the name of the custom property as the key and the custom property value as value.

accounting
object
required

Mapping invoicing entity ID/accounting settings.

is_available_on_demand
boolean
required

Enable the product to be billed at any time as a one-time payment.

is_available_on_subscription
boolean
required

Enable the product to be added as part of a subscription.

price_configurations
object[]
required