Update a plan

Updates an existing plan’s properties such as display name, description, and metadata.

PATCH /api/v1/plans/{id}

JavaScript

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 plan = await client.v1.plans.update('x');

console.log(plan.data);

200

{
  "data": {
    "id": "plan-professional",
    "displayName": "Professional",
    "description": "Professional plan with advanced features",
    "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",
    "parentPlanId": null,
    "defaultTrialConfig": {
      "duration": 14,
      "units": "DAY",
      "budget": null,
      "trialEndBehavior": null
    },
    "compatibleAddonIds": []
  }
}

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

Show child attributes

parentPlanId · string | null

The ID of the parent plan, if applicable

Maximum string length: 255

defaultTrialConfig · DefaultTrialConfig · object

Default trial configuration for the plan

Show child attributes

compatibleAddonIds · string[] | null

List of compatible addon IDs for this plan

Maximum string length: 255

charges · SetPackagePricingRequest · object

Pricing configuration to set on the plan draft

Show child attributes

Response

200

application/json

The updated plan object.

Response object

data · Plan · object · required

Plan configuration object

Show child attributes