Skip to main content
POST
Create a product

Authorizations

X-API-KEY
string
header
required

Body

application/json

Product to create

name
string
required

Name is the product's display name.

Example:

"Premium Plan"

description
string

Description is an optional product description.

Example:

"Access to all premium features"

imageUrls
string[]

ImageUrls are URLs of product images.

Example:
status
enum<string>

Status is the product lifecycle state.

Available options:
active,
archived
Example:

"active"

Response

OK

createdAt
string
creatorId
string
data
string
description
string

Description is an optional free-text description of the product.

Example:

"Access to all premium features"

id
string
identityId
string
imageUrls
string[] | null

ImageUrls holds the URLs of images associated with the product.

Example:
isUsed
boolean

IsUsed reports whether the product is referenced elsewhere and therefore cannot be deleted.

Example:

false

name
string

Name is the human-readable product name. Required on create and must be unique within the portal.

Example:

"Premium Plan"

object
string
portalId
string<uuid>

PortalID is the ID of the portal that owns the product. Assigned by the server.

Example:

"550e8400-e29b-41d4-a716-446655440000"

previousAttributes
object
price
object

Price is only populated when the product has exactly one price.

priceIds
string[]

PriceIDs holds the IDs of the prices belonging to this product.

Example:
prices
object[]

Prices holds the full price objects associated with the product.

ref
string
status
enum<string>

Status indicates whether the product is active or archived. Assigned by the server on create.

Available options:
active,
archived
Example:

"active"

taxPercentage
number

TaxPercentage is the tax rate applied to the product, expressed as a percentage.

Example:

8.5

updatedAt
string