Sign in

v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB
Addons

Create an addon

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

post/api/v1/addons

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

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.