Skip to main content
PATCH
JavaScript

Authorizations

X-API-KEY
string
header
required

Server API Key

Headers

X-ACCOUNT-ID
string

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-ID
string

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).

Path Parameters

id
string
required

The unique identifier of the entity

Required string length: 1 - 255

Body

application/json

Partially update an existing addon. Only provided fields are updated.

displayName
string

The display name of the package

Maximum string length: 255
description
string | null

The description of the package

Maximum string length: 255
billingId
string | null

The unique identifier for the entity in the billing provider

Maximum string length: 255
metadata
object

Metadata associated with the entity

status
enum<string>

The status of the package

Available options:
DRAFT,
PUBLISHED,
ARCHIVED
maxQuantity
integer | null

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

Required range: x > 0
dependencies
string[] | null

List of addons the addon is dependant on

The unique identifier for the entity

Maximum string length: 255
charges
SetPackagePricingRequest · object

Pricing configuration to set on the addon draft

Response

The updated addon object.

Response object

data
Addon · object
required

Addon configuration object