POST
/
v1
/
products

Headers

x-api-key
string
required

Body

application/json
name
string
required

Name of the product

description
string

Description of the product

image_url
string

URL of the product image

price
integer
required

The price of the product in cents

currency
string
required

Three-letter ISO currency code, in uppercase. Must be a supported currency.

billing_type
string
required

Indicates the billing method for the customer. It can either be a recurring billing cycle or a one-time payment.

billing_period
string

Billing period, required if billing_type is recurring

features
object[]

A list of features fpr the product.

tax_mode
string

Specifies the tax calculation mode for the transaction. If set to "inclusive," the tax is included in the price. If set to "exclusive," the tax is added on top of the price.

tax_category
string

Categorizes the type of product or service for tax purposes. This helps determine the applicable tax rules based on the nature of the item or service.

default_success_url
string

The URL to which the user will be redirected after successfull payment.

custom_field
object[]

Collect additional information from your customer using custom fields during checkout. Up to 3 fields are supported.

Response

200 - application/json
id
string
required

Unique identifier for the object.

mode
enum<string>
required

String representing the environment.

Available options:
test,
live,
sandbox
object
string
required

String representing the object’s type. Objects of the same type share the same value.

name
string
required

The name of the product

description
string
required

A brief description of the product

image_url
string

URL of the product image. Only png as jpg are supported

features
object[]

Features of the product.

price
number
required

The price of the product in cents. 1000 = $10.00

currency
string
required

Three-letter ISO currency code, in uppercase. Must be a supported currency.

billing_type
string
required

Indicates the billing method for the customer. It can either be a recurring billing cycle or a one-time payment.

billing_period
string
required

Billing period

status
string
required

Status of the product

tax_mode
string
required

Specifies the tax calculation mode for the transaction. If set to "inclusive," the tax is included in the price. If set to "exclusive," the tax is added on top of the price.

tax_category
string
required

Categorizes the type of product or service for tax purposes. This helps determine the applicable tax rules based on the nature of the item or service.

product_url
string
required

The product page you can redirect your customers to for express checkout.

default_success_url
string

The URL to which the user will be redirected after successfull payment.

created_at
string
required

Creation date of the product

updated_at
string
required

Last updated date of the product

Create Checkout SessionGet Product