Skip to main content
PATCH
/
api
/
v1
/
addons
/
{id}
JavaScript
import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const addon = await client.v1.addons.update('x');

console.log(addon.data);
{
  "data": {
    "id": "addon-extra-seats",
    "displayName": "Extra Seats",
    "description": "Additional team member seats",
    "productId": "product-starter",
    "status": "PUBLISHED",
    "pricingType": "PAID",
    "billingId": "price_1234567890",
    "versionNumber": 1,
    "isLatest": true,
    "entitlements": [
      {
        "type": "FEATURE",
        "id": "feature-advanced-analytics"
      },
      {
        "type": "CREDIT",
        "id": "api-calls"
      }
    ],
    "metadata": {},
    "createdAt": "2025-10-26T10:00:00.000Z",
    "updatedAt": "2025-10-26T10:00:00.000Z",
    "maxQuantity": 100,
    "dependencies": [
      "addon-premium-support"
    ]
  }
}

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

​
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