Sign in
Addons

Create an addon

Creates a new addon in draft status, associated with a specific product.

post/api/v1/addons

Request body

idstring required

The unique identifier for the entity

displayNamestring required

The display name of the package

descriptionstring nullable

The description of the package

productIdstring required

The product id of the package

pricingType'FREE' | 'PAID' | 'CUSTOM' nullable

The pricing type of the package

billingIdstring nullable

The unique identifier for the entity in the billing provider

maxQuantityinteger nullable

The maximum quantity of this addon that can be added to a subscription

status'DRAFT' | 'PUBLISHED' | 'ARCHIVED'

The status of the package

metadataobject

Metadata associated with the entity

Response

The newly created addon object.

Changes