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
| Parameter | Type | Required | Description |
|---|---|---|---|
organization_id | Number | Yes | ID of the organization |
name | String | Yes | Name of the product |
description | String | No | Description of the product |
status | String | No | Product status (active or inactive). Defaults to active. |
type | String | Yes | Product type (product or service) |
price | Number | No | Price of the product |
sku | String | No | Stock keeping unit identifier |
product_category_id | Number | No | ID of an existing product category in the same organization |
parent_id | Number | No | ID of the parent product (for variants) |
is_variant | Boolean | No | Whether this is a product variant (default: false) |
stock_quantity | Number | No | Stock quantity (for physical products) |
billing_type | String | No | Billing type (one_time or recurring) |
billing_interval | String | No | Billing interval for recurring services |
billing_interval_count | Number | No | Interval count for recurring billing |
Notes
organization_idmust belong to the same organization as the API key.- Only send
product_category_idif that category already exists in your organization.
Report an issue with this documentation
Please log in to report issues with our documentation.