Create a product
Creates a product, optionally bundling one or more prices supplied in the request body. Only the product name is required; status, portal, and price IDs are assigned by the server.
Authorizations
Body
Product to create
Name is the product's display name.
"Premium Plan"
Description is an optional product description.
"Access to all premium features"
ImageUrls are URLs of product images.
Status is the product lifecycle state.
active, archived "active"
Response
OK
Description is an optional free-text description of the product.
"Access to all premium features"
ImageUrls holds the URLs of images associated with the product.
IsUsed reports whether the product is referenced elsewhere and therefore cannot be deleted.
false
Name is the human-readable product name. Required on create and must be unique within the portal.
"Premium Plan"
PortalID is the ID of the portal that owns the product. Assigned by the server.
"550e8400-e29b-41d4-a716-446655440000"
Price is only populated when the product has exactly one price.
PriceIDs holds the IDs of the prices belonging to this product.
Prices holds the full price objects associated with the product.
Status indicates whether the product is active or archived. Assigned by the server on create.
active, archived "active"
TaxPercentage is the tax rate applied to the product, expressed as a percentage.
8.5