Update a plan

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

import os
from stigg import Stigg

client = Stigg(
    api_key=os.environ.get("STIGG_API_KEY"),  # This is the default and can be omitted
)
plan = client.v1.plans.update(
    id="x",
)
print(plan.data)

package main

import (
	"context"
	"fmt"

	"github.com/stiggio/stigg-go"
	"github.com/stiggio/stigg-go/option"
)

func main() {
	client := stigg.NewClient(
		option.WithAPIKey("My API Key"),
	)
	plan, err := client.V1.Plans.Update(
		context.TODO(),
		"x",
		stigg.V1PlanUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", plan.Data)
}

package io.stigg.example;

import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.plans.Plan;
import io.stigg.models.v1.plans.PlanUpdateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        StiggClient client = StiggOkHttpClient.fromEnv();

        Plan plan = client.v1().plans().update("x");
    }
}

using System;
using Stigg.Client;
using Stigg.Client.Models.V1.Plans;

StiggClient client = new();

PlanUpdateParams parameters = new() { ID = "x" };

var plan = await client.V1.Plans.Update(parameters);

Console.WriteLine(plan);

curl --request PATCH \
  --url https://api.stigg.io/api/v1/plans/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "displayName": "<string>",
  "description": "<string>",
  "billingId": "<string>",
  "metadata": {},
  "parentPlanId": "<string>",
  "defaultTrialConfig": {
    "duration": 123,
    "budget": {
      "limit": 123,
      "hasSoftLimit": true
    }
  },
  "compatibleAddonIds": [
    "<string>"
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.stigg.io/api/v1/plans/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => '<string>',
    'description' => '<string>',
    'billingId' => '<string>',
    'metadata' => [
        
    ],
    'parentPlanId' => '<string>',
    'defaultTrialConfig' => [
        'duration' => 123,
        'budget' => [
                'limit' => 123,
                'hasSoftLimit' => true
        ]
    ],
    'compatibleAddonIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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": []
  }
}

{
  "message": "<string>",
  "code": "BadUserInput",
  "reason": "<string>"
}

{
  "message": "<string>",
  "code": "Unauthenticated"
}

{
  "message": "<string>",
  "code": "IdentityForbidden"
}

{
  "message": "<string>",
  "code": "CustomerNotFound"
}

{
  "message": "<string>",
  "code": "RateLimitExceeded"
}

PATCH

api

plans

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

console.log(plan.data);

import os
from stigg import Stigg

client = Stigg(
    api_key=os.environ.get("STIGG_API_KEY"),  # This is the default and can be omitted
)
plan = client.v1.plans.update(
    id="x",
)
print(plan.data)

package main

import (
	"context"
	"fmt"

	"github.com/stiggio/stigg-go"
	"github.com/stiggio/stigg-go/option"
)

func main() {
	client := stigg.NewClient(
		option.WithAPIKey("My API Key"),
	)
	plan, err := client.V1.Plans.Update(
		context.TODO(),
		"x",
		stigg.V1PlanUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", plan.Data)
}

package io.stigg.example;

import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.plans.Plan;
import io.stigg.models.v1.plans.PlanUpdateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        StiggClient client = StiggOkHttpClient.fromEnv();

        Plan plan = client.v1().plans().update("x");
    }
}

using System;
using Stigg.Client;
using Stigg.Client.Models.V1.Plans;

StiggClient client = new();

PlanUpdateParams parameters = new() { ID = "x" };

var plan = await client.V1.Plans.Update(parameters);

Console.WriteLine(plan);

curl --request PATCH \
  --url https://api.stigg.io/api/v1/plans/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "displayName": "<string>",
  "description": "<string>",
  "billingId": "<string>",
  "metadata": {},
  "parentPlanId": "<string>",
  "defaultTrialConfig": {
    "duration": 123,
    "budget": {
      "limit": 123,
      "hasSoftLimit": true
    }
  },
  "compatibleAddonIds": [
    "<string>"
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.stigg.io/api/v1/plans/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'displayName' => '<string>',
    'description' => '<string>',
    'billingId' => '<string>',
    'metadata' => [
        
    ],
    'parentPlanId' => '<string>',
    'defaultTrialConfig' => [
        'duration' => 123,
        'budget' => [
                'limit' => 123,
                'hasSoftLimit' => true
        ]
    ],
    'compatibleAddonIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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": []
  }
}

{
  "message": "<string>",
  "code": "BadUserInput",
  "reason": "<string>"
}

{
  "message": "<string>",
  "code": "Unauthenticated"
}

{
  "message": "<string>",
  "code": "IdentityForbidden"
}

{
  "message": "<string>",
  "code": "CustomerNotFound"
}

{
  "message": "<string>",
  "code": "RateLimitExceeded"
}

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

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; omitted fields keep their current value.

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 this plan should inherit entitlements from another plan. Optional — omit to create a standalone plan with no inherited entitlements.

Maximum string length: 255

defaultTrialConfig

DefaultTrialConfig · object | null

Default trial configuration for the plan. When set, subscriptions provisioned on this plan without explicit trial settings automatically start in trial for the configured duration; leave unset for no automatic trial.

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. Unlike the rest of this request, this is a full replace of the pricing configuration, not a merge — see SetPackagePricingRequest.

Show child attributes

Response

The updated plan object.

Response object

data

Plan · object

required

Plan configuration object

Show child attributes

Get started

Essentials

Subscriptions

Bulk Import

Usage

Coupons

Products

Features

Addons

Plans

Promotional Entitlements

Customers

Customer Integrations

Data Export

Entitlements

Plan Entitlements

Addon Entitlements

Credit grants

Credit consumption

Credit usage

Auto recharge

Custom currencies

Credit ledger

Contracts

Invoices

Governance Entity Types

Governance Entities

Governance Assignments

Governance Hierarchy

Governance Entitlements Check

Update a plan

Authorizations

Headers

Path Parameters

Body

Response