v69

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

Addons

Update a addon

Updates an existing addon's properties such as display name, description, and metadata.

patch/api/v1/addons/{id}

Path parameters

idstring required

The unique identifier of the entity

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

displayNamestring

The display name of the package

descriptionstring nullable

The description of the package

billingIdstring nullable

The unique identifier for the entity in the billing provider

metadataobject

Metadata associated with the entity

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

The status of the package

maxQuantityinteger nullable

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

dependenciesstring[] nullable

List of addons the addon is dependant on

Response

The updated addon object.