Products

The product catalog — CRUD endpoints and required scopes.

A product is the thing you're selling — one product can have multiple prices under it (e.g. a monthly and an annual price for the same product).

GET/api/Product— List products in this workspace

Property	Value
Required scope	`products:read`
Idempotency-Key	Not required

Parameter	In	Type
`page`	query	integer (int32)
`pageSize`	query	integer (int32)
`orderBy`	query	string
`orderDirection`	query	string
`createdFrom`	query	string (date-time)
`createdTo`	query	string (date-time)

POST/api/Product— Create a new product

Property	Value
Required scope	`products:write`
Idempotency-Key	Not required

Parameter	In	Type
`active`	body	boolean
`description`	body	string
`metadata`	body	object
`name`	body	string

GET/api/Product/{productId}— Retrieve a single product

Property	Value
Required scope	`products:read`
Idempotency-Key	Not required

Parameter	In	Type	Required
`productId`	path	string	Required

PUT/api/Product/{productId}— Update a product (name, description, active state)

Property	Value
Required scope	`products:write`
Idempotency-Key	Not required

Parameter	In	Type	Required
`productId`	path	string	Required
`active`	body	boolean
`description`	body	string
`metadata`	body	object
`name`	body	string