Create a Product

Create a new product in your organization.

Endpoint

POST
/products

Authentication

This endpoint works with an API key sent in the x-api-key header.

Request

Response

json

Request Parameters

ParameterTypeRequiredDescription
organization_idNumberYesID of the organization
nameStringYesName of the product
descriptionStringNoDescription of the product
statusStringNoProduct status (active or inactive). Defaults to active.
typeStringYesProduct type (product or service)
priceNumberNoPrice of the product
skuStringNoStock keeping unit identifier
product_category_idNumberNoID of an existing product category in the same organization
parent_idNumberNoID of the parent product (for variants)
is_variantBooleanNoWhether this is a product variant (default: false)
stock_quantityNumberNoStock quantity (for physical products)
billing_typeStringNoBilling type (one_time or recurring)
billing_intervalStringNoBilling interval for recurring services
billing_interval_countNumberNoInterval count for recurring billing

Notes

  • organization_id must belong to the same organization as the API key.
  • Only send product_category_id if that category already exists in your organization.

Report an issue with this documentation

Please log in to report issues with our documentation.