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 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");
}
}
require "stigg"
stigg = Stigg::Client.new(api_key: "My API Key")
plan = stigg.v1.plans.update("x")
puts(plan)
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);
stigg v1:plans update \
--api-key 'My API Key' \
--id x
Updates an existing plan’s properties such as display name, description, and metadata.
PATCH
/
api
/
v1
/
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 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");
}
}
require "stigg"
stigg = Stigg::Client.new(api_key: "My API Key")
plan = stigg.v1.plans.update("x")
puts(plan)
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);
stigg v1:plans update \
--api-key 'My API Key' \
--id x
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).
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.
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.
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.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Stigg","description":"Stigg is a subscription and entitlement management platform for SaaS companies. Model pricing with plans, add-ons, credits, and usage-based billing; provision customers and subscriptions; enforce feature access; render pricing tables, paywalls, and customer portals; and integrate with Stripe, Zuora, HubSpot, Salesforce, and AWS Marketplace. Available as backend SDKs (Node.js, Python, Ruby, Go, Java, .NET), frontend SDKs (React, Vue, Next.js), GraphQL API, and REST API.","colors":{"primary":"#436633","light":"#92E759","dark":"#92E759"},"logo":{"light":"https://mintcdn.com/stigg/HmCBL4eVQuHwqjnY/logo/light.svg?fit=max\u0026auto=format\u0026n=HmCBL4eVQuHwqjnY\u0026q=85\u0026s=8579b37d1f3d11f4198506c9e602caa3","dark":"https://mintcdn.com/stigg/VJsr65Ru_PpGBlIr/logo/dark.svg?fit=max\u0026auto=format\u0026n=VJsr65Ru_PpGBlIr\u0026q=85\u0026s=1015fd0f2902e88f82cfc983376de8a1"},"favicon":"https://mintcdn.com/stigg/RB-JAyGY2_V2sWZw/favicon.png?fit=max\u0026auto=format\u0026n=RB-JAyGY2_V2sWZw\u0026q=85\u0026s=1c445af29076b2cb99bb12013aa66883","api":{"playground":{"proxy":false}},"appearance":{"default":"dark","strict":false},"background":{"color":{"light":"#FFFFFF","dark":"#131512"}},"navbar":{"links":[{"href":"https://status.stigg.io/","label":"Status"}],"primary":{"type":"button","label":"Go to Stigg","href":"https://app.stigg.io/"}},"footer":{"socials":{"website":"https://www.stigg.io/","twitter":"https://twitter.com/GetStigg","linkedin":"https://www.linkedin.com/company/getstigg"}},"seo":{"indexing":"navigable"},"icons":{"library":"fontawesome"},"integrations":{"ga4":{"measurementId":"G-W4NT0H7LD8"},"gtm":{"tagId":"GTM-W7B4F9H8"},"segment":{"key":"EAinkIzT3atuAztLrDyktKzfMsEk42bI"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"stigg","hasAudioNarration":false,"actualSubdomain":"stigg","customDomains":["docs.stigg.io"],"gitSource":{"type":"github","owner":"stiggio","repo":"docs","deployBranch":"master","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae30614d1bab25bf1dc1368","collectionId":"b4faf005-d68b-4e62-9ec3-b52f139d4007","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae30614d1bab25bf1dc1368"},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae32e70af12d5279fa7df11","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Documentation","count":280},{"language":"default","tag":"API Reference","count":244},{"language":"default","tag":"REST","count":166},{"language":"default","tag":"Pricing and packaging","count":99},{"language":"default","tag":"Integrations","count":65},{"language":"default","tag":"Webhooks","count":54},{"language":"default","tag":"Subscriptions","count":41},{"language":"default","tag":"Plans","count":41},{"language":"default","tag":"Customers, subscriptions and contracts","count":38},{"language":"default","tag":"GraphQL","count":36}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"content/custom.css","content":"@keyframes welcome-dash{to{background-position:0 10px}}@keyframes welcome-dash-h{to{background-position:10px 0}}@font-face{font-family:\"Söhne\";src:url(/fonts/soehne-buch.woff2) format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:\"Söhne\";src:url(/fonts/soehne-leicht.woff2) format(\"woff2\");font-weight:300;font-style:normal;font-display:swap}@font-face{font-family:\"Söhne Mono\";src:url(/fonts/soehne-mono-buch.woff2) format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}:root{--font-inter:\"Söhne\", -apple-system, BlinkMacSystemFont, \"Segoe UI\",\n system-ui, sans-serif!important;--font-paper-mono:\"Söhne Mono\", ui-monospace, SFMono-Regular, Menlo,\n Monaco, Consolas, \"Liberation Mono\", \"Courier New\", monospace!important;--gray-50:255 255 255!important;--gray-100:255 255 255!important;--gray-200:234 234 234!important;--gray-300:213 213 213!important;--gray-400:181 181 181!important;--gray-500:149 149 149!important;--gray-600:128 128 128!important;--gray-700:104 104 104!important;--gray-800:81 81 81!important;--gray-900:57 57 57!important;--gray-950:19 19 19!important}#page-title{font-size:34px;font-weight:400;line-height:1.2}#page-title,.mdx-content,.prose{font-family:\"Söhne\",sans-serif}.mdx-content :where(p, [data-as=\"p\"]):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:16px;font-weight:400;margin-top:0;margin-bottom:24px}.mdx-content :where(h1):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:34px;font-weight:400;line-height:1.2;margin-top:48px;margin-bottom:24px}.mdx-content :where(h2):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:28px;font-weight:400;line-height:1.3;margin-top:48px;margin-bottom:24px}.mdx-content :where(h3):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:24px;font-weight:400;line-height:1.35;margin-top:32px;margin-bottom:16px}.mdx-content :where(h4):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:18px;font-weight:400;line-height:1.4;margin-top:32px;margin-bottom:16px}.mdx-content :where(h5):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:22px;font-weight:400;line-height:1.4;margin-top:24px;margin-bottom:12px}.mdx-content :where(h6):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:20px;font-weight:400;line-height:1.4;margin-top:24px;margin-bottom:12px}.mdx-content :where(ol):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)),.mdx-content :where(ul):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:16px;font-weight:400}.mdx-content :where(blockquote):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:16px;font-weight:400;line-height:1.5;padding:12px 16px;margin-top:16px;margin-bottom:16px}.mdx-content :where(blockquote cite):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, [class~=\"not-prose\"] *)){display:block;font-family:\"Söhne Mono\",monospace;font-size:14px;text-transform:uppercase;font-style:normal}.mdx-content :where(img):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){border-radius:8px;margin-top:80px;margin-bottom:80px;max-width:min(850px,100%)}.mdx-content :where(figcaption):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:14px;margin-top:20px}.eyebrow{font-family:\"Söhne Mono\",monospace;font-size:14px;font-weight:400;text-transform:uppercase;letter-spacing:.04em}@media (max-width:768px){#page-title{font-size:28px}.mdx-content :where(p, [data-as=\"p\"]):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:16px;margin-bottom:20px}.mdx-content :where(h1):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:28px;margin-bottom:20px}.mdx-content :where(h2):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:24px;margin-top:36px;margin-bottom:20px}.mdx-content :where(h3):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:20px;margin-top:24px;margin-bottom:12px}.mdx-content :where(h4):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:18px;margin-top:24px;margin-bottom:12px}.mdx-content :where(h5):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)),.mdx-content :where(h6):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:18px}.mdx-content :where(ol):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)),.mdx-content :where(ul):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:16px}.mdx-content :where(blockquote):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:16px;padding:12px 16px;margin-top:12px;margin-bottom:12px}.mdx-content :where(img):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){margin-top:60px;margin-bottom:60px;max-width:100%}.mdx-content :where(figcaption):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){margin-top:16px}.eyebrow{font-size:12px}}#topbar-cta-button a>span:first-child{background-color:#fff;border-radius:4px;opacity:1;transition:background-color .15s ease}#topbar-cta-button a:hover>span:first-child{background-color:#92e759;opacity:1}#topbar-cta-button a .z-10,#topbar-cta-button a .z-10 span,#topbar-cta-button a .z-10 svg{color:#131512!important}.navbar-link a:hover,.navbar-link a:hover span{color:#436633!important}.dark .navbar-link a:hover,.dark .navbar-link a:hover span{color:#92e759!important}.mdx-content,.prose{--tw-prose-links:#436633;--tw-prose-invert-links:#92e759}.mdx-content :where(a):not(:where([class~=\"not-prose\"] *)),.prose :where(a){text-decoration-color:#92e759}.mdx-content :where(a):not(:where([class~=\"not-prose\"] *)):hover,.prose :where(a):hover{color:#28382b}.dark .mdx-content :where(a):not(:where([class~=\"not-prose\"] *)):hover,.dark .prose :where(a):hover{color:#436633}:root{--welcome-accent:#436633;--welcome-accent-fg:#ffffff;--welcome-subtle:#f2f7f3;--welcome-subtle-border:#dfe8d6;--welcome-surface:#ffffff;--welcome-panel:#fafafa;--welcome-border:#e4e4e7;--welcome-text:#18181b;--welcome-text-2:#52525b;--welcome-text-3:#8a8a93}.dark{--welcome-accent:#92e759;--welcome-accent-fg:#131512;--welcome-subtle:rgba(146, 231, 89, 0.08);--welcome-subtle-border:rgba(146, 231, 89, 0.22);--welcome-surface:#131512;--welcome-panel:#1a1d19;--welcome-border:rgba(255, 255, 255, 0.1);--welcome-text:#f4f4f5;--welcome-text-2:#b5b5b5;--welcome-text-3:#8a8a8a}.welcome-featured{margin:32px 0 16px;padding:16px;border:1px solid var(--welcome-subtle-border);border-radius:12px;background:linear-gradient(180deg,var(--welcome-subtle),var(--welcome-surface))}.welcome-featured-head{display:flex;align-items:flex-start;gap:12px;color:var(--welcome-text);text-decoration:none}.welcome-featured-head:hover .welcome-arrow,.welcome-featured-head:hover .welcome-featured-title,.welcome-icon{color:var(--welcome-accent)}.welcome-icon{flex:none;width:34px;height:34px;border-radius:8px;background:var(--welcome-subtle);display:flex;align-items:center;justify-content:center}.welcome-arrow svg,.welcome-flow-arrow svg,.welcome-flow-outcome svg,.welcome-icon svg{background-color:currentColor!important}.welcome-featured-text{display:flex;flex-direction:column;gap:4px}.welcome-featured-title{font-size:16px;font-weight:500}.welcome-featured-desc{font-size:14px;line-height:1.6;color:var(--welcome-text-2)}.welcome-arrow{margin-left:auto;align-self:center;color:var(--welcome-text-3)}.welcome-featured [class*=code-block],.welcome-featured pre{margin-bottom:0!important}.welcome-flow,.welcome-step{border:1px solid var(--welcome-border)}.welcome-flow{margin:24px 0 8px;padding:20px;border-radius:12px;background:var(--welcome-panel)}.welcome-step{display:flex;flex-direction:column;align-items:center;gap:6px;padding:14px;border-radius:8px;background:var(--welcome-surface);color:var(--welcome-text);text-align:center}.welcome-step strong{font-size:14px;font-weight:500}.welcome-step-key{border:1.5px solid var(--welcome-accent);background:var(--welcome-subtle)}.welcome-label{font-size:11px;font-weight:600;letter-spacing:.04em;text-transform:uppercase;color:var(--welcome-text-3)}.welcome-muted{font-size:12px;color:var(--welcome-text-3)}.welcome-pills{display:flex;flex-wrap:wrap;justify-content:center;gap:6px;margin-top:4px}.welcome-pill{padding:3px 9px;border:1px solid var(--welcome-subtle-border);border-radius:9999px;background:var(--welcome-surface);color:var(--welcome-accent);font-size:11px;font-weight:600}.welcome-flow-steps{display:flex;align-items:stretch}.welcome-step{flex:1;min-width:0;justify-content:flex-start}.welcome-flow-arrow,.welcome-step-n{display:flex;align-items:center;justify-content:center}.welcome-step-n{width:22px;height:22px;border:1px solid var(--welcome-border);border-radius:9999px;background:var(--welcome-panel);color:var(--welcome-text-2);font-size:11px;font-weight:600}.welcome-step-key .welcome-step-n{border-color:var(--welcome-accent);background:var(--welcome-accent);color:var(--welcome-accent-fg)}.welcome-flow-arrow{flex:0 0 26px;color:var(--welcome-text-3)}.welcome-flow-outcomes{display:flex;flex-direction:column;align-items:center;gap:6px;margin-top:14px}.welcome-flow-outcome{display:flex;align-items:center;gap:8px;font-size:13px;color:var(--welcome-text-2)}.welcome-flow-pass svg,.welcome-runtime>.welcome-label{color:var(--welcome-accent)}.welcome-flow-fail svg{color:#dc2626}.welcome-flow-outcome strong{font-weight:600;color:var(--welcome-text)}@media (max-width:768px){.welcome-flow-steps{flex-direction:column}.welcome-flow-arrow{height:26px;transform:rotate(90deg)}}.welcome-runtime,.welcome-stack{display:flex;flex-direction:column}.welcome-stack{margin:24px 0 8px;padding:20px;align-items:center;border:1px solid var(--welcome-border);border-radius:12px;background:var(--welcome-panel)}.welcome-runtime{width:100%;padding:16px;gap:12px;border:1.5px solid var(--welcome-accent);border-radius:10px;background:var(--welcome-subtle)}.welcome-caps{display:grid;grid-template-columns:repeat(2,minmax(0,1fr));gap:10px}.welcome-cap,.welcome-deploy-opts span,.welcome-downstream{border:1px solid var(--welcome-border);background:var(--welcome-surface)}.welcome-cap,.welcome-downstream{display:flex;flex-direction:column;gap:8px;padding:14px;border-radius:8px;color:var(--welcome-text);text-decoration:none;transition:border-color .15s ease}.welcome-cap:hover,.welcome-downstream:hover{border-color:var(--welcome-accent)}.welcome-cap-head{display:flex;align-items:center;gap:10px}.welcome-cap-head .welcome-icon{width:28px;height:28px}.welcome-cap-head strong{font-size:15px;font-weight:500}.welcome-cap-desc{font-size:13px;line-height:1.55;color:var(--welcome-text-2)}.welcome-cap-link{margin-top:auto;display:inline-flex;align-items:center;gap:6px;font-size:12px;font-weight:600;color:var(--welcome-accent)}.welcome-cap-link svg,.welcome-stack-arrow svg{background-color:currentColor!important}.welcome-stack-arrow{height:32px;display:flex;align-items:center;color:var(--welcome-text-3)}.welcome-downstream{width:min(100%,360px)}.welcome-icon-neutral{background:var(--welcome-panel);color:var(--welcome-text-2)}.welcome-deploy-strip{width:100%;margin-top:16px;padding:10px 14px;display:flex;align-items:center;justify-content:center;gap:12px;border:1px dashed var(--welcome-border);border-radius:8px}.welcome-deploy-opts{display:flex;gap:8px}.welcome-deploy-opts span{padding:2px 10px;border-radius:9999px;color:var(--welcome-text-2);font-size:12px;font-weight:600}@media (max-width:768px){.welcome-caps{grid-template-columns:1fr}.welcome-deploy-strip{flex-direction:column;gap:8px}}.welcome-sys,.welcome-zone{border:1px solid var(--welcome-border)}.welcome-sys{margin:24px 0 8px;padding:28px 20px 20px;display:flex;flex-direction:column;border-radius:12px;background-color:var(--welcome-panel);background-image:radial-gradient(var(--welcome-border) 1px,transparent 1px);background-size:16px 16px}.welcome-zone{position:relative;border-radius:10px;background:var(--welcome-surface)}.welcome-zone-key{border:1.5px solid var(--welcome-accent)}.welcome-zone-tab{position:absolute;top:-11px;left:12px;padding:2px 8px;border:1px solid var(--welcome-border);border-radius:9999px;background:var(--welcome-surface);color:var(--welcome-text-2);font-size:11px;font-weight:600;white-space:nowrap}.welcome-zone-key .welcome-zone-tab{border-color:var(--welcome-accent);background:var(--welcome-accent);color:var(--welcome-accent-fg)}.welcome-zone-body{padding:20px 12px 12px;display:flex;flex-direction:column;gap:8px}.welcome-zone-key .welcome-zone-body{border-radius:9px;background:var(--welcome-subtle)}.welcome-zone-body>.welcome-label:not(:first-child){margin-top:4px}.welcome-row{display:grid;grid-template-columns:repeat(auto-fit,minmax(140px,1fr));gap:8px}.welcome-box{display:flex;align-items:center;gap:10px;padding:8px 10px;border:1px solid var(--welcome-border);border-radius:8px;background:var(--welcome-surface);color:var(--welcome-text)}.welcome-box>span:last-child:not(.welcome-icon){display:flex;flex-direction:column;min-width:0}.welcome-box strong{font-size:13px;font-weight:500;line-height:1.3}.welcome-box .welcome-muted{font-size:11px;line-height:1.3}.welcome-box .welcome-icon{width:26px;height:26px;border-radius:6px}.welcome-box .welcome-icon svg{width:13px;height:13px}.welcome-wires{display:flex;justify-content:center;gap:48px;padding:2px 0}.welcome-wire-row{display:flex;align-items:center;gap:10px}.welcome-wire-label{font-size:11px;line-height:1.3;color:var(--welcome-text-2)}.welcome-wire{position:relative;display:block;width:2px;height:40px;margin:8px 0;background-image:repeating-linear-gradient(180deg,var(--welcome-accent) 0 5px,transparent 5px 10px);background-size:2px 10px;animation:welcome-dash .9s linear infinite}.welcome-wire-both::before,.welcome-wire::after{content:\"\";position:absolute;left:-4px;border:5px solid transparent}.welcome-wire::after{bottom:-8px;border-top-color:var(--welcome-accent)}.welcome-wire-both::before,.welcome-wire-up::after{top:-8px;border-bottom-color:var(--welcome-accent)}.welcome-wire-up{animation-direction:reverse}.welcome-wire-up::after{bottom:auto;border-top-color:transparent}@media (prefers-reduced-motion:reduce){.welcome-wire{animation:none}}@media (max-width:768px){.welcome-row{grid-template-columns:1fr}.welcome-wires{gap:16px}.welcome-wire-label{max-width:110px}}.welcome-split{display:grid;grid-template-columns:minmax(0,1fr) 120px minmax(0,1fr);align-items:center}.welcome-split-wide{grid-template-columns:minmax(0,1.7fr) 120px minmax(0,1fr)}.welcome-link,.welcome-links{display:flex;flex-direction:column}.welcome-links{gap:18px;padding:0 4px}.welcome-link{gap:6px}.welcome-link .welcome-wire-label{font-size:10.5px;text-align:center}.welcome-wire-h{width:auto;height:2px;margin:0 8px;background-image:repeating-linear-gradient(90deg,var(--welcome-accent) 0 5px,transparent 5px 10px);background-size:10px 2px;animation-name:welcome-dash-h}.welcome-wire-h::after{top:-4px;bottom:auto;left:auto;right:-8px;border-color:transparent;border-left-color:var(--welcome-accent)}.welcome-wire-h.welcome-wire-rev{animation-direction:reverse}.welcome-wire-h.welcome-wire-rev::after{right:auto;left:-8px;border-left-color:transparent;border-right-color:var(--welcome-accent)}.welcome-wire-h.welcome-wire-both::before{top:-4px;left:-8px;border-color:transparent;border-right-color:var(--welcome-accent)}.welcome-group,.welcome-lock{display:flex;flex-direction:column}.welcome-lock{align-items:center;gap:6px;font-size:10.5px;line-height:1.3;text-align:center;color:var(--welcome-text-3)}.welcome-lock svg{width:14px;height:14px;background-color:currentColor!important}.welcome-group{gap:8px;padding:10px;border:1px dashed var(--welcome-border);border-radius:8px}.welcome-group-managed{border-color:var(--welcome-accent);background:var(--welcome-subtle)}.welcome-group-managed>.welcome-label{color:var(--welcome-accent)}.welcome-pipe{display:flex;flex-direction:column;align-items:flex-start;gap:2px}.welcome-chip{padding:4px 9px;border:1px solid var(--welcome-border);border-radius:6px;background:var(--welcome-surface);color:var(--welcome-text);font-size:12px;line-height:1.3}.welcome-pipe-arrow{padding-left:14px;color:var(--welcome-accent);font-size:12px;line-height:1.2}.welcome-inline-wire{display:flex;align-items:center;gap:10px;padding-left:24px}@media (max-width:768px){.welcome-split,.welcome-split-wide{grid-template-columns:1fr}.welcome-links{flex-direction:row;flex-wrap:wrap;justify-content:center;gap:8px 16px;padding:8px 0 18px}.welcome-link{flex-direction:row-reverse;align-items:center;gap:10px}.welcome-link .welcome-wire-label{max-width:110px;text-align:left}.welcome-wire-h{width:2px;height:36px;margin:8px 0;background-image:repeating-linear-gradient(180deg,var(--welcome-accent) 0 5px,transparent 5px 10px);background-size:2px 10px;animation-name:welcome-dash}.welcome-wire-h::after{top:auto;bottom:-8px;left:-4px;right:auto;border-color:transparent;border-top-color:var(--welcome-accent)}.welcome-wire-h.welcome-wire-rev::after{bottom:auto}.welcome-wire-h.welcome-wire-both::before,.welcome-wire-h.welcome-wire-rev::after{top:-8px;left:-4px;border-color:transparent;border-bottom-color:var(--welcome-accent)}}"}],"page":{"pagePath":"api-reference/plans/update-a-plan","slug":"/api-reference/plans/update-a-plan","pageMetadata":{"title":"Update a plan","description":"Updates an existing plan's properties such as display name, description, and metadata.","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/plans/{id}","href":"/api-reference/plans/update-a-plan","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Updates an existing plan’s properties such as display name, description, and metadata.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Update a plan","description":"Updates an existing plan's properties such as display name, description, and metadata.","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/plans/{id}","href":"/api-reference/plans/update-a-plan","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/stigg/14aedc563c3207a3/content/custom.js"],"openApiReferenceData":{"operation":{"description":"Updates an existing plan's properties such as display name, description, and metadata.","operationId":"PlanController_updatePlan","parameters":["6ebb7961-6660-4343-96b8-51d7b72552fd","f7423e27-2d83-4f35-a1a7-41aa076ac618","67ccd7c7-db0c-46de-b15d-7f62ca3fb75b"],"requestBody":"1e4257bc-40c5-4425-9f13-5dd2ddaf37de","responses":{"200":"d995404d-d7ca-475c-bf73-218c8b1a23e9","400":"ebc95485-0c84-4fc8-a94e-64e705d75bb3","401":"5f4eadc4-906e-4415-b1b1-decbb465dad4","403":"c96d8dcf-7fbc-4f90-8bcd-bb46d2a5b94a","404":"4c59a476-e8d7-4020-87cf-98448a4df23e","429":"a9414aea-adc1-4834-a232-5cf74a9a0431"},"summary":"Update a plan","tags":["Plans"],"x-codeSamples":[{"lang":"JavaScript","source":"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst plan = await client.v1.plans.update('x');\n\nconsole.log(plan.data);"},{"lang":"Python","source":"import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get(\"STIGG_API_KEY\"), # This is the default and can be omitted\n)\nplan = client.v1.plans.update(\n id=\"x\",\n)\nprint(plan.data)"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/stiggio/stigg-go\"\n\t\"github.com/stiggio/stigg-go/option\"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tplan, err := client.V1.Plans.Update(\n\t\tcontext.TODO(),\n\t\t\"x\",\n\t\tstigg.V1PlanUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", plan.Data)\n}\n"},{"lang":"Java","source":"package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.plans.Plan;\nimport io.stigg.models.v1.plans.PlanUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n Plan plan = client.v1().plans().update(\"x\");\n }\n}"},{"lang":"Ruby","source":"require \"stigg\"\n\nstigg = Stigg::Client.new(api_key: \"My API Key\")\n\nplan = stigg.v1.plans.update(\"x\")\n\nputs(plan)"},{"lang":"C#","source":"using System;\nusing Stigg.Client;\nusing Stigg.Client.Models.V1.Plans;\n\nStiggClient client = new();\n\nPlanUpdateParams parameters = new() { ID = \"x\" };\n\nvar plan = await client.V1.Plans.Update(parameters);\n\nConsole.WriteLine(plan);"},{"lang":"CLI","source":"stigg v1:plans update \\\n --api-key 'My API Key' \\\n --id x"}],"method":"patch","type":"path","servers":["fd7bca2e-52e6-41a6-abe3-1c87d2d64523"],"security":["f6e9d2b7-2b82-4d7b-a20f-44e48e4fc008"],"path":"/api/v1/plans/{id}","baseUrlOptions":["https://api.stigg.io"],"title":"Update a plan","codeSamples":[{"lang":"JavaScript","source":"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst plan = await client.v1.plans.update('x');\n\nconsole.log(plan.data);"},{"lang":"Python","source":"import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get(\"STIGG_API_KEY\"), # This is the default and can be omitted\n)\nplan = client.v1.plans.update(\n id=\"x\",\n)\nprint(plan.data)"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/stiggio/stigg-go\"\n\t\"github.com/stiggio/stigg-go/option\"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tplan, err := client.V1.Plans.Update(\n\t\tcontext.TODO(),\n\t\t\"x\",\n\t\tstigg.V1PlanUpdateParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", plan.Data)\n}\n"},{"lang":"Java","source":"package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.plans.Plan;\nimport io.stigg.models.v1.plans.PlanUpdateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n Plan plan = client.v1().plans().update(\"x\");\n }\n}"},{"lang":"Ruby","source":"require \"stigg\"\n\nstigg = Stigg::Client.new(api_key: \"My API Key\")\n\nplan = stigg.v1.plans.update(\"x\")\n\nputs(plan)"},{"lang":"C#","source":"using System;\nusing Stigg.Client;\nusing Stigg.Client.Models.V1.Plans;\n\nStiggClient client = new();\n\nPlanUpdateParams parameters = new() { ID = \"x\" };\n\nvar plan = await client.V1.Plans.Update(parameters);\n\nConsole.WriteLine(plan);"},{"lang":"CLI","source":"stigg v1:plans update \\\n --api-key 'My API Key' \\\n --id x"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"6ebb7961-6660-4343-96b8-51d7b72552fd":{"name":"id","required":true,"in":"path","description":"The unique identifier of the entity","schema":{"minLength":1,"maxLength":255,"type":"string","isRequired":true,"description":"The unique identifier of the entity","uniqueKey":"","typeLabel":"string"}},"f7423e27-2d83-4f35-a1a7-41aa076ac618":{"name":"X-ACCOUNT-ID","in":"header","description":"Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.","required":false,"schema":{"type":"string","isRequired":false,"description":"Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.","uniqueKey":"","typeLabel":"string"}},"67ccd7c7-db0c-46de-b15d-7f62ca3fb75b":{"name":"X-ENVIRONMENT-ID","in":"header","description":"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).","required":false,"schema":{"type":"string","isRequired":false,"description":"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).","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","maxLength":255,"description":"The display name of the package","uniqueKey":"displayName","typeLabel":"string"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"The description of the package","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The description of the package","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"billingId":{"oneOf":[{"type":"string","maxLength":255,"description":"The unique identifier for the entity in the billing provider","uniqueKey":"billingId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The unique identifier for the entity in the billing provider","uniqueKey":"billingId.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingId","typeLabel":"string | null"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"Metadata associated with the entity","uniqueKey":"metadata","typeLabel":"object"},"parentPlanId":{"oneOf":[{"type":"string","maxLength":255,"description":"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.","uniqueKey":"parentPlanId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"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.","uniqueKey":"parentPlanId.oneOf.1","typeLabel":"null"}],"uniqueKey":"parentPlanId","typeLabel":"string | null"},"defaultTrialConfig":{"oneOf":[{"type":"object","properties":{"duration":{"type":"number","description":"The duration of the trial in the specified units","isRequired":true,"uniqueKey":"defaultTrialConfig.oneOf.0.duration","typeLabel":"number"},"units":{"type":"string","enum":["DAY","MONTH"],"description":"The time unit for the trial duration (DAY or MONTH)","isRequired":true,"uniqueKey":"defaultTrialConfig.oneOf.0.units","typeLabel":"enum\u003cstring>"},"budget":{"oneOf":[{"type":"object","properties":{"limit":{"type":"number","description":"The budget limit amount","isRequired":true,"uniqueKey":"defaultTrialConfig.oneOf.0.budget.oneOf.0.limit","typeLabel":"number"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget limit is a soft limit (allows overage) or hard limit","isRequired":true,"uniqueKey":"defaultTrialConfig.oneOf.0.budget.oneOf.0.hasSoftLimit","typeLabel":"boolean"}},"required":["limit","hasSoftLimit"],"title":"BudgetConfiguration","description":"Budget configuration for the trial","uniqueKey":"defaultTrialConfig.oneOf.0.budget.oneOf.0","typeLabel":"BudgetConfiguration · object"},{"type":"null","properties":{"limit":{"type":"number","description":"The budget limit amount"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget limit is a soft limit (allows overage) or hard limit"}},"required":["limit","hasSoftLimit"],"title":"BudgetConfiguration","description":"Budget configuration for the trial","uniqueKey":"defaultTrialConfig.oneOf.0.budget.oneOf.1","typeLabel":"null"}],"uniqueKey":"defaultTrialConfig.oneOf.0.budget","typeLabel":"BudgetConfiguration · object | null"},"trialEndBehavior":{"oneOf":[{"type":"string","enum":["CONVERT_TO_PAID","CANCEL_SUBSCRIPTION"],"description":"Behavior when the trial ends (CONVERT_TO_PAID or CANCEL_SUBSCRIPTION)","uniqueKey":"defaultTrialConfig.oneOf.0.trialEndBehavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["CONVERT_TO_PAID","CANCEL_SUBSCRIPTION"],"description":"Behavior when the trial ends (CONVERT_TO_PAID or CANCEL_SUBSCRIPTION)","uniqueKey":"defaultTrialConfig.oneOf.0.trialEndBehavior.oneOf.1","typeLabel":"null"}],"uniqueKey":"defaultTrialConfig.oneOf.0.trialEndBehavior","typeLabel":"enum\u003cstring> | null"}},"required":["duration","units"],"title":"DefaultTrialConfig","description":"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.","uniqueKey":"defaultTrialConfig.oneOf.0","typeLabel":"DefaultTrialConfig · object"},{"type":"null","properties":{"duration":{"type":"number","description":"The duration of the trial in the specified units"},"units":{"type":"string","enum":["DAY","MONTH"],"description":"The time unit for the trial duration (DAY or MONTH)"},"budget":{"oneOf":[{"type":"object","properties":{"limit":{"type":"number","description":"The budget limit amount"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget limit is a soft limit (allows overage) or hard limit"}},"required":["limit","hasSoftLimit"],"title":"BudgetConfiguration","description":"Budget configuration for the trial"},{"type":"null","properties":{"limit":{"type":"number","description":"The budget limit amount"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget limit is a soft limit (allows overage) or hard limit"}},"required":["limit","hasSoftLimit"],"title":"BudgetConfiguration","description":"Budget configuration for the trial"}]},"trialEndBehavior":{"oneOf":[{"type":"string","enum":["CONVERT_TO_PAID","CANCEL_SUBSCRIPTION"],"description":"Behavior when the trial ends (CONVERT_TO_PAID or CANCEL_SUBSCRIPTION)"},{"type":"null","enum":["CONVERT_TO_PAID","CANCEL_SUBSCRIPTION"],"description":"Behavior when the trial ends (CONVERT_TO_PAID or CANCEL_SUBSCRIPTION)"}]}},"required":["duration","units"],"title":"DefaultTrialConfig","description":"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.","uniqueKey":"defaultTrialConfig.oneOf.1","typeLabel":"null"}],"uniqueKey":"defaultTrialConfig","typeLabel":"DefaultTrialConfig · object | null"},"compatibleAddonIds":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":255,"description":"List of compatible addon IDs for this plan","uniqueKey":"compatibleAddonIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"compatibleAddonIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","maxLength":255,"description":"List of compatible addon IDs for this plan"},"uniqueKey":"compatibleAddonIds.oneOf.1","typeLabel":"null"}],"uniqueKey":"compatibleAddonIds","typeLabel":"string[] | null"},"charges":{"type":"object","properties":{"pricingType":{"type":"string","enum":["FREE","PAID","CUSTOM"],"description":"The pricing type (FREE, PAID, or CUSTOM)","isRequired":true,"uniqueKey":"charges.pricingType","typeLabel":"enum\u003cstring>"},"pricingModels":{"type":"array","items":{"type":"object","properties":{"billingModel":{"type":"string","enum":["FLAT_FEE","MINIMUM_SPEND","PER_UNIT","USAGE_BASED","CREDIT_BASED"],"description":"The billing model (FLAT_FEE, PER_UNIT, USAGE_BASED, CREDIT_BASED)","isRequired":true,"uniqueKey":"charges.pricingModels.items.[INDEX].billingModel","typeLabel":"enum\u003cstring>"},"pricePeriods":{"description":"Array of price period configurations (at least one required)","type":"array","items":{"type":"object","properties":{"billingPeriod":{"type":"string","enum":["MONTHLY","ANNUALLY"],"description":"The billing period (MONTHLY or ANNUALLY)","isRequired":true,"uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].billingPeriod","typeLabel":"enum\u003cstring>"},"billingCountryCode":{"description":"ISO country code for localized pricing, or \"eu\" for the European Union group you map countries into","type":"string","maxLength":255,"uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].billingCountryCode","typeLabel":"string"},"price":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].price.amount","typeLabel":"number"},"currency":{"description":"The price currency","type":"string","enum":["usd","aed","all","amd","ang","aud","awg","azn","bam","bbd","bdt","bgn","bif","bmd","bnd","bsd","bwp","byn","bzd","brl","cad","cdf","chf","cny","czk","dkk","dop","dzd","egp","etb","eur","fjd","gbp","gel","gip","gmd","gyd","hkd","hrk","htg","idr","ils","inr","isk","jmd","jpy","kes","kgs","khr","kmf","krw","kyd","kzt","lbp","lkr","lrd","lsl","mad","mdl","mga","mkd","mmk","mnt","mop","mro","mvr","mwk","mxn","myr","mzn","nad","ngn","nok","npr","nzd","pgk","php","pkr","pln","qar","ron","rsd","rub","rwf","sar","sbd","scr","sek","sgd","sle","sll","sos","szl","thb","tjs","top","try","ttd","tzs","uah","uzs","vnd","vuv","wst","xaf","xcd","yer","zar","zmw","clp","djf","gnf","ugx","pyg","xof","xpf"],"title":"Currency","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].price.currency","typeLabel":"enum\u003cstring>"}},"required":["amount"],"description":"The price amount and currency","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].price","typeLabel":"object"},"creditRate":{"type":"object","properties":{"amount":{"type":"number","minimum":0,"exclusiveMinimum":true,"description":"The credit rate amount","isRequired":true,"uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].creditRate.amount","typeLabel":"number"},"currencyId":{"type":"string","maxLength":255,"description":"The custom currency ID","isRequired":true,"uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].creditRate.currencyId","typeLabel":"string"},"costFormula":{"type":"string","maxLength":255,"description":"Optional cost formula expression","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].creditRate.costFormula","typeLabel":"string"}},"required":["amount","currencyId"],"title":"CreditRate","description":"Credit rate configuration for credit-based pricing","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].creditRate","typeLabel":"CreditRate · object"},"blockSize":{"type":"number","description":"Block size for usage-based pricing","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].blockSize","typeLabel":"number"},"tiers":{"type":"array","items":{"type":"object","properties":{"upTo":{"type":"number","description":"Upper bound of this tier (null for unlimited)","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].upTo","typeLabel":"number"},"unitPrice":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].unitPrice.amount","typeLabel":"number"},"currency":{"description":"The price currency","type":"string","enum":["usd","aed","all","amd","ang","aud","awg","azn","bam","bbd","bdt","bgn","bif","bmd","bnd","bsd","bwp","byn","bzd","brl","cad","cdf","chf","cny","czk","dkk","dop","dzd","egp","etb","eur","fjd","gbp","gel","gip","gmd","gyd","hkd","hrk","htg","idr","ils","inr","isk","jmd","jpy","kes","kgs","khr","kmf","krw","kyd","kzt","lbp","lkr","lrd","lsl","mad","mdl","mga","mkd","mmk","mnt","mop","mro","mvr","mwk","mxn","myr","mzn","nad","ngn","nok","npr","nzd","pgk","php","pkr","pln","qar","ron","rsd","rub","rwf","sar","sbd","scr","sek","sgd","sle","sll","sos","szl","thb","tjs","top","try","ttd","tzs","uah","uzs","vnd","vuv","wst","xaf","xcd","yer","zar","zmw","clp","djf","gnf","ugx","pyg","xof","xpf"],"title":"Currency","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].unitPrice.currency","typeLabel":"enum\u003cstring>"}},"required":["amount"],"description":"Per-unit price in this tier","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].unitPrice","typeLabel":"object"},"flatPrice":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].flatPrice.amount","typeLabel":"number"},"currency":{"description":"The price currency","type":"string","enum":["usd","aed","all","amd","ang","aud","awg","azn","bam","bbd","bdt","bgn","bif","bmd","bnd","bsd","bwp","byn","bzd","brl","cad","cdf","chf","cny","czk","dkk","dop","dzd","egp","etb","eur","fjd","gbp","gel","gip","gmd","gyd","hkd","hrk","htg","idr","ils","inr","isk","jmd","jpy","kes","kgs","khr","kmf","krw","kyd","kzt","lbp","lkr","lrd","lsl","mad","mdl","mga","mkd","mmk","mnt","mop","mro","mvr","mwk","mxn","myr","mzn","nad","ngn","nok","npr","nzd","pgk","php","pkr","pln","qar","ron","rsd","rub","rwf","sar","sbd","scr","sek","sgd","sle","sll","sos","szl","thb","tjs","top","try","ttd","tzs","uah","uzs","vnd","vuv","wst","xaf","xcd","yer","zar","zmw","clp","djf","gnf","ugx","pyg","xof","xpf"],"title":"Currency","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].flatPrice.currency","typeLabel":"enum\u003cstring>"}},"required":["amount"],"description":"Flat price for this tier","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].flatPrice","typeLabel":"object"}},"title":"PriceTier","description":"A tier in tiered pricing.","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX]","typeLabel":"PriceTier · object"},"description":"Tiered pricing configuration","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers","typeLabel":"PriceTier · object[]"},"creditGrantCadence":{"type":"string","enum":["BEGINNING_OF_BILLING_PERIOD","MONTHLY"],"description":"When credits are granted","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX].creditGrantCadence","typeLabel":"enum\u003cstring>"}},"required":["billingPeriod"],"title":"PricePeriod","description":"Price configuration for a specific billing period.","uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods.items.[INDEX]","typeLabel":"PricePeriod · object"},"minItems":1,"isRequired":true,"uniqueKey":"charges.pricingModels.items.[INDEX].pricePeriods","typeLabel":"PricePeriod · object[]"},"billingCadence":{"default":"RECURRING","type":"string","enum":["RECURRING","ONE_OFF"],"description":"The billing cadence (RECURRING or ONE_OFF)","uniqueKey":"charges.pricingModels.items.[INDEX].billingCadence","typeLabel":"enum\u003cstring>"},"featureId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"The feature ID this pricing model is associated with","uniqueKey":"charges.pricingModels.items.[INDEX].featureId","typeLabel":"string"},"topUpCustomCurrencyId":{"type":"string","maxLength":255,"description":"The custom currency ID for top-up pricing","uniqueKey":"charges.pricingModels.items.[INDEX].topUpCustomCurrencyId","typeLabel":"string"},"tiersMode":{"type":"string","enum":["VOLUME","GRADUATED"],"description":"The tiered pricing mode (VOLUME or GRADUATED)","uniqueKey":"charges.pricingModels.items.[INDEX].tiersMode","typeLabel":"enum\u003cstring>"},"minUnitQuantity":{"type":"integer","minimum":1,"maximum":2147483647,"description":"Minimum number of units","uniqueKey":"charges.pricingModels.items.[INDEX].minUnitQuantity","typeLabel":"integer"},"maxUnitQuantity":{"type":"integer","minimum":1,"maximum":2147483647,"description":"Maximum number of units","uniqueKey":"charges.pricingModels.items.[INDEX].maxUnitQuantity","typeLabel":"integer"},"resetPeriod":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","HOUR"],"description":"The usage reset period","uniqueKey":"charges.pricingModels.items.[INDEX].resetPeriod","typeLabel":"enum\u003cstring>"},"yearlyResetPeriodConfiguration":{"type":"object","properties":{"accordingTo":{"type":"string","enum":["SubscriptionStart"],"description":"Reset anchor (SubscriptionStart)","isRequired":true,"uniqueKey":"charges.pricingModels.items.[INDEX].yearlyResetPeriodConfiguration.accordingTo","typeLabel":"enum\u003cstring>"}},"required":["accordingTo"],"title":"YearlyResetPeriodConfig","description":"Yearly reset period configuration","uniqueKey":"charges.pricingModels.items.[INDEX].yearlyResetPeriodConfiguration","typeLabel":"YearlyResetPeriodConfig · object"},"monthlyResetPeriodConfiguration":{"type":"object","properties":{"accordingTo":{"type":"string","enum":["SubscriptionStart","StartOfTheMonth"],"description":"Reset anchor (SubscriptionStart or StartOfTheMonth)","isRequired":true,"uniqueKey":"charges.pricingModels.items.[INDEX].monthlyResetPeriodConfiguration.accordingTo","typeLabel":"enum\u003cstring>"}},"required":["accordingTo"],"title":"MonthlyResetPeriodConfig","description":"Monthly reset period configuration","uniqueKey":"charges.pricingModels.items.[INDEX].monthlyResetPeriodConfiguration","typeLabel":"MonthlyResetPeriodConfig · object"},"weeklyResetPeriodConfiguration":{"type":"object","properties":{"accordingTo":{"type":"string","enum":["SubscriptionStart","EverySunday","EveryMonday","EveryTuesday","EveryWednesday","EveryThursday","EveryFriday","EverySaturday"],"description":"Reset anchor (SubscriptionStart or specific day)","isRequired":true,"uniqueKey":"charges.pricingModels.items.[INDEX].weeklyResetPeriodConfiguration.accordingTo","typeLabel":"enum\u003cstring>"}},"required":["accordingTo"],"title":"WeeklyResetPeriodConfig","description":"Weekly reset period configuration","uniqueKey":"charges.pricingModels.items.[INDEX].weeklyResetPeriodConfiguration","typeLabel":"WeeklyResetPeriodConfig · object"}},"required":["billingModel","pricePeriods"],"title":"PricingModel","description":"A pricing model configuration with billing details and price periods.","uniqueKey":"charges.pricingModels.items.[INDEX]","typeLabel":"PricingModel · object"},"maxItems":50,"description":"Array of pricing model configurations. Replaces all existing base pricing models on the draft — omit this to end up with no base pricing.","uniqueKey":"charges.pricingModels","typeLabel":"PricingModel · object[]"},"overagePricingModels":{"type":"array","items":{"type":"object","properties":{"pricePeriods":{"type":"array","items":{"type":"object","properties":{"billingPeriod":{"type":"string","enum":["MONTHLY","ANNUALLY"],"description":"The billing period (MONTHLY or ANNUALLY)","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].billingPeriod","typeLabel":"enum\u003cstring>"},"billingCountryCode":{"description":"ISO country code for localized pricing, or \"eu\" for the European Union group you map countries into","type":"string","maxLength":255,"uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].billingCountryCode","typeLabel":"string"},"price":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].price.amount","typeLabel":"number"},"currency":{"description":"The price currency","type":"string","enum":["usd","aed","all","amd","ang","aud","awg","azn","bam","bbd","bdt","bgn","bif","bmd","bnd","bsd","bwp","byn","bzd","brl","cad","cdf","chf","cny","czk","dkk","dop","dzd","egp","etb","eur","fjd","gbp","gel","gip","gmd","gyd","hkd","hrk","htg","idr","ils","inr","isk","jmd","jpy","kes","kgs","khr","kmf","krw","kyd","kzt","lbp","lkr","lrd","lsl","mad","mdl","mga","mkd","mmk","mnt","mop","mro","mvr","mwk","mxn","myr","mzn","nad","ngn","nok","npr","nzd","pgk","php","pkr","pln","qar","ron","rsd","rub","rwf","sar","sbd","scr","sek","sgd","sle","sll","sos","szl","thb","tjs","top","try","ttd","tzs","uah","uzs","vnd","vuv","wst","xaf","xcd","yer","zar","zmw","clp","djf","gnf","ugx","pyg","xof","xpf"],"title":"Currency","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].price.currency","typeLabel":"enum\u003cstring>"}},"required":["amount"],"description":"The price amount and currency","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].price","typeLabel":"object"},"creditRate":{"type":"object","properties":{"amount":{"type":"number","minimum":0,"exclusiveMinimum":true,"description":"The credit rate amount","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].creditRate.amount","typeLabel":"number"},"currencyId":{"type":"string","maxLength":255,"description":"The custom currency ID","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].creditRate.currencyId","typeLabel":"string"},"costFormula":{"type":"string","maxLength":255,"description":"Optional cost formula expression","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].creditRate.costFormula","typeLabel":"string"}},"required":["amount","currencyId"],"title":"CreditRate","description":"Credit rate configuration for credit-based pricing","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].creditRate","typeLabel":"CreditRate · object"},"blockSize":{"type":"number","description":"Block size for usage-based pricing","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].blockSize","typeLabel":"number"},"tiers":{"type":"array","items":{"type":"object","properties":{"upTo":{"type":"number","description":"Upper bound of this tier (null for unlimited)","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].upTo","typeLabel":"number"},"unitPrice":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].unitPrice.amount","typeLabel":"number"},"currency":{"description":"The price currency","type":"string","enum":["usd","aed","all","amd","ang","aud","awg","azn","bam","bbd","bdt","bgn","bif","bmd","bnd","bsd","bwp","byn","bzd","brl","cad","cdf","chf","cny","czk","dkk","dop","dzd","egp","etb","eur","fjd","gbp","gel","gip","gmd","gyd","hkd","hrk","htg","idr","ils","inr","isk","jmd","jpy","kes","kgs","khr","kmf","krw","kyd","kzt","lbp","lkr","lrd","lsl","mad","mdl","mga","mkd","mmk","mnt","mop","mro","mvr","mwk","mxn","myr","mzn","nad","ngn","nok","npr","nzd","pgk","php","pkr","pln","qar","ron","rsd","rub","rwf","sar","sbd","scr","sek","sgd","sle","sll","sos","szl","thb","tjs","top","try","ttd","tzs","uah","uzs","vnd","vuv","wst","xaf","xcd","yer","zar","zmw","clp","djf","gnf","ugx","pyg","xof","xpf"],"title":"Currency","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].unitPrice.currency","typeLabel":"enum\u003cstring>"}},"required":["amount"],"description":"Per-unit price in this tier","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].unitPrice","typeLabel":"object"},"flatPrice":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].flatPrice.amount","typeLabel":"number"},"currency":{"description":"The price currency","type":"string","enum":["usd","aed","all","amd","ang","aud","awg","azn","bam","bbd","bdt","bgn","bif","bmd","bnd","bsd","bwp","byn","bzd","brl","cad","cdf","chf","cny","czk","dkk","dop","dzd","egp","etb","eur","fjd","gbp","gel","gip","gmd","gyd","hkd","hrk","htg","idr","ils","inr","isk","jmd","jpy","kes","kgs","khr","kmf","krw","kyd","kzt","lbp","lkr","lrd","lsl","mad","mdl","mga","mkd","mmk","mnt","mop","mro","mvr","mwk","mxn","myr","mzn","nad","ngn","nok","npr","nzd","pgk","php","pkr","pln","qar","ron","rsd","rub","rwf","sar","sbd","scr","sek","sgd","sle","sll","sos","szl","thb","tjs","top","try","ttd","tzs","uah","uzs","vnd","vuv","wst","xaf","xcd","yer","zar","zmw","clp","djf","gnf","ugx","pyg","xof","xpf"],"title":"Currency","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].flatPrice.currency","typeLabel":"enum\u003cstring>"}},"required":["amount"],"description":"Flat price for this tier","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX].flatPrice","typeLabel":"object"}},"title":"PriceTier","description":"A tier in tiered pricing.","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers.items.[INDEX]","typeLabel":"PriceTier · object"},"description":"Tiered pricing configuration","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].tiers","typeLabel":"PriceTier · object[]"},"creditGrantCadence":{"type":"string","enum":["BEGINNING_OF_BILLING_PERIOD","MONTHLY"],"description":"When credits are granted","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX].creditGrantCadence","typeLabel":"enum\u003cstring>"}},"required":["billingPeriod"],"title":"PricePeriod","description":"Price configuration for a specific billing period.","uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods.items.[INDEX]","typeLabel":"PricePeriod · object"},"minItems":1,"description":"Price periods for overage pricing","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].pricePeriods","typeLabel":"PricePeriod · object[]"},"featureId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"The feature ID for overage pricing","uniqueKey":"charges.overagePricingModels.items.[INDEX].featureId","typeLabel":"string"},"currencyId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"The refId of the custom currency this credit overage applies to","uniqueKey":"charges.overagePricingModels.items.[INDEX].currencyId","typeLabel":"string"},"entitlement":{"type":"object","properties":{"featureId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"The feature ID for the entitlement","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].entitlement.featureId","typeLabel":"string"},"usageLimit":{"type":"number","description":"The usage limit before overage kicks in","uniqueKey":"charges.overagePricingModels.items.[INDEX].entitlement.usageLimit","typeLabel":"number"},"hasUnlimitedUsage":{"type":"boolean","description":"Whether usage is unlimited","uniqueKey":"charges.overagePricingModels.items.[INDEX].entitlement.hasUnlimitedUsage","typeLabel":"boolean"},"hasSoftLimit":{"type":"boolean","description":"Whether the limit is soft (allows overage)","uniqueKey":"charges.overagePricingModels.items.[INDEX].entitlement.hasSoftLimit","typeLabel":"boolean"},"resetPeriod":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","HOUR"],"description":"The usage reset period","uniqueKey":"charges.overagePricingModels.items.[INDEX].entitlement.resetPeriod","typeLabel":"enum\u003cstring>"},"yearlyResetPeriodConfiguration":{"type":"object","properties":{"accordingTo":{"type":"string","enum":["SubscriptionStart"],"description":"Reset anchor (SubscriptionStart)","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].entitlement.yearlyResetPeriodConfiguration.accordingTo","typeLabel":"enum\u003cstring>"}},"required":["accordingTo"],"title":"YearlyResetPeriodConfig","description":"Yearly reset configuration","uniqueKey":"charges.overagePricingModels.items.[INDEX].entitlement.yearlyResetPeriodConfiguration","typeLabel":"YearlyResetPeriodConfig · object"},"monthlyResetPeriodConfiguration":{"type":"object","properties":{"accordingTo":{"type":"string","enum":["SubscriptionStart","StartOfTheMonth"],"description":"Reset anchor (SubscriptionStart or StartOfTheMonth)","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].entitlement.monthlyResetPeriodConfiguration.accordingTo","typeLabel":"enum\u003cstring>"}},"required":["accordingTo"],"title":"MonthlyResetPeriodConfig","description":"Monthly reset configuration","uniqueKey":"charges.overagePricingModels.items.[INDEX].entitlement.monthlyResetPeriodConfiguration","typeLabel":"MonthlyResetPeriodConfig · object"},"weeklyResetPeriodConfiguration":{"type":"object","properties":{"accordingTo":{"type":"string","enum":["SubscriptionStart","EverySunday","EveryMonday","EveryTuesday","EveryWednesday","EveryThursday","EveryFriday","EverySaturday"],"description":"Reset anchor (SubscriptionStart or specific day)","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].entitlement.weeklyResetPeriodConfiguration.accordingTo","typeLabel":"enum\u003cstring>"}},"required":["accordingTo"],"title":"WeeklyResetPeriodConfig","description":"Weekly reset configuration","uniqueKey":"charges.overagePricingModels.items.[INDEX].entitlement.weeklyResetPeriodConfiguration","typeLabel":"WeeklyResetPeriodConfig · object"}},"required":["featureId"],"title":"OverageEntitlement","description":"Entitlement configuration for the overage feature","uniqueKey":"charges.overagePricingModels.items.[INDEX].entitlement","typeLabel":"OverageEntitlement · object"},"creditEntitlement":{"type":"object","properties":{"customCurrencyId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"The refId of the custom currency to grant","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].creditEntitlement.customCurrencyId","typeLabel":"string"},"amount":{"type":"number","minimum":0,"description":"The base credit balance granted per cadence","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].creditEntitlement.amount","typeLabel":"number"},"cadence":{"type":"string","enum":["MONTH","YEAR"],"description":"The credit grant cadence (MONTH or YEAR)","isRequired":true,"uniqueKey":"charges.overagePricingModels.items.[INDEX].creditEntitlement.cadence","typeLabel":"enum\u003cstring>"}},"required":["customCurrencyId","amount","cadence"],"title":"OverageCreditEntitlement","description":"Credit entitlement to grant when a credit overage targets a currency not yet granted on the plan","uniqueKey":"charges.overagePricingModels.items.[INDEX].creditEntitlement","typeLabel":"OverageCreditEntitlement · object"}},"required":["pricePeriods"],"title":"OveragePricingModel","description":"Overage pricing model configuration.","uniqueKey":"charges.overagePricingModels.items.[INDEX]","typeLabel":"OveragePricingModel · object"},"maxItems":50,"description":"Array of overage pricing model configurations. Replaces all existing overage pricing models on the draft — omit this to end up with no overage pricing.","uniqueKey":"charges.overagePricingModels","typeLabel":"OveragePricingModel · object[]"},"overageBillingPeriod":{"type":"string","enum":["ON_SUBSCRIPTION_RENEWAL","MONTHLY"],"description":"When overage charges are billed","uniqueKey":"charges.overageBillingPeriod","typeLabel":"enum\u003cstring>"},"minimumSpend":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"billingPeriod":{"type":"string","enum":["MONTHLY","ANNUALLY"],"description":"The billing period","isRequired":true,"uniqueKey":"charges.minimumSpend.oneOf.0.items.[INDEX].billingPeriod","typeLabel":"enum\u003cstring>"},"minimum":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"charges.minimumSpend.oneOf.0.items.[INDEX].minimum.amount","typeLabel":"number"},"currency":{"description":"The price currency","type":"string","enum":["usd","aed","all","amd","ang","aud","awg","azn","bam","bbd","bdt","bgn","bif","bmd","bnd","bsd","bwp","byn","bzd","brl","cad","cdf","chf","cny","czk","dkk","dop","dzd","egp","etb","eur","fjd","gbp","gel","gip","gmd","gyd","hkd","hrk","htg","idr","ils","inr","isk","jmd","jpy","kes","kgs","khr","kmf","krw","kyd","kzt","lbp","lkr","lrd","lsl","mad","mdl","mga","mkd","mmk","mnt","mop","mro","mvr","mwk","mxn","myr","mzn","nad","ngn","nok","npr","nzd","pgk","php","pkr","pln","qar","ron","rsd","rub","rwf","sar","sbd","scr","sek","sgd","sle","sll","sos","szl","thb","tjs","top","try","ttd","tzs","uah","uzs","vnd","vuv","wst","xaf","xcd","yer","zar","zmw","clp","djf","gnf","ugx","pyg","xof","xpf"],"title":"Currency","uniqueKey":"charges.minimumSpend.oneOf.0.items.[INDEX].minimum.currency","typeLabel":"enum\u003cstring>"}},"required":["amount"],"description":"The minimum spend amount","isRequired":true,"uniqueKey":"charges.minimumSpend.oneOf.0.items.[INDEX].minimum","typeLabel":"object"}},"required":["billingPeriod","minimum"],"title":"MinimumSpend","description":"Minimum spend configuration for a billing period.","uniqueKey":"charges.minimumSpend.oneOf.0.items.[INDEX]","typeLabel":"MinimumSpend · object"},"description":"Minimum spend configuration per billing period","uniqueKey":"charges.minimumSpend.oneOf.0","typeLabel":"MinimumSpend · object[]"},{"type":"null","items":{"type":"object","properties":{"billingPeriod":{"type":"string","enum":["MONTHLY","ANNUALLY"],"description":"The billing period"},"minimum":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount"},"currency":{"description":"The price currency","type":"string","enum":["usd","aed","all","amd","ang","aud","awg","azn","bam","bbd","bdt","bgn","bif","bmd","bnd","bsd","bwp","byn","bzd","brl","cad","cdf","chf","cny","czk","dkk","dop","dzd","egp","etb","eur","fjd","gbp","gel","gip","gmd","gyd","hkd","hrk","htg","idr","ils","inr","isk","jmd","jpy","kes","kgs","khr","kmf","krw","kyd","kzt","lbp","lkr","lrd","lsl","mad","mdl","mga","mkd","mmk","mnt","mop","mro","mvr","mwk","mxn","myr","mzn","nad","ngn","nok","npr","nzd","pgk","php","pkr","pln","qar","ron","rsd","rub","rwf","sar","sbd","scr","sek","sgd","sle","sll","sos","szl","thb","tjs","top","try","ttd","tzs","uah","uzs","vnd","vuv","wst","xaf","xcd","yer","zar","zmw","clp","djf","gnf","ugx","pyg","xof","xpf"],"title":"Currency"}},"required":["amount"],"description":"The minimum spend amount"}},"required":["billingPeriod","minimum"],"title":"MinimumSpend","description":"Minimum spend configuration for a billing period."},"description":"Minimum spend configuration per billing period","uniqueKey":"charges.minimumSpend.oneOf.1","typeLabel":"null"}],"uniqueKey":"charges.minimumSpend","typeLabel":"MinimumSpend · object[] | null"},"billingId":{"type":"string","maxLength":255,"description":"Deprecated: billing integration ID","uniqueKey":"charges.billingId","typeLabel":"string"}},"required":["pricingType"],"additionalProperties":false,"title":"SetPackagePricingRequest","description":"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.","uniqueKey":"charges","typeLabel":"SetPackagePricingRequest · object"}},"additionalProperties":false,"title":"UpdatePlanRequest","description":"Partially update an existing plan. Only provided fields are updated; omitted fields keep their current value.","uniqueKey":"","typeLabel":"UpdatePlanRequest · object"},"examples":{"Example":{"title":"Example","value":{"displayName":"\u003cstring>","description":"\u003cstring>","billingId":"\u003cstring>","metadata":{},"parentPlanId":"\u003cstring>","defaultTrialConfig":{"duration":123,"budget":{"limit":123,"hasSoftLimit":true}},"compatibleAddonIds":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"d995404d-d7ca-475c-bf73-218c8b1a23e9":{"description":"The updated plan object.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"The unique identifier for the entity","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"displayName":{"type":"string","maxLength":255,"description":"The display name of the package","isRequired":true,"uniqueKey":"data.displayName","typeLabel":"string"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"The description of the package","isRequired":true,"uniqueKey":"data.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The description of the package","isRequired":true,"uniqueKey":"data.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.description","typeLabel":"string | null"},"productId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"The product id of the package","isRequired":true,"uniqueKey":"data.productId","typeLabel":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","ARCHIVED"],"description":"The status of the package","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"pricingType":{"oneOf":[{"type":"string","enum":["FREE","PAID","CUSTOM"],"description":"The pricing type of the package","isRequired":true,"uniqueKey":"data.pricingType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["FREE","PAID","CUSTOM"],"description":"The pricing type of the package","isRequired":true,"uniqueKey":"data.pricingType.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.pricingType","typeLabel":"enum\u003cstring> | null"},"billingId":{"oneOf":[{"type":"string","maxLength":255,"description":"The unique identifier for the entity in the billing provider","isRequired":true,"uniqueKey":"data.billingId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The unique identifier for the entity in the billing provider","isRequired":true,"uniqueKey":"data.billingId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.billingId","typeLabel":"string | null"},"versionNumber":{"type":"integer","description":"The version number of the package","isRequired":true,"uniqueKey":"data.versionNumber","typeLabel":"integer"},"isLatest":{"oneOf":[{"type":"boolean","description":"Indicates if the package is the latest version","isRequired":true,"uniqueKey":"data.isLatest.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates if the package is the latest version","isRequired":true,"uniqueKey":"data.isLatest.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.isLatest","typeLabel":"boolean | null"},"entitlements":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["FEATURE","CREDIT"],"isRequired":true,"uniqueKey":"data.entitlements.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","maxLength":255,"description":"The unique identifier for the entity","isRequired":true,"uniqueKey":"data.entitlements.items.[INDEX].id","typeLabel":"string"}},"required":["type","id"],"title":"PackageEntitlement","description":"Entitlement reference with type and identifier","uniqueKey":"data.entitlements.items.[INDEX]","typeLabel":"PackageEntitlement · object"},"description":"List of entitlements of the package","isRequired":true,"uniqueKey":"data.entitlements","typeLabel":"PackageEntitlement · object[]"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.metadata.additionalProperties","typeLabel":"string"},"description":"Metadata associated with the entity","isRequired":true,"uniqueKey":"data.metadata","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp of when the record was created","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp of when the record was last updated","isRequired":true,"uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"},"parentPlanId":{"oneOf":[{"type":"string","maxLength":255,"description":"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.","isRequired":true,"uniqueKey":"data.parentPlanId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"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.","isRequired":true,"uniqueKey":"data.parentPlanId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.parentPlanId","typeLabel":"string | null"},"defaultTrialConfig":{"oneOf":[{"type":"object","properties":{"duration":{"type":"number","description":"The duration of the trial in the specified units","isRequired":true,"uniqueKey":"data.defaultTrialConfig.oneOf.0.duration","typeLabel":"number"},"units":{"type":"string","enum":["DAY","MONTH"],"description":"The time unit for the trial duration (DAY or MONTH)","isRequired":true,"uniqueKey":"data.defaultTrialConfig.oneOf.0.units","typeLabel":"enum\u003cstring>"},"budget":{"oneOf":[{"type":"object","properties":{"limit":{"type":"number","description":"The budget limit amount","isRequired":true,"uniqueKey":"data.defaultTrialConfig.oneOf.0.budget.oneOf.0.limit","typeLabel":"number"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget limit is a soft limit (allows overage) or hard limit","isRequired":true,"uniqueKey":"data.defaultTrialConfig.oneOf.0.budget.oneOf.0.hasSoftLimit","typeLabel":"boolean"}},"required":["limit","hasSoftLimit"],"title":"BudgetConfiguration","description":"Budget configuration for the trial","uniqueKey":"data.defaultTrialConfig.oneOf.0.budget.oneOf.0","typeLabel":"BudgetConfiguration · object"},{"type":"null","properties":{"limit":{"type":"number","description":"The budget limit amount"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget limit is a soft limit (allows overage) or hard limit"}},"required":["limit","hasSoftLimit"],"title":"BudgetConfiguration","description":"Budget configuration for the trial","uniqueKey":"data.defaultTrialConfig.oneOf.0.budget.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.defaultTrialConfig.oneOf.0.budget","typeLabel":"BudgetConfiguration · object | null"},"trialEndBehavior":{"oneOf":[{"type":"string","enum":["CONVERT_TO_PAID","CANCEL_SUBSCRIPTION"],"description":"Behavior when the trial ends (CONVERT_TO_PAID or CANCEL_SUBSCRIPTION)","uniqueKey":"data.defaultTrialConfig.oneOf.0.trialEndBehavior.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["CONVERT_TO_PAID","CANCEL_SUBSCRIPTION"],"description":"Behavior when the trial ends (CONVERT_TO_PAID or CANCEL_SUBSCRIPTION)","uniqueKey":"data.defaultTrialConfig.oneOf.0.trialEndBehavior.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.defaultTrialConfig.oneOf.0.trialEndBehavior","typeLabel":"enum\u003cstring> | null"}},"required":["duration","units"],"title":"DefaultTrialConfig","description":"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.","isRequired":true,"uniqueKey":"data.defaultTrialConfig.oneOf.0","typeLabel":"DefaultTrialConfig · object"},{"type":"null","properties":{"duration":{"type":"number","description":"The duration of the trial in the specified units"},"units":{"type":"string","enum":["DAY","MONTH"],"description":"The time unit for the trial duration (DAY or MONTH)"},"budget":{"oneOf":[{"type":"object","properties":{"limit":{"type":"number","description":"The budget limit amount"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget limit is a soft limit (allows overage) or hard limit"}},"required":["limit","hasSoftLimit"],"title":"BudgetConfiguration","description":"Budget configuration for the trial"},{"type":"null","properties":{"limit":{"type":"number","description":"The budget limit amount"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget limit is a soft limit (allows overage) or hard limit"}},"required":["limit","hasSoftLimit"],"title":"BudgetConfiguration","description":"Budget configuration for the trial"}]},"trialEndBehavior":{"oneOf":[{"type":"string","enum":["CONVERT_TO_PAID","CANCEL_SUBSCRIPTION"],"description":"Behavior when the trial ends (CONVERT_TO_PAID or CANCEL_SUBSCRIPTION)"},{"type":"null","enum":["CONVERT_TO_PAID","CANCEL_SUBSCRIPTION"],"description":"Behavior when the trial ends (CONVERT_TO_PAID or CANCEL_SUBSCRIPTION)"}]}},"required":["duration","units"],"title":"DefaultTrialConfig","description":"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.","isRequired":true,"uniqueKey":"data.defaultTrialConfig.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.defaultTrialConfig","typeLabel":"DefaultTrialConfig · object | null"},"compatibleAddonIds":{"oneOf":[{"type":"array","items":{"type":"string","maxLength":255,"description":"List of compatible addon IDs for this plan","uniqueKey":"data.compatibleAddonIds.oneOf.0.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"data.compatibleAddonIds.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","maxLength":255,"description":"List of compatible addon IDs for this plan"},"isRequired":true,"uniqueKey":"data.compatibleAddonIds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.compatibleAddonIds","typeLabel":"string[] | null"}},"required":["id","displayName","description","productId","status","pricingType","billingId","versionNumber","isLatest","entitlements","metadata","createdAt","updatedAt","parentPlanId","defaultTrialConfig","compatibleAddonIds"],"title":"Plan","description":"Plan configuration object","isRequired":true,"uniqueKey":"data","typeLabel":"Plan · object"}},"required":["data"],"title":"Response","description":"Response object","uniqueKey":"","typeLabel":"Response · object"},"examples":{"default":{"title":"default","value":{"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":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"ebc95485-0c84-4fc8-a94e-64e705d75bb3":{"description":"bad request.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","enum":["BadUserInput","EnvironmentMismatch","BillingContractOperationRejected","DuplicateIntegrationNotAllowed","EntityIsArchivedError","IntegrityViolation","FreePlanCantHaveCompatiblePackageGroupError","SubscriptionMustHaveSinglePlanError","AddonIsCompatibleWithPlan","AddonIsCompatibleWithGroup","DuplicateAddonProvisionedError","ScheduledMigrationAlreadyExistsError","SubscriptionAlreadyOnLatestPlan","EntityIdDifferentFromRefIdError","UnsupportedFeatureType","UnsupportedVendorIdentifier","UnsupportedSubscriptionScheduleType","InvalidEntitlementResetPeriod","IncompatibleSubscriptionAddon","UnPublishedPackage","MeteringNotAvailableForFeatureType","AuthCustomerMismatch","AuthCustomerReadonly","FetchAllCountriesPricesNotAllowed","MemberInvitationError","PlansCircularDependencyError","NoFeatureEntitlementInSubscription","CheckoutIsNotSupported","UnsupportedParameter","PricingModelNotSupportedByBillingIntegration","BillingIntegrationMissing","BillingIntegrationAlreadyExistsError","InvalidMemberDelete","PackageAlreadyPublished","DraftPlanCantBeArchived","DraftAddonCantBeArchived","PlanWithChildCantBeDeleted","PlanCannotBePublishWhenBasePlanIsDraft","PlanCannotBePublishWhenCompatibleAddonIsDraft","PlanIsUsedAsDefaultStartPlan","PlanIsUsedAsDowngradePlan","InvalidAddressError","InvalidQuantity","BillingPeriodMissingError","DowngradeBillingPeriodNotSupportedError","CustomerAlreadyUsesCouponError","CustomerAlreadyHaveCustomerCoupon","SubscriptionAlreadyCanceledOrExpired","TrialMustBeCancelledImmediately","SubscriptionDoesNotHaveBillingPeriod","InvalidCancellationDate","FailedToImportCustomer","FailedToImportSubscriptions","PackagePricingTypeNotSet","InvalidSubscriptionStatus","InvalidArgumentError","EditAllowedOnDraftPackageOnlyError","ResyncAlreadyInProgress","ArchivedCouponCantBeApplied","ImportAlreadyInProgress","AddonHasToHavePriceError","SelectedBillingModelDoesntMatchImportedItemError","CannotArchiveProductError","CannotUnarchiveProductError","CannotDeleteCustomerError","CannotRemovePaymentMethodFromCustomerError","CannotDeleteFeatureError","CannotArchiveFeatureError","InvalidUpdatePriceUnitAmountError","ExperimentAlreadyRunning","ExperimentStatusError","OperationNotAllowedDuringInProgressExperiment","EntitlementsMustBelongToSamePackage","CanNotUpdateEntitlementsFeatureGroup","MeterMustBeAssociatedToMeteredFeature","CannotUpdateMeterOfFeatureInUse","CannotEditPackageInNonDraftMode","CannotAddOverrideEntitlementToPlan","MissingEntityIdError","NoProductsAvailable","PromotionCodeNotForCustomer","PromotionCodeNotActive","PromotionCodeMaxRedemptionsReached","PromotionCodeMinimumAmountNotReached","PromotionCodeCustomerNotFirstPurchase","AddonWithDraftCannotBeDeletedError","CannotReportUsageForEntitlementWithMeterError","RecalculateEntitlementsError","ImportSubscriptionsBulkError","InvalidMetadataError","CannotUpsertToPackageThatHasDraft","IntegrationValidationError","AwsMarketplaceIntegrationValidationError","AwsMarketplaceIntegrationError","DataExportIntegrationError","HubspotIntegrationError","DuplicateProductValidationError","AmountTooLarge","CustomerHasNoEmailAddress","MergeEnvironmentValidationError","EntitlementUsageOutOfRangeError","UsageMeasurementDiffOutOfRangeError","AddonQuantityExceedsLimitError","AddonDependencyMissingError","PackageGroupMinItemsError","CannotUpdateUnitTransformationError","SingleSubscriptionCantBeAutoCancellationTargetError","MultiSubscriptionCantBeAutoCancellationSourceError","ChangingPayingCustomerIsNotSupportedError","RequiredSsoAuthenticationError","InvalidDoggoSignatureError","InvalidReceivedSignatureError","CannotDeleteDefaultIntegration","CannotChangeBillingIntegration","FailedToResolveBillingIntegration","WorkflowTriggerNotFound","DeprecatedEstimateSubscriptionError","FeatureConfigurationExceededLimitError","FeatureNotBelongToFeatureGroupError","FeatureGroupMissingFeaturesError","VersionExceedsMaxValueError","CannotUpdateExpireAtForExpiredCreditGrantError","ExpireAtMustBeLaterThanEffectiveAtError","OfferAlreadyExists","DraftAlreadyExists","CreditGrantAlreadyVoided","CreditGrantCannotBeVoided","FeatureNotEnabled","InvalidTaxId","ObjectAlreadyBeingUsedByAnotherRequestError","TooManySubscriptionsPerCustomer","TooManyCustomCurrencies","StripeError","SchedulingAtEndOfBillingPeriod","ApiKeyExpired","ApiKeyHasExpiry","OveragePriceNotSupportedOnAddon","OveragePriceRequiresUsageLimit","InvalidCreditOverageBillingModel","CreditOveragePriceCurrencyNotFound","InvoicePreviewNotAvailableForDraftContract"],"isRequired":true,"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["BadUserInput","EnvironmentMismatch","BillingContractOperationRejected","DuplicateIntegrationNotAllowed","EntityIsArchivedError","IntegrityViolation","FreePlanCantHaveCompatiblePackageGroupError","SubscriptionMustHaveSinglePlanError","AddonIsCompatibleWithPlan","AddonIsCompatibleWithGroup","DuplicateAddonProvisionedError","ScheduledMigrationAlreadyExistsError","SubscriptionAlreadyOnLatestPlan","EntityIdDifferentFromRefIdError","UnsupportedFeatureType","UnsupportedVendorIdentifier","UnsupportedSubscriptionScheduleType","InvalidEntitlementResetPeriod","IncompatibleSubscriptionAddon","UnPublishedPackage","MeteringNotAvailableForFeatureType","AuthCustomerMismatch","AuthCustomerReadonly","FetchAllCountriesPricesNotAllowed","MemberInvitationError","PlansCircularDependencyError","NoFeatureEntitlementInSubscription","CheckoutIsNotSupported","UnsupportedParameter","PricingModelNotSupportedByBillingIntegration","BillingIntegrationMissing","BillingIntegrationAlreadyExistsError","InvalidMemberDelete","PackageAlreadyPublished","DraftPlanCantBeArchived","DraftAddonCantBeArchived","PlanWithChildCantBeDeleted","PlanCannotBePublishWhenBasePlanIsDraft","PlanCannotBePublishWhenCompatibleAddonIsDraft","PlanIsUsedAsDefaultStartPlan","PlanIsUsedAsDowngradePlan","InvalidAddressError","InvalidQuantity","BillingPeriodMissingError","DowngradeBillingPeriodNotSupportedError","CustomerAlreadyUsesCouponError","CustomerAlreadyHaveCustomerCoupon","SubscriptionAlreadyCanceledOrExpired","TrialMustBeCancelledImmediately","SubscriptionDoesNotHaveBillingPeriod","InvalidCancellationDate","FailedToImportCustomer","FailedToImportSubscriptions","PackagePricingTypeNotSet","InvalidSubscriptionStatus","InvalidArgumentError","EditAllowedOnDraftPackageOnlyError","ResyncAlreadyInProgress","ArchivedCouponCantBeApplied","ImportAlreadyInProgress","AddonHasToHavePriceError","SelectedBillingModelDoesntMatchImportedItemError","CannotArchiveProductError","CannotUnarchiveProductError","CannotDeleteCustomerError","CannotRemovePaymentMethodFromCustomerError","CannotDeleteFeatureError","CannotArchiveFeatureError","InvalidUpdatePriceUnitAmountError","ExperimentAlreadyRunning","ExperimentStatusError","OperationNotAllowedDuringInProgressExperiment","EntitlementsMustBelongToSamePackage","CanNotUpdateEntitlementsFeatureGroup","MeterMustBeAssociatedToMeteredFeature","CannotUpdateMeterOfFeatureInUse","CannotEditPackageInNonDraftMode","CannotAddOverrideEntitlementToPlan","MissingEntityIdError","NoProductsAvailable","PromotionCodeNotForCustomer","PromotionCodeNotActive","PromotionCodeMaxRedemptionsReached","PromotionCodeMinimumAmountNotReached","PromotionCodeCustomerNotFirstPurchase","AddonWithDraftCannotBeDeletedError","CannotReportUsageForEntitlementWithMeterError","RecalculateEntitlementsError","ImportSubscriptionsBulkError","InvalidMetadataError","CannotUpsertToPackageThatHasDraft","IntegrationValidationError","AwsMarketplaceIntegrationValidationError","AwsMarketplaceIntegrationError","DataExportIntegrationError","HubspotIntegrationError","DuplicateProductValidationError","AmountTooLarge","CustomerHasNoEmailAddress","MergeEnvironmentValidationError","EntitlementUsageOutOfRangeError","UsageMeasurementDiffOutOfRangeError","AddonQuantityExceedsLimitError","AddonDependencyMissingError","PackageGroupMinItemsError","CannotUpdateUnitTransformationError","SingleSubscriptionCantBeAutoCancellationTargetError","MultiSubscriptionCantBeAutoCancellationSourceError","ChangingPayingCustomerIsNotSupportedError","RequiredSsoAuthenticationError","InvalidDoggoSignatureError","InvalidReceivedSignatureError","CannotDeleteDefaultIntegration","CannotChangeBillingIntegration","FailedToResolveBillingIntegration","WorkflowTriggerNotFound","DeprecatedEstimateSubscriptionError","FeatureConfigurationExceededLimitError","FeatureNotBelongToFeatureGroupError","FeatureGroupMissingFeaturesError","VersionExceedsMaxValueError","CannotUpdateExpireAtForExpiredCreditGrantError","ExpireAtMustBeLaterThanEffectiveAtError","OfferAlreadyExists","DraftAlreadyExists","CreditGrantAlreadyVoided","CreditGrantCannotBeVoided","FeatureNotEnabled","InvalidTaxId","ObjectAlreadyBeingUsedByAnotherRequestError","TooManySubscriptionsPerCustomer","TooManyCustomCurrencies","StripeError","SchedulingAtEndOfBillingPeriod","ApiKeyExpired","ApiKeyHasExpiry","OveragePriceNotSupportedOnAddon","OveragePriceRequiresUsageLimit","InvalidCreditOverageBillingModel","CreditOveragePriceCurrencyNotFound","InvoicePreviewNotAvailableForDraftContract"],"isRequired":true,"uniqueKey":"code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring> | null"},"reason":{"type":"string","maxLength":255,"description":"The billing side's machine-readable code for a billing-contract refusal. Present only when the code is BillingContractOperationRejected and the refusal carried one.","uniqueKey":"reason","typeLabel":"string"}},"required":["message","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"BadUserInput","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"5f4eadc4-906e-4415-b1b1-decbb465dad4":{"description":"User is not authenticated.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","enum":["Unauthenticated"],"isRequired":true,"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["Unauthenticated"],"isRequired":true,"uniqueKey":"code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring> | null"}},"required":["message","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"Unauthenticated"}}},"exampleType":"generated"}},"exampleType":"generated"},"c96d8dcf-7fbc-4f90-8bcd-bb46d2a5b94a":{"description":"User is not allowed to access this resource.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","enum":["IdentityForbidden","AccessDeniedError","NoFeatureEntitlementError","EntitlementLimitExceededError","GovernanceNotEnabled"],"isRequired":true,"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["IdentityForbidden","AccessDeniedError","NoFeatureEntitlementError","EntitlementLimitExceededError","GovernanceNotEnabled"],"isRequired":true,"uniqueKey":"code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring> | null"}},"required":["message","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"IdentityForbidden"}}},"exampleType":"generated"}},"exampleType":"generated"},"4c59a476-e8d7-4020-87cf-98448a4df23e":{"description":"Plan not found.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","enum":["CustomerNotFound","CustomCurrencyNotFound","CreditGrantNotFound","ReservationNotFound","ContractNotFound","InvoiceNotFound","MemberNotFound","PackageGroupNotFound","AddonNotFound","AddonsNotFound","EnvironmentMissing","IntegrationNotFound","VendorIsNotSupported","CouponNotFound","FutureUpdateNotFound","CustomerNoBillingId","SubscriptionNoBillingId","StripeCustomerIsDeleted","InitStripePaymentMethodError","PreparePaymentMethodFormError","AccountNotFoundError","ExperimentNotFoundError","NoDraftOfferFound","PromotionCodeNotFound","FailedToCreateCheckoutSessionError","PaymentMethodNotFoundError","ProductNotFoundError","ProductNotPublishedError","MissingBillingInvoiceError","BillingInvoiceStatusError","FeatureGroupNotFoundError","CannotArchiveFeatureGroupError","OfferNotFound","CustomerResourceNotFound","FeatureNotFound","PriceNotFound","NoActiveSubscriptionForCustomer","PlanNotFound","PromotionalEntitlementNotFoundError","SubscriptionNotFound","ApiKeyNotFound"],"isRequired":true,"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["CustomerNotFound","CustomCurrencyNotFound","CreditGrantNotFound","ReservationNotFound","ContractNotFound","InvoiceNotFound","MemberNotFound","PackageGroupNotFound","AddonNotFound","AddonsNotFound","EnvironmentMissing","IntegrationNotFound","VendorIsNotSupported","CouponNotFound","FutureUpdateNotFound","CustomerNoBillingId","SubscriptionNoBillingId","StripeCustomerIsDeleted","InitStripePaymentMethodError","PreparePaymentMethodFormError","AccountNotFoundError","ExperimentNotFoundError","NoDraftOfferFound","PromotionCodeNotFound","FailedToCreateCheckoutSessionError","PaymentMethodNotFoundError","ProductNotFoundError","ProductNotPublishedError","MissingBillingInvoiceError","BillingInvoiceStatusError","FeatureGroupNotFoundError","CannotArchiveFeatureGroupError","OfferNotFound","CustomerResourceNotFound","FeatureNotFound","PriceNotFound","NoActiveSubscriptionForCustomer","PlanNotFound","PromotionalEntitlementNotFoundError","SubscriptionNotFound","ApiKeyNotFound"],"isRequired":true,"uniqueKey":"code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring> | null"}},"required":["message","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"CustomerNotFound"}}},"exampleType":"generated"}},"exampleType":"generated"},"a9414aea-adc1-4834-a232-5cf74a9a0431":{"description":"Too many requests.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","enum":["RateLimitExceeded"],"isRequired":true,"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["RateLimitExceeded"],"isRequired":true,"uniqueKey":"code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring> | null"}},"required":["message","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"RateLimitExceeded"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f6e9d2b7-2b82-4d7b-a20f-44e48e4fc008":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"Server API Key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"fd7bca2e-52e6-41a6-abe3-1c87d2d64523":{"url":"https://api.stigg.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"Server API Key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-KEY","type":"string","description":"Server API Key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-KEY"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi/stigg-api.documented.yml"},"subdomain":"stigg","siteName":"Stigg","title":"Update a plan - Stigg","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T11:33:09.221Z","originalFileLocation":"api-reference/plans/update-a-plan.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Updates an existing plan\u0026#x27;s properties such as display name, description, and metadata.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Stigg\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a plan - Stigg\">\u003cmeta data-mint-head property=\"og:description\" content=\"Updates an existing plan\u0026#x27;s properties such as display name, description, and metadata.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Stigg\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.stigg.io/api-reference/plans/update-a-plan\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://stigg.mintlify.app/_mintlify/api/og/v2?division=Plans\u0026amp;title=Update+a+plan\u0026amp;description=Updates+an+existing+plan%27s+properties+such+as+display+name%2C+description%2C+and+metadata.\u0026amp;theme=2f1adfbb069b3c699f8f4495\u0026amp;signature=3ff3e754e5fea98b8ebdc2d5588541a2da8c8e6e7f736ee8c24a953fd891a21d\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a plan - Stigg\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Updates an existing plan\u0026#x27;s properties such as display name, description, and metadata.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://stigg.mintlify.app/_mintlify/api/og/v2?division=Plans\u0026amp;title=Update+a+plan\u0026amp;description=Updates+an+existing+plan%27s+properties+such+as+display+name%2C+description%2C+and+metadata.\u0026amp;theme=2f1adfbb069b3c699f8f4495\u0026amp;signature=3ff3e754e5fea98b8ebdc2d5588541a2da8c8e6e7f736ee8c24a953fd891a21d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Stigg\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#436633\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.stigg.io/api-reference/plans/update-a-plan\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/plans/update-a-plan.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.stigg.io/#organization\",\"name\":\"Stigg\",\"url\":\"https://docs.stigg.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/stigg/HmCBL4eVQuHwqjnY/logo/light.svg?fit=max\u0026auto=format\u0026n=HmCBL4eVQuHwqjnY\u0026q=85\u0026s=8579b37d1f3d11f4198506c9e602caa3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.stigg.io#website\",\"name\":\"Stigg\",\"url\":\"https://docs.stigg.io\",\"publisher\":{\"@id\":\"https://docs.stigg.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.stigg.io/api-reference/plans/update-a-plan#webpage\",\"url\":\"https://docs.stigg.io/api-reference/plans/update-a-plan\",\"name\":\"Update a plan\",\"description\":\"Updates an existing plan's properties such as display name, description, and metadata.\",\"dateModified\":\"2026-10-29T11:33:09.221Z\",\"isPartOf\":{\"@id\":\"https://docs.stigg.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.stigg.io/api-reference/plans/update-a-plan#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.stigg.io/api-reference/plans/update-a-plan#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Plans\",\"item\":\"https://docs.stigg.io/api-reference/plans/get-a-list-of-plans\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update a plan\",\"item\":\"https://docs.stigg.io/api-reference/plans/update-a-plan\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.stigg.io/api-reference/plans/update-a-plan#apireference\",\"headline\":\"Update a plan\",\"name\":\"Update a plan\",\"description\":\"Updates an existing plan's properties such as display name, description, and metadata.\",\"url\":\"https://docs.stigg.io/api-reference/plans/update-a-plan\",\"mainEntityOfPage\":{\"@id\":\"https://docs.stigg.io/api-reference/plans/update-a-plan#webpage\"},\"dateModified\":\"2026-10-29T11:33:09.221Z\",\"publisher\":{\"@id\":\"https://docs.stigg.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.stigg.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Stigg\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Stigg","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/documentation/getting-started/welcome-to-stigg"}]},{"tab":"Guides","icon":"map","pages":[{"title":"Guides","href":"/guides/quick-start-guides/provisioning-customers"}]},{"tab":"API Reference","icon":"code","dropdowns":[{"dropdown":"Overview","icon":"compass","pages":[{"title":"API Reference","mode":"custom","href":"/api-and-sdks/api-reference/overview"}]},{"dropdown":"REST","icon":"server","groups":[{"group":"Get started","pages":[{"title":"Introduction","href":"/api-and-sdks/api-reference/rest/introduction"}]},{"group":"Essentials","pages":[{"title":"Authentication","href":"/api-and-sdks/api-reference/rest/authentication"},{"title":"Pagination","href":"/api-and-sdks/api-reference/rest/pagination"},{"title":"Responses","href":"/api-and-sdks/api-reference/rest/responses"},{"title":"Rate Limits","href":"/api-and-sdks/integration/rest/rate-limits"},{"title":"Access enforcement at scale","href":"/api-and-sdks/api-reference/rest/using-at-scale"}]},{"group":"SDK reference","pages":[{"title":"Backend","href":"/api-and-sdks/references/sdk/backend/rest/index"},{"title":"Agent SDK","href":"/api-and-sdks/references/sdk/backend/rest/agent-sdk"},{"group":"Frontend","pages":[{"title":"JavaScript SDK","href":"/api-and-sdks/references/sdk/frontend/javascript-rest"},{"title":"React SDK","href":"/api-and-sdks/references/sdk/frontend/react-rest"},{"title":"Vue.js SDK","href":"/api-and-sdks/references/sdk/frontend/vue-rest"},{"title":"Embed SDK","href":"/api-and-sdks/references/sdk/frontend/embed-rest"}]}]},{"group":"CLI reference","pages":[{"title":"CLI reference","href":"/api-and-sdks/cli-reference"}]},{"group":"SDK documentation","pages":[{"group":"Frontend","pages":[{"title":"JavaScript","href":"/api-and-sdks/integration/frontend/javascript"},{"title":"React","href":"/api-and-sdks/integration/frontend/react"},{"title":"Vue.js","href":"/api-and-sdks/integration/frontend/vuejs"},{"title":"Next.js","href":"/api-and-sdks/integration/frontend/nextjs"},{"title":"Webflow, Wordpress and plain HTML SDK","href":"/api-and-sdks/integration/frontend/html"},{"title":"Hardening client-side access","href":"/api-and-sdks/integration/frontend/hardening-client-side-access"}]}]},{"group":"Subscriptions","pages":[{"title":"Get a single subscription by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/subscriptions/{id}","href":"/api-reference/subscriptions/get-a-single-subscription-by-id"},{"title":"Update a subscription","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/subscriptions/{id}","href":"/api-reference/subscriptions/update-a-subscription"},{"title":"Get a list of subscriptions","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/subscriptions","href":"/api-reference/subscriptions/get-a-list-of-subscriptions"},{"title":"Provision subscription","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions","href":"/api-reference/subscriptions/provision-subscription"},{"title":"Transfer subscription to resource","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/transfer","href":"/api-reference/subscriptions/transfer-subscription-to-resource"},{"title":"Migrate subscription to latest plan version","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/migrate","href":"/api-reference/subscriptions/migrate-subscription-to-latest-plan-version"},{"title":"Delegate subscription payment to customer","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/delegate","href":"/api-reference/subscriptions/delegate-subscription-payment-to-customer"},{"title":"Cancel pending payment update","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/subscriptions/{id}/future-update/pending-payment","href":"/api-reference/subscriptions/cancel-pending-payment-update"},{"title":"Cancel scheduled update","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/subscriptions/{id}/future-update/schedule","href":"/api-reference/subscriptions/cancel-scheduled-update"},{"title":"Preview subscription","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/preview","href":"/api-reference/subscriptions/preview-subscription"},{"title":"Cancel subscription","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/cancel","href":"/api-reference/subscriptions/cancel-subscription"},{"title":"Charge subscription usage","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/usage/charge","href":"/api-reference/subscriptions/charge-subscription-usage"},{"title":"Trigger subscription usage sync","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/usage/sync","href":"/api-reference/subscriptions/trigger-subscription-usage-sync"},{"title":"Mark subscription invoice as paid","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/invoice/paid","href":"/api-reference/subscriptions/mark-subscription-invoice-as-paid"}]},{"group":"Bulk Import","pages":[{"title":"Bulk import subscriptions","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/import","href":"/api-reference/bulk-import/bulk-import-subscriptions"},{"title":"Bulk import customers","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/import","href":"/api-reference/bulk-import/bulk-import-customers"}]},{"group":"Usage","pages":[{"title":"Get usage history","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/usage/{customerId}/history/{featureId}","href":"/api-reference/usage/get-usage-history"},{"title":"Report usage events","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/events","href":"/api-reference/usage/report-usage-events"},{"title":"Estimate event credit cost","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/events/estimate","href":"/api-reference/usage/estimate-event-credit-cost"},{"title":"Report usage measurements","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/usage","href":"/api-reference/usage/report-usage-measurements"},{"title":"Estimate usage credit cost","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/usage/estimate","href":"/api-reference/usage/estimate-usage-credit-cost"},{"title":"Report usage measurements (v2)","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v2/usage","href":"/api-reference/usage/report-usage-measurements-v2"}]},{"group":"Coupons","pages":[{"title":"Get a list of coupons","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/coupons","href":"/api-reference/coupons/get-a-list-of-coupons"},{"title":"Create coupon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/coupons","href":"/api-reference/coupons/create-coupon"},{"title":"Get a single coupon by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/coupons/{id}","href":"/api-reference/coupons/get-a-single-coupon-by-id"},{"title":"Update a coupon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/coupons/{id}","href":"/api-reference/coupons/update-a-coupon"},{"title":"Archive coupon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/coupons/{id}/archive","href":"/api-reference/coupons/archive-coupon"}]},{"group":"Products","pages":[{"title":"Get a list of products","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/products","href":"/api-reference/products/get-a-list-of-products"},{"title":"Create product","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/products","href":"/api-reference/products/create-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/products/{id}","href":"/api-reference/products/update-a-product"},{"title":"Archive product","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/products/{id}/archive","href":"/api-reference/products/archive-product"},{"title":"Unarchive product","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/products/{id}/unarchive","href":"/api-reference/products/unarchive-product"},{"title":"Duplicate product","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/products/{id}/duplicate","href":"/api-reference/products/duplicate-product"}]},{"group":"Features","pages":[{"title":"Get a single feature by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/features/{id}","href":"/api-reference/features/get-a-single-feature-by-id"},{"title":"Update a feature","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/features/{id}","href":"/api-reference/features/update-a-feature"},{"title":"Get a list of features","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/features","href":"/api-reference/features/get-a-list-of-features"},{"title":"Create a feature","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/features","href":"/api-reference/features/create-a-feature"},{"title":"Archive feature","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/features/{id}/archive","href":"/api-reference/features/archive-feature"},{"title":"Unarchive feature","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/features/{id}/unarchive","href":"/api-reference/features/unarchive-feature"}]},{"group":"Addons","pages":[{"title":"Get a list of addons","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/addons","href":"/api-reference/addons/get-a-list-of-addons"},{"title":"Create an addon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/addons","href":"/api-reference/addons/create-an-addon"},{"title":"Get a single addon by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/addons/{id}","href":"/api-reference/addons/get-a-single-addon-by-id"},{"title":"Update a addon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/addons/{id}","href":"/api-reference/addons/update-a-addon"},{"title":"Archive an addon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/addons/{id}/archive","href":"/api-reference/addons/archive-an-addon"},{"title":"List addon charges","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/addons/{id}/charges","href":"/api-reference/addons/list-addon-charges"},{"title":"Create addon draft","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/addons/{id}/draft","href":"/api-reference/addons/create-addon-draft"},{"title":"Remove addon draft","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/addons/{id}/draft","href":"/api-reference/addons/remove-addon-draft"},{"title":"Publish addon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/addons/{id}/publish","href":"/api-reference/addons/publish-addon"}]},{"group":"Plans","pages":[{"title":"Get a list of plans","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/plans","href":"/api-reference/plans/get-a-list-of-plans"},{"title":"Create plan","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/plans","href":"/api-reference/plans/create-plan"},{"title":"Get a single plan by ID","description":"Retrieves a plan by its unique identifier, including entitlements and pricing details.","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/plans/{id}","href":"/api-reference/plans/get-a-single-plan-by-id"},{"title":"Update a plan","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/plans/{id}","href":"/api-reference/plans/update-a-plan"},{"title":"Archive plan","description":"Archives a plan, preventing it from being used in new subscriptions.","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/plans/{id}/archive","href":"/api-reference/plans/archive-plan"},{"title":"List plan charges","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/plans/{id}/charges","href":"/api-reference/plans/list-plan-charges"},{"title":"List plan overage charges","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/plans/{id}/overage-charges","href":"/api-reference/plans/list-plan-overage-charges"},{"title":"Create plan draft","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/plans/{id}/draft","href":"/api-reference/plans/create-plan-draft"},{"title":"Remove plan draft","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/plans/{id}/draft","href":"/api-reference/plans/remove-plan-draft"},{"title":"Publish plan","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/plans/{id}/publish","href":"/api-reference/plans/publish-plan"}]},{"group":"Promotional Entitlements","pages":[{"title":"Get a list of promotional entitlements","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/promotional-entitlements","href":"/api-reference/promotional-entitlements/get-a-list-of-promotional-entitlements"},{"title":"Create a promotional entitlements","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/{id}/promotional-entitlements","href":"/api-reference/promotional-entitlements/create-a-promotional-entitlements"},{"title":"Revoke promotional entitlement","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/customers/{id}/promotional-entitlements/{featureId}","href":"/api-reference/promotional-entitlements/revoke-promotional-entitlement"}]},{"group":"Customers","pages":[{"title":"Get a list of customer resources","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/resources","href":"/api-reference/customers/get-a-list-of-customer-resources"},{"title":"Get a single customer by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}","href":"/api-reference/customers/get-a-single-customer-by-id"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/customers/{id}","href":"/api-reference/customers/update-a-customer"},{"title":"Get a list of customers","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers","href":"/api-reference/customers/get-a-list-of-customers"},{"title":"Provision customer","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers","href":"/api-reference/customers/provision-customer"},{"title":"Archive customer","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/{id}/archive","href":"/api-reference/customers/archive-customer"},{"title":"Unarchive customer","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/{id}/unarchive","href":"/api-reference/customers/unarchive-customer"},{"title":"Attach payment method","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/{id}/payment-method","href":"/api-reference/customers/attach-payment-method"},{"title":"Detach payment method","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/customers/{id}/payment-method","href":"/api-reference/customers/detach-payment-method"}]},{"group":"Customer Integrations","pages":[{"title":"Get a list of customer integrations","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/integrations","href":"/api-reference/customer-integrations/get-a-list-of-customer-integrations"},{"title":"Link customer integration","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/{id}/integrations","href":"/api-reference/customer-integrations/link-customer-integration"},{"title":"Get a single customer integration by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/integrations/{integrationId}","href":"/api-reference/customer-integrations/get-a-single-customer-integration-by-id"},{"title":"Unlink customer integration","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/customers/{id}/integrations/{integrationId}","href":"/api-reference/customer-integrations/unlink-customer-integration"},{"title":"Update a customer integration","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/customers/{id}/integrations/{integrationId}","href":"/api-reference/customer-integrations/update-a-customer-integration"}]},{"group":"Data Export","pages":[{"title":"Add data-export destination","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/data-export/destinations","href":"/api-reference/data-export/add-data-export-destination"},{"title":"Remove data-export destination","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/data-export/destinations/{destinationId}","href":"/api-reference/data-export/remove-data-export-destination"},{"title":"Update data-export destination selection","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/data-export/destinations/{destinationId}","href":"/api-reference/data-export/update-data-export-destination-selection"},{"title":"Trigger data-export sync","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/data-export/sync","href":"/api-reference/data-export/trigger-data-export-sync"},{"title":"List data-export models","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/data-export/models","href":"/api-reference/data-export/list-data-export-models"}]},{"group":"Entitlements","pages":[{"title":"Get entitlements state","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/entitlements","href":"/api-reference/entitlements/get-entitlements-state"},{"title":"Check entitlement","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/entitlements/check","href":"/api-reference/entitlements/check-entitlement"}]},{"group":"Plan Entitlements","pages":[{"title":"Get a list of plan entitlements","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/plans/{planId}/entitlements","href":"/api-reference/plan-entitlements/get-a-list-of-plan-entitlements"},{"title":"Create plan entitlements","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/plans/{planId}/entitlements","href":"/api-reference/plan-entitlements/create-plan-entitlements"},{"title":"Delete plan entitlement","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/plans/{planId}/entitlements/{id}","href":"/api-reference/plan-entitlements/delete-plan-entitlement"},{"title":"Update a plan entitlement","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/plans/{planId}/entitlements/{id}","href":"/api-reference/plan-entitlements/update-a-plan-entitlement"}]},{"group":"Addon Entitlements","pages":[{"title":"Get a list of addon entitlements","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/addons/{addonId}/entitlements","href":"/api-reference/addon-entitlements/get-a-list-of-addon-entitlements"},{"title":"Create addon entitlements","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/addons/{addonId}/entitlements","href":"/api-reference/addon-entitlements/create-addon-entitlements"},{"title":"Delete addon entitlement","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/addons/{addonId}/entitlements/{id}","href":"/api-reference/addon-entitlements/delete-addon-entitlement"},{"title":"Update a addon entitlement","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/addons/{addonId}/entitlements/{id}","href":"/api-reference/addon-entitlements/update-a-addon-entitlement"}]},{"group":"Credit grants","pages":[{"title":"Get a list of credit grants","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/credits/grants","href":"/api-reference/credit-grants/get-a-list-of-credit-grants"},{"title":"Create a credit grant","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/grants","href":"/api-reference/credit-grants/create-a-credit-grant"},{"title":"Void credit grant","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/grants/{id}/void","href":"/api-reference/credit-grants/void-credit-grant"}]},{"group":"Credit consumption","pages":[{"title":"Consume credits","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/consumption","href":"/api-reference/credit-consumption/consume-credits"},{"title":"Consume credits asynchronously","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/consumption/async","href":"/api-reference/credit-consumption/consume-credits-asynchronously"}]},{"group":"Credit reservations","pages":[{"title":"Release a credit reservation","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/reservations/{reservationId}/release","href":"/api-reference/credit-reservations/release-a-credit-reservation"}]},{"group":"Credit usage","pages":[{"title":"Get credit usage","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/credits/usage","href":"/api-reference/credit-usage/get-credit-usage"}]},{"group":"Auto recharge","pages":[{"title":"Get automatic recharge configuration","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/credits/auto-recharge","href":"/api-reference/auto-recharge/get-automatic-recharge-configuration"}]},{"group":"Custom currencies","pages":[{"title":"Get a list of custom currencys","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/credits/custom-currencies","href":"/api-reference/custom-currencies/get-a-list-of-custom-currencys"},{"title":"Create custom currency","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/custom-currencies","href":"/api-reference/custom-currencies/create-custom-currency"},{"title":"Update custom currency","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/credits/custom-currencies/{currencyId}","href":"/api-reference/custom-currencies/update-custom-currency"},{"title":"Archive custom currency","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/custom-currencies/{currencyId}/archive","href":"/api-reference/custom-currencies/archive-custom-currency"},{"title":"Unarchive custom currency","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/custom-currencies/{currencyId}/unarchive","href":"/api-reference/custom-currencies/unarchive-custom-currency"},{"title":"List custom currency associated entities","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/credits/custom-currencies/{currencyId}/associated-entities","href":"/api-reference/custom-currencies/list-custom-currency-associated-entities"}]},{"group":"Credit ledger","pages":[{"title":"Get a list of credit ledger events","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/credits/ledger","href":"/api-reference/credit-ledger/get-a-list-of-credit-ledger-events"}]},{"group":"Contracts","pages":[{"title":"Get a list of contracts","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts","href":"/api-reference/contracts/get-a-list-of-contracts"},{"title":"Create contract","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts","href":"/api-reference/contracts/create-contract"},{"title":"List pricing models","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts/pricing-models","href":"/api-reference/contracts/list-pricing-models"},{"title":"List legal entities","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts/legal-entities","href":"/api-reference/contracts/list-legal-entities"},{"title":"Get a single contract by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts/{id}","href":"/api-reference/contracts/get-a-single-contract-by-id"},{"title":"Update a contract","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/contracts/{id}","href":"/api-reference/contracts/update-a-contract"},{"title":"Delete contract","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/archive","href":"/api-reference/contracts/delete-contract"},{"title":"Add contract line items","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/billing/items","href":"/api-reference/contracts/add-contract-line-items"},{"title":"Delete contract line item","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/contracts/{id}/billing/items/{itemRef}","href":"/api-reference/contracts/delete-contract-line-item"},{"title":"Update contract line item rows","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/contracts/{id}/billing/items/{itemRef}","href":"/api-reference/contracts/update-contract-line-item-rows"},{"title":"Delete contract line item row","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/contracts/{id}/billing/items/{itemRef}/rows/{rowIndex}","href":"/api-reference/contracts/delete-contract-line-item-row"},{"title":"Set contract billing terms","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/contracts/{id}/billing/terms","href":"/api-reference/contracts/set-contract-billing-terms"},{"title":"Set contract billing settings","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/contracts/{id}/billing/settings","href":"/api-reference/contracts/set-contract-billing-settings"},{"title":"List contract credit notes","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts/{id}/billing/credit-notes","href":"/api-reference/contracts/list-contract-credit-notes"},{"title":"Get contract invoice schedule","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts/{id}/billing/invoice-schedule","href":"/api-reference/contracts/get-contract-invoice-schedule"},{"title":"Get contract billing summary","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts/{id}/billing/summary","href":"/api-reference/contracts/get-contract-billing-summary"},{"title":"Publish contract billing","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/billing/publish","href":"/api-reference/contracts/publish-contract-billing"},{"title":"Edit contract billing in place","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/billing/edit-active","href":"/api-reference/contracts/edit-contract-billing-in-place"},{"title":"Attach subscriptions to contract","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/subscriptions","href":"/api-reference/contracts/attach-subscriptions-to-contract"},{"title":"Detach subscription from contract","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/contracts/{id}/subscriptions/{subscriptionId}","href":"/api-reference/contracts/detach-subscription-from-contract"},{"title":"Refresh contract usage","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/usage/refresh","href":"/api-reference/contracts/refresh-contract-usage"},{"title":"List customer contracts","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/contracts","href":"/api-reference/contracts/list-customer-contracts"}]},{"group":"Invoices","pages":[{"title":"Get a list of invoices","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/invoices","href":"/api-reference/invoices/get-a-list-of-invoices"},{"title":"Get a single invoice by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/invoices/{invoiceRef}","href":"/api-reference/invoices/get-a-single-invoice-by-id"},{"title":"Generate invoice PDF","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/{id}/invoices/{invoiceRef}/pdf/generate","href":"/api-reference/invoices/generate-invoice-pdf"},{"title":"Get invoice PDF status","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/invoices/{invoiceRef}/pdf/status","href":"/api-reference/invoices/get-invoice-pdf-status"},{"title":"Download invoice PDF","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/invoices/{invoiceRef}/pdf","href":"/api-reference/invoices/download-invoice-pdf"},{"title":"Mark invoice as paid","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/{id}/invoices/{invoiceRef}/paid","href":"/api-reference/invoices/mark-invoice-as-paid"},{"title":"Issue credit note","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/{id}/invoices/{invoiceRef}/credit-note","href":"/api-reference/invoices/issue-credit-note"}]},{"group":"Governance Entity Types","pages":[{"title":"Get a list of entity types","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/entity-types","href":"/api-reference/governance-entity-types/get-a-list-of-entity-types"},{"title":"Upsert entity types","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1-beta/entity-types","href":"/api-reference/governance-entity-types/upsert-entity-types"},{"title":"Archive entity types","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1-beta/entity-types/archive","href":"/api-reference/governance-entity-types/archive-entity-types"},{"title":"Check whether an entity type has active entities","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/entity-types/{id}/has-active-entities","href":"/api-reference/governance-entity-types/check-whether-an-entity-type-has-active-entities"}]},{"group":"Governance Entities","pages":[{"title":"Get a list of entitys","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/entities","href":"/api-reference/governance-entities/get-a-list-of-entitys"},{"title":"Upsert entities","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1-beta/customers/{id}/entities","href":"/api-reference/governance-entities/upsert-entities"},{"title":"Get a single entity by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/entities/{entityId}","href":"/api-reference/governance-entities/get-a-single-entity-by-id"},{"title":"Archive entities","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1-beta/customers/{id}/entities/archive","href":"/api-reference/governance-entities/archive-entities"},{"title":"Unarchive entities","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1-beta/customers/{id}/entities/unarchive","href":"/api-reference/governance-entities/unarchive-entities"}]},{"group":"Governance Assignments","pages":[{"title":"Get a list of assignments","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/assignments","href":"/api-reference/governance-assignments/get-a-list-of-assignments"},{"title":"Upsert assignments","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1-beta/customers/{id}/assignments","href":"/api-reference/governance-assignments/upsert-assignments"}]},{"group":"Governance Hierarchy","pages":[{"title":"Get a list of governance nodes","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/governance","href":"/api-reference/governance-hierarchy/get-a-list-of-governance-nodes"}]},{"group":"Governance Entitlements Check","pages":[{"title":"Check entitlement (beta)","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/entitlements/check","href":"/api-reference/governance-entitlements-check/check-entitlement-beta"}]}]},{"dropdown":"GraphQL","icon":"diagram-project","groups":[{"group":"Get started","pages":[{"title":"Introduction","href":"/api-and-sdks/api-reference/graphql/introduction"}]},{"group":"Essentials","pages":[{"title":"Authentication","href":"/api-and-sdks/api-reference/graphql/authentication"},{"title":"Rate Limits","href":"/api-and-sdks/integration/graphql/rate-limits"},{"title":"Access enforcement at scale","href":"/api-and-sdks/api-reference/graphql/using-at-scale"}]},{"group":"SDK reference","pages":[{"group":"Backend","pages":[{"title":"Node.js SDK","href":"/api-and-sdks/references/sdk/backend/graphql/node"},{"title":"Python SDK","href":"/api-and-sdks/references/sdk/backend/graphql/python"},{"title":"Go SDK","href":"/api-and-sdks/references/sdk/backend/graphql/go"},{"title":"Java SDK","href":"/api-and-sdks/references/sdk/backend/graphql/java"},{"title":"Ruby SDK","href":"/api-and-sdks/references/sdk/backend/graphql/ruby"},{"title":".NET SDK","href":"/api-and-sdks/references/sdk/backend/graphql/dotnet"},{"title":"Sidecar SDK","href":"/api-and-sdks/references/sdk/backend/graphql/sidecar"}]},{"title":"Agent SDK","href":"/api-and-sdks/references/sdk/backend/graphql/agent-sdk"},{"group":"Frontend","pages":[{"title":"JavaScript SDK","href":"/api-and-sdks/references/sdk/frontend/javascript"},{"title":"React SDK","href":"/api-and-sdks/references/sdk/frontend/react"},{"title":"Vue.js SDK","href":"/api-and-sdks/references/sdk/frontend/vue"},{"title":"Embed SDK","href":"/api-and-sdks/references/sdk/frontend/embed"}]}]},{"group":"SDK documentation","pages":[{"group":"Backend","pages":[{"title":"Backend","href":"/api-and-sdks/integration/backend"},{"title":"Customer management","href":"/api-and-sdks/integration/backend/customers"},{"title":"Subscription management","href":"/api-and-sdks/integration/backend/subscriptions"},{"title":"Entitlement checks","href":"/api-and-sdks/integration/backend/entitlements"},{"title":"Usage, billing \u0026 credits","href":"/api-and-sdks/integration/backend/usage-and-billing"},{"title":"Sidecar","href":"/api-and-sdks/integration/backend/sidecar"}]},{"group":"Frontend","pages":[{"title":"JavaScript","href":"/api-and-sdks/integration/frontend/javascript"},{"title":"React","href":"/api-and-sdks/integration/frontend/react"},{"title":"Vue.js","href":"/api-and-sdks/integration/frontend/vuejs"},{"title":"Next.js","href":"/api-and-sdks/integration/frontend/nextjs"},{"title":"Webflow, Wordpress and plain HTML SDK","href":"/api-and-sdks/integration/frontend/html"},{"title":"Hardening client-side access","href":"/api-and-sdks/integration/frontend/hardening-client-side-access"}]}]},{"group":"API reference","pages":[{"title":"Apollo Studio","href":"/api-and-sdks/api-reference/graphql/reference"}]}]},{"dropdown":"Webhooks","icon":"webhook","groups":[{"group":"Get started","pages":[{"title":"Webhook Events","href":"/api-and-sdks/api-reference/webhooks/events"}]},{"group":"Products","pages":[{"title":"Product created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook product.created","href":"/api-reference/products/product-created"},{"title":"Product updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook product.updated","href":"/api-reference/products/product-updated"},{"title":"Product deleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook product.deleted","href":"/api-reference/products/product-deleted"}]},{"group":"Plans","pages":[{"title":"Plan created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook plan.created","href":"/api-reference/plans/plan-created"},{"title":"Plan updated new version published","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook plan.updated","href":"/api-reference/plans/plan-updated-new-version-published"},{"title":"Plan deleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook plan.deleted","href":"/api-reference/plans/plan-deleted"}]},{"group":"Add-ons","pages":[{"title":"Add on created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook addon.created","href":"/api-reference/add-ons/add-on-created"},{"title":"Add on updated new version published","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook addon.updated","href":"/api-reference/add-ons/add-on-updated-new-version-published"},{"title":"Add on deleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook addon.deleted","href":"/api-reference/add-ons/add-on-deleted"}]},{"group":"Features","pages":[{"title":"Feature created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature.created","href":"/api-reference/features/feature-created"},{"title":"Feature updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature.updated","href":"/api-reference/features/feature-updated"},{"title":"Feature deleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature.deleted","href":"/api-reference/features/feature-deleted"}]},{"group":"Feature Groups","pages":[{"title":"Feature group created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature_group.created","href":"/api-reference/feature-groups/feature-group-created"},{"title":"Feature group updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature_group.updated","href":"/api-reference/feature-groups/feature-group-updated"},{"title":"Feature group archived","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature_group.archived","href":"/api-reference/feature-groups/feature-group-archived"},{"title":"Feature group unarchived","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature_group.un_archived","href":"/api-reference/feature-groups/feature-group-unarchived"}]},{"group":"Coupons","pages":[{"title":"Coupon created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook coupon.created","href":"/api-reference/coupons/coupon-created"},{"title":"Coupon updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook coupon.updated","href":"/api-reference/coupons/coupon-updated"},{"title":"Coupon archived","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook coupon.archived","href":"/api-reference/coupons/coupon-archived"}]},{"group":"Customers","pages":[{"title":"Customer created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook customer.created","href":"/api-reference/customers/customer-created"},{"title":"Customer updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook customer.updated","href":"/api-reference/customers/customer-updated"},{"title":"Customer payment failed","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook customer.payment_failed","href":"/api-reference/customers/customer-payment-failed"},{"title":"Customer deleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook customer.deleted","href":"/api-reference/customers/customer-deleted"}]},{"group":"Subscriptions","pages":[{"title":"Subscription created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.created","href":"/api-reference/subscriptions/subscription-created"},{"title":"Subscription updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.updated","href":"/api-reference/subscriptions/subscription-updated"},{"title":"Subscription canceled","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.canceled","href":"/api-reference/subscriptions/subscription-canceled"},{"title":"Subscription expired non recurring","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.expired","href":"/api-reference/subscriptions/subscription-expired-non-recurring"},{"title":"Billing month ends soon","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.billing_month.ends_soon","href":"/api-reference/subscriptions/billing-month-ends-soon"},{"title":"Spend limit exceeded","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.spend_limit.exceeded","href":"/api-reference/subscriptions/spend-limit-exceeded"},{"title":"Subscription creation failed","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.create_failed","href":"/api-reference/subscriptions/subscription-creation-failed"}]},{"group":"Trials","pages":[{"title":"Trial started","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.trial_started","href":"/api-reference/trials/trial-started"},{"title":"Trial ends soon","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.trial.ends_soon","href":"/api-reference/trials/trial-ends-soon"},{"title":"Trial converted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.trial_converted","href":"/api-reference/trials/trial-converted"},{"title":"Trial expired","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.trial_expired","href":"/api-reference/trials/trial-expired"}]},{"group":"Credit grants","pages":[{"title":"Credit grant created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_grant.created","href":"/api-reference/credit-grants/credit-grant-created"},{"title":"Credit grant updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_grant.updated","href":"/api-reference/credit-grants/credit-grant-updated"},{"title":"Credit grant balance low","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_grant.balance.low","href":"/api-reference/credit-grants/credit-grant-balance-low"},{"title":"Credit grant depleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_grant.depleted","href":"/api-reference/credit-grants/credit-grant-depleted"},{"title":"Credit grant expired","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_grant.expired","href":"/api-reference/credit-grants/credit-grant-expired"}]},{"group":"Credit balance","pages":[{"title":"Credit balance low","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_balance.low","href":"/api-reference/credit-balance/credit-balance-low"},{"title":"Credit balance depleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_balance.depleted","href":"/api-reference/credit-balance/credit-balance-depleted"}]},{"group":"Credit auto recharge","pages":[{"title":"Automatic recharge operation attempted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook automatic_recharge.operation.attempted","href":"/api-reference/credit-auto-recharge/automatic-recharge-operation-attempted"},{"title":"Automatic recharge spend limit threshold reached","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credits.automatic_recharge_limit_exceeded","href":"/api-reference/credit-auto-recharge/automatic-recharge-spend-limit-threshold-reached"},{"title":"Automatic recharge configuration changed","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook automatic_recharge.configuration.changed","href":"/api-reference/credit-auto-recharge/automatic-recharge-configuration-changed"}]},{"group":"Entitlements","pages":[{"title":"Entitlements updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entitlements.updated","href":"/api-reference/entitlements/entitlements-updated"},{"title":"Entitlement usage exceeded","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entitlement.usage_exceeded","href":"/api-reference/entitlements/entitlement-usage-exceeded"}]},{"group":"Promotional entitlements","pages":[{"title":"Promotional entitlement granted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook promotionalEntitlement.granted","href":"/api-reference/promotional-entitlements/promotional-entitlement-granted"},{"title":"Promotional entitlement updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook promotionalEntitlement.updated","href":"/api-reference/promotional-entitlements/promotional-entitlement-updated"},{"title":"Promotional entitlement revoked","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook promotionalEntitlement.revoked","href":"/api-reference/promotional-entitlements/promotional-entitlement-revoked"},{"title":"Promotional entitlement ends soon","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook promotionalEntitlement.ends_soon","href":"/api-reference/promotional-entitlements/promotional-entitlement-ends-soon"},{"title":"Promotional entitlement expired","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook promotionalEntitlement.expired","href":"/api-reference/promotional-entitlements/promotional-entitlement-expired"}]},{"group":"Third-party sync","pages":[{"title":"Third party sync failed","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook sync.failed","href":"/api-reference/third-party-sync/third-party-sync-failed"},{"title":"Data export sync failed","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook data_export.sync_failed","href":"/api-reference/third-party-sync/data-export-sync-failed"}]}]}]},{"tab":"Integrations","icon":"puzzle-piece","pages":[{"title":"Integrations","href":"/documentation/native-integrations/overview"}]},{"tab":"Changelog","icon":"clock-rotate-left","dropdowns":[{"dropdown":"Overview","icon":"compass","pages":[{"title":"Changelog","mode":"custom","href":"/api-and-sdks/changelog/overview"}]},{"dropdown":"Product","icon":"sparkles","href":"https://changelog.stigg.io/"},{"dropdown":"REST","icon":"server","pages":[{"title":"TypeScript","mode":"wide","href":"/api-and-sdks/changelog/backend-rest/typescript"},{"title":"Python","mode":"wide","href":"/api-and-sdks/changelog/backend-rest/python"},{"title":"Go","mode":"wide","href":"/api-and-sdks/changelog/backend-rest/go"},{"title":"Java","mode":"wide","href":"/api-and-sdks/changelog/backend-rest/java"},{"title":"Ruby","mode":"wide","href":"/api-and-sdks/changelog/backend-rest/ruby"},{"title":"C#","mode":"wide","href":"/api-and-sdks/changelog/backend-rest/csharp"}]},{"dropdown":"GraphQL","icon":"diagram-project","pages":[{"title":"Node.js SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/node"},{"title":"Python SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/python"},{"title":"Ruby SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/ruby"},{"title":"Go SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/go"},{"title":"Java SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/java"},{"title":".NET SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/dotnet"},{"title":"API Client (JS)","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/api-client-js"}]},{"dropdown":"Frontend SDKs","icon":"window-maximize","pages":[{"title":"JavaScript SDK","mode":"wide","href":"/api-and-sdks/changelog/frontend/javascript"},{"title":"React SDK","mode":"wide","href":"/api-and-sdks/changelog/frontend/react"},{"title":"Vue.js SDK","mode":"wide","href":"/api-and-sdks/changelog/frontend/vuejs"},{"title":"Next.js SDK","mode":"wide","href":"/api-and-sdks/changelog/frontend/nextjs"},{"title":"Embed SDK","mode":"wide","href":"/api-and-sdks/changelog/frontend/embed"}]},{"dropdown":"Sidecar","icon":"circle-nodes","pages":[{"title":"Sidecar Service","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/sidecar-service"},{"title":"Sidecar SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/sidecar"}]},{"dropdown":"Agent SDK","icon":"robot","pages":[{"title":"JavaScript","mode":"wide","href":"/api-and-sdks/changelog/agent-sdk/javascript"}]},{"dropdown":"Persistent Cache Service","icon":"database","pages":[{"title":"Persistent Cache Service","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/persistent-cache"}]}]}]},"title":"Update a plan - Stigg","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}