Sign in

v1

latestOpenAPI 3.0.32026-07-24614422630.2 KB
Product Catalog

Create a product

Creates a product for your tenant. The success response contains the ID of the product.

post/products

Request body

idstring

System-generated unique identifier for the product

entityIdsstring[]

Set of entity IDs associated with this product

namestring required

Unique name of the product

displayNamestring

Name of the product as shown to customers

descriptionstring

Detailed description of the product

skustring required

Stock Keeping Unit (SKU) for the product

productCategoryIdstring

ID of the category this product belongs to

externalIdstring

External identifier for the product, used for integration with other systems

Response

successful operation

idstring

System-generated unique identifier for the product

entityIdsstring[]

Set of entity IDs associated with this product

namestring required

Unique name of the product

displayNamestring

Display name of the product shown to customers

inUseboolean

Indicates if the product is currently in use by any plans

descriptionstring

Detailed description of the product

skustring required

Stock Keeping Unit (SKU) for the product

productCategoryIdstring

ID of the category this product belongs to

updatedOninteger

Timestamp of when the product was last updated (in seconds since epoch)

externalIdstring

External identifier for the product, used for integration with other systems

eventObjectIdstring