import Stigg from '@stigg/typescript';
const client = new Stigg({
apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});
const response = await client.v1.subscriptions.provision({
customerId: 'customerId',
planId: 'planId',
});
console.log(response.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
)
response = client.v1.subscriptions.provision(
customer_id="customerId",
plan_id="planId",
)
print(response.data)
Creates a new subscription for an existing customer. When payment is required and no payment method exists, returns a checkout URL.
POST
/
api
/
v1
/
subscriptions
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 response = await client.v1.subscriptions.provision({
customerId: 'customerId',
planId: 'planId',
});
console.log(response.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
)
response = client.v1.subscriptions.provision(
customer_id="customerId",
plan_id="planId",
)
print(response.data)
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).
Body
application/json
Provision a subscription. Returns subscription or checkout URL.
The country code used to select a localized price, or "eu" for the European Union group you map countries into, falling back to the default price when none matches
Provisioning result with status and subscription or checkout URL.
Show child attributes
{"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":""},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af1bec4df3e9cabb27c0c2d","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Documentation","count":287},{"language":"default","tag":"API Reference","count":261},{"language":"default","tag":"REST","count":176},{"language":"default","tag":"Pricing and packaging","count":99},{"language":"default","tag":"Integrations","count":64},{"language":"default","tag":"Webhooks","count":61},{"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":"rbac-expansion","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":"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":"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":"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":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"content/custom.css","content":"@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}:root{--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-family:\"Söhne\", sans-serif;font-size:34px;font-weight:400;line-height:1.2}.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(ul):not(:where(.card *,[data-component-part=\"tab-content\"] *,[data-component-part=\"callout-content\"] *,blockquote *,[class~=\"not-prose\"] *)),.mdx-content :where(ol):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:0.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(ul):not(:where(.card *,[data-component-part=\"tab-content\"] *,[data-component-part=\"callout-content\"] *,blockquote *,[class~=\"not-prose\"] *)),.mdx-content :where(ol):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:#ffffff;border-radius:4px;opacity:1;transition:background-color 0.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-featured-title,.welcome-featured-head:hover .welcome-arrow{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;color:var(--welcome-accent)}.welcome-icon svg,.welcome-arrow svg,.welcome-flow-arrow svg,.welcome-flow-outcome 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 pre,.welcome-featured [class*=\"code-block\"]{margin-bottom:0!important}.welcome-flow{margin:24px 0 8px;padding:20px;border:1px solid var(--welcome-border);border-radius:12px;background:var(--welcome-panel)}.welcome-step{display:flex;flex-direction:column;justify-content:center;align-items:center;gap:6px;padding:14px;border:1px solid var(--welcome-border);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:0.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-step-n{width:22px;height:22px;display:flex;align-items:center;justify-content:center;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;display:flex;align-items:center;justify-content:center;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{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-stack{margin:24px 0 8px;padding:20px;display:flex;flex-direction:column;align-items:center;border:1px solid var(--welcome-border);border-radius:12px;background:var(--welcome-panel)}.welcome-runtime{width:100%;padding:16px;display:flex;flex-direction:column;gap:12px;border:1.5px solid var(--welcome-accent);border-radius:10px;background:var(--welcome-subtle)}.welcome-runtime>.welcome-label{color:var(--welcome-accent)}.welcome-caps{display:grid;grid-template-columns:repeat(2, minmax(0, 1fr));gap:10px}.welcome-cap,.welcome-downstream{display:flex;flex-direction:column;gap:8px;padding:14px;border:1px solid var(--welcome-border);border-radius:8px;background:var(--welcome-surface);color:var(--welcome-text);text-decoration:none;transition:border-color 0.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:1px solid var(--welcome-border);border-radius:9999px;background:var(--welcome-surface);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{margin:24px 0 8px;padding:28px 20px 20px;display:flex;flex-direction:column;border:1px solid var(--welcome-border);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:1px solid var(--welcome-border);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-more{color:var(--welcome-accent)}.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 0.9s linear infinite}.welcome-wire::after,.welcome-wire-both::before{content:\"\";position:absolute;left:-4px;border:5px solid transparent}.welcome-wire::after{bottom:-8px;border-top-color:var(--welcome-accent)}.welcome-wire-both::before{top:-8px;border-bottom-color:var(--welcome-accent)}.welcome-wire-up{animation-direction:reverse}.welcome-wire-up::after{top:-8px;bottom:auto;border-top-color:transparent;border-bottom-color:var(--welcome-accent)}@keyframes welcome-dash{to{background-position:0 10px}}@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-links{display:flex;flex-direction:column;gap:18px;padding:0 4px}.welcome-link{display:flex;flex-direction:column;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)}@keyframes welcome-dash-h{to{background-position:10px 0}}.welcome-lock{display:flex;flex-direction:column;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{display:flex;flex-direction:column;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{top:-8px;bottom:auto;left:-4px;border-color:transparent;border-bottom-color:var(--welcome-accent)}.welcome-wire-h.welcome-wire-both::before{top:-8px;left:-4px;border-color:transparent;border-bottom-color:var(--welcome-accent)}}"}],"page":{"pagePath":"api-and-sdks/api-reference/rest/subscriptions-create","slug":"/api-and-sdks/api-reference/rest/subscriptions-create","pageMetadata":{"title":"Create Subscription","openapi":"POST /api/v1/subscriptions","description":"Creates a new subscription for an existing customer. When payment is required and no payment method exists, returns a checkout URL.","href":"/api-and-sdks/api-reference/rest/subscriptions-create"},"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: \"Creates a new subscription for an existing customer. When payment is required and no payment method exists, returns a checkout URL.\"\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":"Create Subscription","openapi":"POST /api/v1/subscriptions","description":"Creates a new subscription for an existing customer. When payment is required and no payment method exists, returns a checkout URL.","href":"/api-and-sdks/api-reference/rest/subscriptions-create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/stigg/14aedc563c3207a3/content/custom.js"],"openApiReferenceData":{"operation":{"description":"Creates a new subscription for an existing customer. When payment is required and no payment method exists, returns a checkout URL.","operationId":"SubscriptionController_provisionSubscription","parameters":["49604075-db50-4d20-aa5b-9386009159c3","fd114ce9-bc7a-48b7-8045-1e93b32b293e"],"requestBody":"ad9658fb-7434-45d1-8482-2a9092971b53","responses":{"201":"edef80f1-265e-4a5b-b126-44028290d0c3","400":"92aa1efd-eec1-44be-bfc1-02a4c8184d67","401":"3e6d9ae7-3833-40eb-84eb-8a61e4a87647","403":"431ef208-1a61-497e-a8b5-890caff94f10","409":"bbe6359d-ac5f-4801-b928-a65b7c2844bc","429":"b6a285fa-d33f-428c-8b75-e187d15d5e6b"},"summary":"Provision subscription","tags":["Subscriptions"],"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 response = await client.v1.subscriptions.provision({\n customerId: 'customerId',\n planId: 'planId',\n});\n\nconsole.log(response.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)\nresponse = client.v1.subscriptions.provision(\n customer_id=\"customerId\",\n plan_id=\"planId\",\n)\nprint(response.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\tresponse, err := client.V1.Subscriptions.Provision(context.TODO(), stigg.V1SubscriptionProvisionParams{\n\t\tCustomerID: \"customerId\",\n\t\tPlanID: \"planId\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.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.subscriptions.SubscriptionProvisionParams;\nimport io.stigg.models.v1.subscriptions.SubscriptionProvisionResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n SubscriptionProvisionParams params = SubscriptionProvisionParams.builder()\n .customerId(\"customerId\")\n .planId(\"planId\")\n .build();\n SubscriptionProvisionResponse response = client.v1().subscriptions().provision(params);\n }\n}"},{"lang":"Ruby","source":"require \"stigg\"\n\nstigg = Stigg::Client.new(api_key: \"My API Key\")\n\nresponse = stigg.v1.subscriptions.provision(customer_id: \"customerId\", plan_id: \"planId\")\n\nputs(response)"},{"lang":"C#","source":"using System;\nusing Stigg.Client;\nusing Stigg.Client.Models.V1.Subscriptions;\n\nStiggClient client = new();\n\nSubscriptionProvisionParams parameters = new()\n{\n CustomerID = \"customerId\",\n PlanID = \"planId\",\n};\n\nvar response = await client.V1.Subscriptions.Provision(parameters);\n\nConsole.WriteLine(response);"},{"lang":"CLI","source":"stigg v1:subscriptions provision \\\n --api-key 'My API Key' \\\n --customer-id customerId \\\n --plan-id planId"}],"method":"post","type":"path","servers":["9155880b-7d06-47e2-972e-fa125ff7d65c"],"security":["8e55133f-c13b-41c1-b14e-4830e2f798c1"],"path":"/api/v1/subscriptions","baseUrlOptions":["https://api.stigg.io"],"title":"Provision subscription","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 response = await client.v1.subscriptions.provision({\n customerId: 'customerId',\n planId: 'planId',\n});\n\nconsole.log(response.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)\nresponse = client.v1.subscriptions.provision(\n customer_id=\"customerId\",\n plan_id=\"planId\",\n)\nprint(response.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\tresponse, err := client.V1.Subscriptions.Provision(context.TODO(), stigg.V1SubscriptionProvisionParams{\n\t\tCustomerID: \"customerId\",\n\t\tPlanID: \"planId\",\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", response.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.subscriptions.SubscriptionProvisionParams;\nimport io.stigg.models.v1.subscriptions.SubscriptionProvisionResponse;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n SubscriptionProvisionParams params = SubscriptionProvisionParams.builder()\n .customerId(\"customerId\")\n .planId(\"planId\")\n .build();\n SubscriptionProvisionResponse response = client.v1().subscriptions().provision(params);\n }\n}"},{"lang":"Ruby","source":"require \"stigg\"\n\nstigg = Stigg::Client.new(api_key: \"My API Key\")\n\nresponse = stigg.v1.subscriptions.provision(customer_id: \"customerId\", plan_id: \"planId\")\n\nputs(response)"},{"lang":"C#","source":"using System;\nusing Stigg.Client;\nusing Stigg.Client.Models.V1.Subscriptions;\n\nStiggClient client = new();\n\nSubscriptionProvisionParams parameters = new()\n{\n CustomerID = \"customerId\",\n PlanID = \"planId\",\n};\n\nvar response = await client.V1.Subscriptions.Provision(parameters);\n\nConsole.WriteLine(response);"},{"lang":"CLI","source":"stigg v1:subscriptions provision \\\n --api-key 'My API Key' \\\n --customer-id customerId \\\n --plan-id planId"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"49604075-db50-4d20-aa5b-9386009159c3":{"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"}},"fd114ce9-bc7a-48b7-8045-1e93b32b293e":{"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":{"customerId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$","description":"Customer ID to provision the subscription for","isRequired":true,"uniqueKey":"customerId","typeLabel":"string"},"planId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Plan ID to provision","isRequired":true,"uniqueKey":"planId","typeLabel":"string"},"id":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Unique identifier for the subscription","uniqueKey":"id","typeLabel":"string"},"payingCustomerId":{"oneOf":[{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$","description":"Optional paying customer ID for split billing scenarios","uniqueKey":"payingCustomerId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$","description":"Optional paying customer ID for split billing scenarios","uniqueKey":"payingCustomerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"payingCustomerId","typeLabel":"string | null"},"resourceId":{"oneOf":[{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Optional resource ID for multi-instance subscriptions","uniqueKey":"resourceId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Optional resource ID for multi-instance subscriptions","uniqueKey":"resourceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"resourceId","typeLabel":"string | null"},"billingPeriod":{"type":"string","enum":["MONTHLY","ANNUALLY"],"description":"Billing period (MONTHLY or ANNUALLY)","uniqueKey":"billingPeriod","typeLabel":"enum\u003cstring>"},"addons":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Addon ID","isRequired":true,"uniqueKey":"addons.items.[INDEX].id","typeLabel":"string"},"quantity":{"type":"integer","minimum":0,"description":"Number of addon instances","isRequired":true,"uniqueKey":"addons.items.[INDEX].quantity","typeLabel":"integer"}},"required":["id","quantity"],"title":"SubscriptionAddon","description":"Addon configuration","uniqueKey":"addons.items.[INDEX]","typeLabel":"SubscriptionAddon · object"},"uniqueKey":"addons","typeLabel":"SubscriptionAddon · object[]"},"charges":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["FEATURE","CREDIT"],"description":"Charge type","isRequired":true,"uniqueKey":"charges.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","maxLength":255,"description":"Charge ID","isRequired":true,"uniqueKey":"charges.items.[INDEX].id","typeLabel":"string"},"quantity":{"type":"number","minimum":0,"description":"Charge quantity. Minimum is 0 (zero is allowed).","isRequired":true,"uniqueKey":"charges.items.[INDEX].quantity","typeLabel":"number"}},"required":["type","id","quantity"],"additionalProperties":false,"title":"SubscriptionCharge","description":"A charge selection for a subscription (references a catalog charge with a quantity).","uniqueKey":"charges.items.[INDEX]","typeLabel":"SubscriptionCharge · object"},"uniqueKey":"charges","typeLabel":"SubscriptionCharge · object[]"},"startDate":{"type":"string","format":"date-time","description":"Subscription start date","uniqueKey":"startDate","typeLabel":"string\u003cdate-time>"},"cancellationDate":{"type":"string","format":"date-time","description":"Subscription cancellation date","uniqueKey":"cancellationDate","typeLabel":"string\u003cdate-time>"},"billingInformation":{"type":"object","properties":{"taxRateIds":{"type":"array","items":{"type":"string","maxLength":255,"description":"Tax rate identifiers to apply","uniqueKey":"billingInformation.taxRateIds.items.[INDEX]","typeLabel":"string"},"description":"Tax rate identifiers to apply","uniqueKey":"billingInformation.taxRateIds","typeLabel":"string[]"},"taxPercentage":{"type":"number","minimum":0,"maximum":100,"description":"Tax percentage (0-100)","uniqueKey":"billingInformation.taxPercentage","typeLabel":"number"},"billingAddress":{"type":"object","properties":{"city":{"type":"string","uniqueKey":"billingInformation.billingAddress.city","typeLabel":"string"},"country":{"type":"string","uniqueKey":"billingInformation.billingAddress.country","typeLabel":"string"},"line1":{"type":"string","uniqueKey":"billingInformation.billingAddress.line1","typeLabel":"string"},"line2":{"type":"string","uniqueKey":"billingInformation.billingAddress.line2","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"billingInformation.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","uniqueKey":"billingInformation.billingAddress.state","typeLabel":"string"}},"description":"Billing address for the subscription","uniqueKey":"billingInformation.billingAddress","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"billingInformation.metadata.additionalProperties","typeLabel":"string"},"description":"Additional metadata for the subscription, stored as an arbitrary flat key-value object.","uniqueKey":"billingInformation.metadata","typeLabel":"object"},"chargeOnBehalfOfAccount":{"oneOf":[{"type":"string","maxLength":255,"description":"Stripe Connect account to charge on behalf of","uniqueKey":"billingInformation.chargeOnBehalfOfAccount.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Stripe Connect account to charge on behalf of","uniqueKey":"billingInformation.chargeOnBehalfOfAccount.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingInformation.chargeOnBehalfOfAccount","typeLabel":"string | null"},"isBackdated":{"default":false,"type":"boolean","description":"Whether the subscription is backdated","uniqueKey":"billingInformation.isBackdated","typeLabel":"boolean"},"isInvoicePaid":{"default":false,"type":"boolean","description":"Whether the invoice is marked as paid","uniqueKey":"billingInformation.isInvoicePaid","typeLabel":"boolean"},"invoiceDaysUntilDue":{"type":"number","description":"Number of days until invoice is due","uniqueKey":"billingInformation.invoiceDaysUntilDue","typeLabel":"number"},"integrationId":{"oneOf":[{"type":"string","maxLength":255,"description":"Billing integration identifier","uniqueKey":"billingInformation.integrationId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Billing integration identifier","uniqueKey":"billingInformation.integrationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingInformation.integrationId","typeLabel":"string | null"},"prorationBehavior":{"type":"string","enum":["INVOICE_IMMEDIATELY","CREATE_PRORATIONS","NONE"],"description":"How to handle proration for billing changes","uniqueKey":"billingInformation.prorationBehavior","typeLabel":"enum\u003cstring>"},"taxIds":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","maxLength":255,"description":"The type of tax exemption identifier, such as VAT.","isRequired":true,"uniqueKey":"billingInformation.taxIds.items.[INDEX].type","typeLabel":"string"},"value":{"type":"string","maxLength":255,"description":"The actual tax identifier value","isRequired":true,"uniqueKey":"billingInformation.taxIds.items.[INDEX].value","typeLabel":"string"}},"required":["type","value"],"additionalProperties":false,"title":"TaxExemptInput","description":"Tax identifier with type and value for customer tax exemptions.","uniqueKey":"billingInformation.taxIds.items.[INDEX]","typeLabel":"TaxExemptInput · object"},"description":"Customer tax identification numbers","uniqueKey":"billingInformation.taxIds","typeLabel":"TaxExemptInput · object[]"}},"additionalProperties":false,"uniqueKey":"billingInformation","typeLabel":"object"},"billingId":{"oneOf":[{"type":"string","maxLength":255,"description":"External billing system identifier","uniqueKey":"billingId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"External billing system identifier","uniqueKey":"billingId.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingId","typeLabel":"string | null"},"billingCountryCode":{"oneOf":[{"type":"string","maxLength":255,"description":"The country code used to select a localized price, or \"eu\" for the European Union group you map countries into, falling back to the default price when none matches","uniqueKey":"billingCountryCode.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The country code used to select a localized price, or \"eu\" for the European Union group you map countries into, falling back to the default price when none matches","uniqueKey":"billingCountryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingCountryCode","typeLabel":"string | null"},"entitlements":{"type":"array","items":{"oneOf":[{"type":"object","title":"SubscriptionFeatureEntitlementRequest","description":"Feature entitlement configuration for a subscription","required":["type","id"],"properties":{"type":{"type":"string","enum":["FEATURE"],"description":"SubscriptionFeatureEntitlementRequest","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"The feature ID to attach the entitlement to","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].oneOf.0.id","typeLabel":"string"},"usageLimit":{"type":"integer","minimum":0,"description":"Maximum allowed usage for the feature","uniqueKey":"entitlements.items.[INDEX].oneOf.0.usageLimit","typeLabel":"integer"},"hasUnlimitedUsage":{"type":"boolean","description":"Whether usage is unlimited","uniqueKey":"entitlements.items.[INDEX].oneOf.0.hasUnlimitedUsage","typeLabel":"boolean"},"hasSoftLimit":{"type":"boolean","description":"Whether the usage limit is a soft limit","uniqueKey":"entitlements.items.[INDEX].oneOf.0.hasSoftLimit","typeLabel":"boolean"},"resetPeriod":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","HOUR"],"description":"Period at which usage resets","uniqueKey":"entitlements.items.[INDEX].oneOf.0.resetPeriod","typeLabel":"enum\u003cstring>"},"yearlyResetPeriodConfiguration":{"oneOf":[{"type":"object","properties":{"accordingTo":{"type":"string","enum":["SubscriptionStart"],"description":"Reset anchor (SubscriptionStart)","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].oneOf.0.yearlyResetPeriodConfiguration.oneOf.0.accordingTo","typeLabel":"enum\u003cstring>"}},"required":["accordingTo"],"title":"YearlyResetPeriodConfig","description":"Configuration for yearly reset period","uniqueKey":"entitlements.items.[INDEX].oneOf.0.yearlyResetPeriodConfiguration.oneOf.0","typeLabel":"YearlyResetPeriodConfig · object"},{"type":"null","properties":{"accordingTo":{"type":"string","enum":["SubscriptionStart"],"description":"Reset anchor (SubscriptionStart)"}},"required":["accordingTo"],"title":"YearlyResetPeriodConfig","description":"Configuration for yearly reset period","uniqueKey":"entitlements.items.[INDEX].oneOf.0.yearlyResetPeriodConfiguration.oneOf.1","typeLabel":"null"}],"uniqueKey":"entitlements.items.[INDEX].oneOf.0.yearlyResetPeriodConfiguration","typeLabel":"YearlyResetPeriodConfig · object | null"},"monthlyResetPeriodConfiguration":{"oneOf":[{"type":"object","properties":{"accordingTo":{"type":"string","enum":["SubscriptionStart","StartOfTheMonth"],"description":"Reset anchor (SubscriptionStart or StartOfTheMonth)","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].oneOf.0.monthlyResetPeriodConfiguration.oneOf.0.accordingTo","typeLabel":"enum\u003cstring>"}},"required":["accordingTo"],"title":"MonthlyResetPeriodConfig","description":"Configuration for monthly reset period","uniqueKey":"entitlements.items.[INDEX].oneOf.0.monthlyResetPeriodConfiguration.oneOf.0","typeLabel":"MonthlyResetPeriodConfig · object"},{"type":"null","properties":{"accordingTo":{"type":"string","enum":["SubscriptionStart","StartOfTheMonth"],"description":"Reset anchor (SubscriptionStart or StartOfTheMonth)"}},"required":["accordingTo"],"title":"MonthlyResetPeriodConfig","description":"Configuration for monthly reset period","uniqueKey":"entitlements.items.[INDEX].oneOf.0.monthlyResetPeriodConfiguration.oneOf.1","typeLabel":"null"}],"uniqueKey":"entitlements.items.[INDEX].oneOf.0.monthlyResetPeriodConfiguration","typeLabel":"MonthlyResetPeriodConfig · object | null"},"weeklyResetPeriodConfiguration":{"oneOf":[{"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":"entitlements.items.[INDEX].oneOf.0.weeklyResetPeriodConfiguration.oneOf.0.accordingTo","typeLabel":"enum\u003cstring>"}},"required":["accordingTo"],"title":"WeeklyResetPeriodConfig","description":"Configuration for weekly reset period","uniqueKey":"entitlements.items.[INDEX].oneOf.0.weeklyResetPeriodConfiguration.oneOf.0","typeLabel":"WeeklyResetPeriodConfig · object"},{"type":"null","properties":{"accordingTo":{"type":"string","enum":["SubscriptionStart","EverySunday","EveryMonday","EveryTuesday","EveryWednesday","EveryThursday","EveryFriday","EverySaturday"],"description":"Reset anchor (SubscriptionStart or specific day)"}},"required":["accordingTo"],"title":"WeeklyResetPeriodConfig","description":"Configuration for weekly reset period","uniqueKey":"entitlements.items.[INDEX].oneOf.0.weeklyResetPeriodConfiguration.oneOf.1","typeLabel":"null"}],"uniqueKey":"entitlements.items.[INDEX].oneOf.0.weeklyResetPeriodConfiguration","typeLabel":"WeeklyResetPeriodConfig · object | null"}},"uniqueKey":"entitlements.items.[INDEX].oneOf.0","typeLabel":"SubscriptionFeatureEntitlementRequest · object"},{"type":"object","title":"SubscriptionCreditEntitlementRequest","description":"Credit entitlement configuration for a subscription","required":["type","id","amount","cadence"],"properties":{"type":{"type":"string","enum":["CREDIT"],"description":"SubscriptionCreditEntitlementRequest","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"The custom currency ID for the credit entitlement","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].oneOf.1.id","typeLabel":"string"},"amount":{"type":"number","minimum":0,"description":"Credit grant amount","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].oneOf.1.amount","typeLabel":"number"},"cadence":{"type":"string","enum":["MONTH","YEAR"],"description":"Credit grant cadence (MONTH or YEAR)","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].oneOf.1.cadence","typeLabel":"enum\u003cstring>"},"hasSoftLimit":{"type":"boolean","description":"Whether the credit balance is a soft limit","uniqueKey":"entitlements.items.[INDEX].oneOf.1.hasSoftLimit","typeLabel":"boolean"}},"uniqueKey":"entitlements.items.[INDEX].oneOf.1","typeLabel":"SubscriptionCreditEntitlementRequest · object"}],"uniqueKey":"entitlements.items.[INDEX]","typeLabel":"SubscriptionFeatureEntitlementRequest · object | SubscriptionCreditEntitlementRequest · object"},"uniqueKey":"entitlements","typeLabel":"(SubscriptionFeatureEntitlementRequest · object | SubscriptionCreditEntitlementRequest · object)[]"},"trialOverrideConfiguration":{"type":"object","properties":{"isTrial":{"type":"boolean","description":"Whether the subscription should start with a trial period","isRequired":true,"uniqueKey":"trialOverrideConfiguration.isTrial","typeLabel":"boolean"},"trialEndBehavior":{"type":"string","enum":["CONVERT_TO_PAID","CANCEL_SUBSCRIPTION"],"description":"Behavior when trial ends: CONVERT_TO_PAID or CANCEL_SUBSCRIPTION","uniqueKey":"trialOverrideConfiguration.trialEndBehavior","typeLabel":"enum\u003cstring>"},"trialEndDate":{"type":"string","format":"date-time","description":"Custom trial end date","uniqueKey":"trialOverrideConfiguration.trialEndDate","typeLabel":"string\u003cdate-time>"}},"required":["isTrial"],"description":"Trial period override settings","uniqueKey":"trialOverrideConfiguration","typeLabel":"object"},"scheduleStrategy":{"type":"string","enum":["END_OF_BILLING_PERIOD","END_OF_BILLING_MONTH","IMMEDIATE"],"description":"Strategy for scheduling subscription changes","uniqueKey":"scheduleStrategy","typeLabel":"enum\u003cstring>"},"checkoutOptions":{"type":"object","properties":{"successUrl":{"type":"string","maxLength":2048,"format":"uri","description":"URL to redirect to after successful checkout","isRequired":true,"uniqueKey":"checkoutOptions.successUrl","typeLabel":"string\u003curi>"},"cancelUrl":{"type":"string","maxLength":2048,"format":"uri","description":"URL to redirect to if checkout is canceled","isRequired":true,"uniqueKey":"checkoutOptions.cancelUrl","typeLabel":"string\u003curi>"},"allowPromoCodes":{"default":false,"type":"boolean","description":"Allow promotional codes during checkout","uniqueKey":"checkoutOptions.allowPromoCodes","typeLabel":"boolean"},"allowTaxIdCollection":{"default":false,"type":"boolean","description":"Allow tax ID collection during checkout","uniqueKey":"checkoutOptions.allowTaxIdCollection","typeLabel":"boolean"},"collectBillingAddress":{"default":false,"type":"boolean","description":"Collect billing address during checkout","uniqueKey":"checkoutOptions.collectBillingAddress","typeLabel":"boolean"},"referenceId":{"oneOf":[{"type":"string","maxLength":255,"description":"Optional reference ID for the checkout session","uniqueKey":"checkoutOptions.referenceId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Optional reference ID for the checkout session","uniqueKey":"checkoutOptions.referenceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"checkoutOptions.referenceId","typeLabel":"string | null"},"collectPhoneNumber":{"default":false,"type":"boolean","description":"Collect phone number during checkout","uniqueKey":"checkoutOptions.collectPhoneNumber","typeLabel":"boolean"}},"required":["successUrl","cancelUrl"],"description":"Checkout page configuration for payment collection","uniqueKey":"checkoutOptions","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"Additional metadata for the subscription, stored as an arbitrary flat key-value object.","uniqueKey":"metadata","typeLabel":"object"},"salesforceId":{"oneOf":[{"type":"string","maxLength":255,"description":"Salesforce ID","uniqueKey":"salesforceId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Salesforce ID","uniqueKey":"salesforceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"salesforceId","typeLabel":"string | null"},"budget":{"oneOf":[{"type":"object","properties":{"limit":{"type":"number","description":"Maximum spending limit","isRequired":true,"uniqueKey":"budget.oneOf.0.limit","typeLabel":"number"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget is a soft limit","isRequired":true,"uniqueKey":"budget.oneOf.0.hasSoftLimit","typeLabel":"boolean"}},"required":["limit","hasSoftLimit"],"additionalProperties":false,"uniqueKey":"budget.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"limit":{"type":"number","description":"Maximum spending limit"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget is a soft limit"}},"required":["limit","hasSoftLimit"],"additionalProperties":false,"uniqueKey":"budget.oneOf.1","typeLabel":"null"}],"uniqueKey":"budget","typeLabel":"object | null"},"minimumSpend":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","uniqueKey":"minimumSpend.oneOf.0.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":"minimumSpend.oneOf.0.currency","typeLabel":"enum\u003cstring>"}},"description":"Minimum spend amount","uniqueKey":"minimumSpend.oneOf.0","typeLabel":"object"},{"type":"null","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"}},"description":"Minimum spend amount","uniqueKey":"minimumSpend.oneOf.1","typeLabel":"null"}],"uniqueKey":"minimumSpend","typeLabel":"object | null"},"priceOverrides":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","uniqueKey":"priceOverrides.items.[INDEX].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":"priceOverrides.items.[INDEX].currency","typeLabel":"enum\u003cstring>"},"featureId":{"oneOf":[{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Feature identifier for the price override","uniqueKey":"priceOverrides.items.[INDEX].featureId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Feature identifier for the price override","uniqueKey":"priceOverrides.items.[INDEX].featureId.oneOf.1","typeLabel":"null"}],"uniqueKey":"priceOverrides.items.[INDEX].featureId","typeLabel":"string | null"},"addonId":{"oneOf":[{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Addon identifier for the price override","uniqueKey":"priceOverrides.items.[INDEX].addonId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Addon identifier for the price override","uniqueKey":"priceOverrides.items.[INDEX].addonId.oneOf.1","typeLabel":"null"}],"uniqueKey":"priceOverrides.items.[INDEX].addonId","typeLabel":"string | null"},"baseCharge":{"type":"boolean","description":"Whether this is a base charge override","uniqueKey":"priceOverrides.items.[INDEX].baseCharge","typeLabel":"boolean"},"billingCountryCode":{"type":"string","maxLength":255,"description":"ISO 3166-1 alpha-2 country code this price applies to, or \"eu\" for the European Union group you map countries into. Omit for the default price shown to all countries; set one or more country-specific price periods on the same currency to localize the amount by billing country.","uniqueKey":"priceOverrides.items.[INDEX].billingCountryCode","typeLabel":"string"},"blockSize":{"type":"number","description":"Block size for pricing","uniqueKey":"priceOverrides.items.[INDEX].blockSize","typeLabel":"number"},"tiers":{"type":"array","items":{"type":"object","properties":{"upTo":{"type":"number","description":"The up to quantity of the price tier","uniqueKey":"priceOverrides.items.[INDEX].tiers.items.[INDEX].upTo","typeLabel":"number"},"unitPrice":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"priceOverrides.items.[INDEX].tiers.items.[INDEX].unitPrice.amount","typeLabel":"number"},"currency":{"description":"ISO 4217 currency code","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","isRequired":true,"uniqueKey":"priceOverrides.items.[INDEX].tiers.items.[INDEX].unitPrice.currency","typeLabel":"enum\u003cstring>"}},"required":["amount","currency"],"title":"Money","description":"The unit price of the price tier","uniqueKey":"priceOverrides.items.[INDEX].tiers.items.[INDEX].unitPrice","typeLabel":"Money · object"},"flatPrice":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"priceOverrides.items.[INDEX].tiers.items.[INDEX].flatPrice.amount","typeLabel":"number"},"currency":{"description":"ISO 4217 currency code","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","isRequired":true,"uniqueKey":"priceOverrides.items.[INDEX].tiers.items.[INDEX].flatPrice.currency","typeLabel":"enum\u003cstring>"}},"required":["amount","currency"],"title":"Money","description":"The flat fee price of the price tier","uniqueKey":"priceOverrides.items.[INDEX].tiers.items.[INDEX].flatPrice","typeLabel":"Money · object"}},"additionalProperties":false,"uniqueKey":"priceOverrides.items.[INDEX].tiers.items.[INDEX]","typeLabel":"object"},"description":"Pricing tiers configuration","uniqueKey":"priceOverrides.items.[INDEX].tiers","typeLabel":"object[]"},"creditRate":{"type":"object","properties":{"amount":{"type":"number","minimum":0,"exclusiveMinimum":true,"description":"The credit rate amount","isRequired":true,"uniqueKey":"priceOverrides.items.[INDEX].creditRate.amount","typeLabel":"number"},"currencyId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"The custom currency refId for the credit rate","isRequired":true,"uniqueKey":"priceOverrides.items.[INDEX].creditRate.currencyId","typeLabel":"string"},"costFormula":{"oneOf":[{"type":"string","maxLength":255,"description":"A custom formula for calculating cost based on single event dimensions","uniqueKey":"priceOverrides.items.[INDEX].creditRate.costFormula.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"A custom formula for calculating cost based on single event dimensions","uniqueKey":"priceOverrides.items.[INDEX].creditRate.costFormula.oneOf.1","typeLabel":"null"}],"uniqueKey":"priceOverrides.items.[INDEX].creditRate.costFormula","typeLabel":"string | null"}},"required":["amount","currencyId"],"additionalProperties":false,"uniqueKey":"priceOverrides.items.[INDEX].creditRate","typeLabel":"object"},"creditGrantCadence":{"type":"string","enum":["BEGINNING_OF_BILLING_PERIOD","MONTHLY"],"uniqueKey":"priceOverrides.items.[INDEX].creditGrantCadence","typeLabel":"enum\u003cstring>"}},"uniqueKey":"priceOverrides.items.[INDEX]","typeLabel":"object"},"uniqueKey":"priceOverrides","typeLabel":"object[]"},"paymentCollectionMethod":{"default":"CHARGE","type":"string","enum":["CHARGE","INVOICE","NONE"],"description":"How payments should be collected for this subscription","uniqueKey":"paymentCollectionMethod","typeLabel":"enum\u003cstring>"},"appliedCoupon":{"type":"object","properties":{"couponId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Stigg coupon ID","uniqueKey":"appliedCoupon.couponId","typeLabel":"string"},"billingCouponId":{"type":"string","maxLength":255,"description":"Billing provider coupon ID","uniqueKey":"appliedCoupon.billingCouponId","typeLabel":"string"},"promotionCode":{"type":"string","maxLength":255,"description":"Promotion code to apply","uniqueKey":"appliedCoupon.promotionCode","typeLabel":"string"},"discount":{"type":"object","properties":{"name":{"type":"string","maxLength":255,"description":"Discount name","uniqueKey":"appliedCoupon.discount.name","typeLabel":"string"},"description":{"type":"string","maxLength":255,"description":"Ad-hoc discount","uniqueKey":"appliedCoupon.discount.description","typeLabel":"string"},"durationInMonths":{"type":"number","minimum":1,"description":"Duration in months","uniqueKey":"appliedCoupon.discount.durationInMonths","typeLabel":"number"},"percentOff":{"type":"number","minimum":1,"maximum":100,"description":"Percentage discount","uniqueKey":"appliedCoupon.discount.percentOff","typeLabel":"number"},"amountsOff":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"appliedCoupon.discount.amountsOff.oneOf.0.items.[INDEX].amount","typeLabel":"number"},"currency":{"description":"ISO 4217 currency code","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","isRequired":true,"uniqueKey":"appliedCoupon.discount.amountsOff.oneOf.0.items.[INDEX].currency","typeLabel":"enum\u003cstring>"}},"required":["amount","currency"],"additionalProperties":false,"uniqueKey":"appliedCoupon.discount.amountsOff.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Fixed amounts off by currency","uniqueKey":"appliedCoupon.discount.amountsOff.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount"},"currency":{"description":"ISO 4217 currency code","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","currency"],"additionalProperties":false},"description":"Fixed amounts off by currency","uniqueKey":"appliedCoupon.discount.amountsOff.oneOf.1","typeLabel":"null"}],"uniqueKey":"appliedCoupon.discount.amountsOff","typeLabel":"object[] | null"}},"additionalProperties":false,"title":"SubscriptionCouponDiscount","description":"Ad-hoc discount configuration","uniqueKey":"appliedCoupon.discount","typeLabel":"SubscriptionCouponDiscount · object"},"configuration":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"Coupon start date","uniqueKey":"appliedCoupon.configuration.startDate","typeLabel":"string\u003cdate-time>"}},"additionalProperties":false,"description":"Coupon timing configuration","uniqueKey":"appliedCoupon.configuration","typeLabel":"object"}},"additionalProperties":false,"title":"SubscriptionCoupon","description":"Coupon configuration","uniqueKey":"appliedCoupon","typeLabel":"SubscriptionCoupon · object"},"awaitPaymentConfirmation":{"default":true,"type":"boolean","description":"Whether to wait for payment confirmation before returning the subscription","uniqueKey":"awaitPaymentConfirmation","typeLabel":"boolean"},"unitQuantity":{"type":"integer","minimum":0,"description":"Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).","uniqueKey":"unitQuantity","typeLabel":"integer"},"billingCycleAnchor":{"type":"string","enum":["UNCHANGED","NOW"],"description":"Billing cycle anchor behavior for the subscription","uniqueKey":"billingCycleAnchor","typeLabel":"enum\u003cstring>"}},"required":["customerId","planId"],"additionalProperties":false,"title":"ProvisionSubscriptionRequest","description":"Provision a subscription. Returns subscription or checkout URL.","uniqueKey":"","typeLabel":"ProvisionSubscriptionRequest · object"},"examples":{"Example":{"title":"Example","value":{"customerId":"\u003cstring>","planId":"\u003cstring>","id":"\u003cstring>","payingCustomerId":"\u003cstring>","resourceId":"\u003cstring>","addons":[{"id":"\u003cstring>","quantity":1}],"charges":[{"id":"\u003cstring>","quantity":1}],"startDate":"2023-11-07T05:31:56Z","cancellationDate":"2023-11-07T05:31:56Z","billingInformation":{"taxRateIds":["\u003cstring>"],"taxPercentage":50,"billingAddress":{"city":"\u003cstring>","country":"\u003cstring>","line1":"\u003cstring>","line2":"\u003cstring>","postalCode":"\u003cstring>","state":"\u003cstring>"},"metadata":{},"chargeOnBehalfOfAccount":"\u003cstring>","isBackdated":false,"isInvoicePaid":false,"invoiceDaysUntilDue":123,"integrationId":"\u003cstring>","taxIds":[{"type":"\u003cstring>","value":"\u003cstring>"}]},"billingId":"\u003cstring>","billingCountryCode":"\u003cstring>","entitlements":[{"type":"FEATURE","id":"\u003cstring>","usageLimit":1,"hasUnlimitedUsage":true,"hasSoftLimit":true,"yearlyResetPeriodConfiguration":{"accordingTo":"SubscriptionStart"},"monthlyResetPeriodConfiguration":{},"weeklyResetPeriodConfiguration":{}}],"metadata":{},"salesforceId":"\u003cstring>","budget":{"limit":123,"hasSoftLimit":true},"minimumSpend":{"amount":123},"priceOverrides":[{"amount":123,"featureId":"\u003cstring>","addonId":"\u003cstring>","baseCharge":true,"billingCountryCode":"\u003cstring>","blockSize":123,"tiers":[{"upTo":123}]}],"paymentCollectionMethod":"CHARGE","appliedCoupon":{"couponId":"\u003cstring>","billingCouponId":"\u003cstring>","promotionCode":"\u003cstring>","discount":{"name":"\u003cstring>","description":"\u003cstring>","durationInMonths":2,"percentOff":50.5,"amountsOff":[{"amount":123}]},"configuration":{"startDate":"2023-11-07T05:31:56Z"}},"awaitPaymentConfirmation":true,"unitQuantity":1}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"edef80f1-265e-4a5b-b126-44028290d0c3":{"description":"The newly created subscription object.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","maxLength":255,"description":"Unique identifier for the provisioned subscription","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"status":{"type":"string","enum":["SUCCESS","PAYMENT_REQUIRED"],"description":"Provision status: SUCCESS or PAYMENT_REQUIRED","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"subscription":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Subscription ID","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.id","typeLabel":"string"},"customerId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$","description":"Customer ID","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.customerId","typeLabel":"string"},"billingId":{"oneOf":[{"type":"string","maxLength":255,"description":"Billing ID","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.billingId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Billing ID","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.billingId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.subscription.oneOf.0.billingId","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","description":"Created at","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"startDate":{"type":"string","format":"date-time","description":"Subscription start date","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.startDate","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","enum":["PAYMENT_PENDING","ACTIVE","EXPIRED","IN_TRIAL","CANCELED","NOT_STARTED"],"description":"Subscription status","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.status","typeLabel":"enum\u003cstring>"},"pricingType":{"type":"string","enum":["FREE","PAID","CUSTOM"],"description":"Pricing type","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.pricingType","typeLabel":"enum\u003cstring>"},"paymentCollection":{"type":"string","enum":["NOT_REQUIRED","PROCESSING","FAILED","ACTION_REQUIRED"],"description":"Payment collection","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.paymentCollection","typeLabel":"enum\u003cstring>"},"planId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Plan ID","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.planId","typeLabel":"string"},"payingCustomerId":{"oneOf":[{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$","description":"Paying customer ID for delegated billing","uniqueKey":"data.subscription.oneOf.0.payingCustomerId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$","description":"Paying customer ID for delegated billing","uniqueKey":"data.subscription.oneOf.0.payingCustomerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.payingCustomerId","typeLabel":"string | null"},"resourceId":{"oneOf":[{"type":"string","maxLength":255,"description":"Resource ID","uniqueKey":"data.subscription.oneOf.0.resourceId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Resource ID","uniqueKey":"data.subscription.oneOf.0.resourceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.resourceId","typeLabel":"string | null"},"contractId":{"oneOf":[{"type":"string","maxLength":255,"description":"The Stigg contract this subscription is linked to, when any","uniqueKey":"data.subscription.oneOf.0.contractId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The Stigg contract this subscription is linked to, when any","uniqueKey":"data.subscription.oneOf.0.contractId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.contractId","typeLabel":"string | null"},"endDate":{"oneOf":[{"type":"string","format":"date-time","description":"Subscription end date","uniqueKey":"data.subscription.oneOf.0.endDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Subscription end date","uniqueKey":"data.subscription.oneOf.0.endDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.endDate","typeLabel":"string\u003cdate-time> | null"},"effectiveEndDate":{"oneOf":[{"type":"string","format":"date-time","description":"Subscription effective end date","uniqueKey":"data.subscription.oneOf.0.effectiveEndDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Subscription effective end date","uniqueKey":"data.subscription.oneOf.0.effectiveEndDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.effectiveEndDate","typeLabel":"string\u003cdate-time> | null"},"cancellationDate":{"oneOf":[{"type":"string","format":"date-time","description":"Subscription cancellation date","uniqueKey":"data.subscription.oneOf.0.cancellationDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Subscription cancellation date","uniqueKey":"data.subscription.oneOf.0.cancellationDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.cancellationDate","typeLabel":"string\u003cdate-time> | null"},"trialEndDate":{"oneOf":[{"type":"string","format":"date-time","description":"Subscription trial end date","uniqueKey":"data.subscription.oneOf.0.trialEndDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Subscription trial end date","uniqueKey":"data.subscription.oneOf.0.trialEndDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.trialEndDate","typeLabel":"string\u003cdate-time> | null"},"cancelReason":{"oneOf":[{"type":"string","enum":["UPGRADE_OR_DOWNGRADE","CANCELLED_BY_BILLING","EXPIRED","DETACH_BILLING","TRIAL_ENDED","Immediate","TRIAL_CONVERTED","PENDING_PAYMENT_EXPIRED","ScheduledCancellation","CustomerArchived","AutoCancellationRule"],"description":"Subscription cancel reason","uniqueKey":"data.subscription.oneOf.0.cancelReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["UPGRADE_OR_DOWNGRADE","CANCELLED_BY_BILLING","EXPIRED","DETACH_BILLING","TRIAL_ENDED","Immediate","TRIAL_CONVERTED","PENDING_PAYMENT_EXPIRED","ScheduledCancellation","CustomerArchived","AutoCancellationRule"],"description":"Subscription cancel reason","uniqueKey":"data.subscription.oneOf.0.cancelReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.cancelReason","typeLabel":"enum\u003cstring> | null"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.subscription.oneOf.0.metadata.additionalProperties","typeLabel":"string"},"description":"Additional metadata for the subscription, stored as an arbitrary flat key-value object.","uniqueKey":"data.subscription.oneOf.0.metadata","typeLabel":"object"},"currentBillingPeriodStart":{"oneOf":[{"type":"string","format":"date-time","description":"Start of the current billing period","uniqueKey":"data.subscription.oneOf.0.currentBillingPeriodStart.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start of the current billing period","uniqueKey":"data.subscription.oneOf.0.currentBillingPeriodStart.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.currentBillingPeriodStart","typeLabel":"string\u003cdate-time> | null"},"currentBillingPeriodEnd":{"oneOf":[{"type":"string","format":"date-time","description":"End of the current billing period","uniqueKey":"data.subscription.oneOf.0.currentBillingPeriodEnd.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End of the current billing period","uniqueKey":"data.subscription.oneOf.0.currentBillingPeriodEnd.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.currentBillingPeriodEnd","typeLabel":"string\u003cdate-time> | null"},"paymentCollectionMethod":{"oneOf":[{"type":"string","enum":["CHARGE","INVOICE","NONE"],"description":"The method used to collect payments for a subscription","uniqueKey":"data.subscription.oneOf.0.paymentCollectionMethod.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["CHARGE","INVOICE","NONE"],"description":"The method used to collect payments for a subscription","uniqueKey":"data.subscription.oneOf.0.paymentCollectionMethod.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.paymentCollectionMethod","typeLabel":"enum\u003cstring> | null"},"billingCycleAnchor":{"oneOf":[{"type":"string","format":"date-time","description":"Billing cycle anchor date","uniqueKey":"data.subscription.oneOf.0.billingCycleAnchor.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Billing cycle anchor date","uniqueKey":"data.subscription.oneOf.0.billingCycleAnchor.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.billingCycleAnchor","typeLabel":"string\u003cdate-time> | null"},"prices":{"default":[],"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].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":"data.subscription.oneOf.0.prices.items.[INDEX].currency","typeLabel":"enum\u003cstring>"},"featureId":{"oneOf":[{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Feature identifier for the price override","uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].featureId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Feature identifier for the price override","uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].featureId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].featureId","typeLabel":"string | null"},"addonId":{"oneOf":[{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Addon identifier for the price override","uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].addonId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Addon identifier for the price override","uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].addonId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].addonId","typeLabel":"string | null"},"baseCharge":{"type":"boolean","description":"Whether this is a base charge override","uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].baseCharge","typeLabel":"boolean"},"billingCountryCode":{"type":"string","maxLength":255,"description":"ISO 3166-1 alpha-2 country code this price applies to, or \"eu\" for the European Union group you map countries into. Omit for the default price shown to all countries; set one or more country-specific price periods on the same currency to localize the amount by billing country.","uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].billingCountryCode","typeLabel":"string"},"blockSize":{"type":"number","description":"Block size for pricing","uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].blockSize","typeLabel":"number"},"tiers":{"type":"array","items":{"type":"object","properties":{"upTo":{"type":"number","description":"The up to quantity of the price tier","uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].tiers.items.[INDEX].upTo","typeLabel":"number"},"unitPrice":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].tiers.items.[INDEX].unitPrice.amount","typeLabel":"number"},"currency":{"description":"ISO 4217 currency code","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","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].tiers.items.[INDEX].unitPrice.currency","typeLabel":"enum\u003cstring>"}},"required":["amount","currency"],"title":"Money","description":"The unit price of the price tier","uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].tiers.items.[INDEX].unitPrice","typeLabel":"Money · object"},"flatPrice":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].tiers.items.[INDEX].flatPrice.amount","typeLabel":"number"},"currency":{"description":"ISO 4217 currency code","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","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].tiers.items.[INDEX].flatPrice.currency","typeLabel":"enum\u003cstring>"}},"required":["amount","currency"],"title":"Money","description":"The flat fee price of the price tier","uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].tiers.items.[INDEX].flatPrice","typeLabel":"Money · object"}},"additionalProperties":false,"uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].tiers.items.[INDEX]","typeLabel":"object"},"description":"Pricing tiers configuration","uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX].tiers","typeLabel":"object[]"}},"uniqueKey":"data.subscription.oneOf.0.prices.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.subscription.oneOf.0.prices","typeLabel":"object[]"},"addons":{"default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Addon ID","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.addons.items.[INDEX].id","typeLabel":"string"},"quantity":{"type":"integer","minimum":0,"description":"Number of addon instances","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.addons.items.[INDEX].quantity","typeLabel":"integer"}},"required":["id","quantity"],"title":"SubscriptionAddon","description":"Addon configuration","uniqueKey":"data.subscription.oneOf.0.addons.items.[INDEX]","typeLabel":"SubscriptionAddon · object"},"uniqueKey":"data.subscription.oneOf.0.addons","typeLabel":"SubscriptionAddon · object[]"},"coupons":{"default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":255,"description":"Coupon ID","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.coupons.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","maxLength":255,"description":"Coupon name","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.coupons.items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","enum":["ACTIVE","EXPIRED","REMOVED"],"description":"Coupon status","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.coupons.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"percentOff":{"oneOf":[{"type":"number","description":"Percentage discount","uniqueKey":"data.subscription.oneOf.0.coupons.items.[INDEX].percentOff.oneOf.0","typeLabel":"number"},{"type":"null","description":"Percentage discount","uniqueKey":"data.subscription.oneOf.0.coupons.items.[INDEX].percentOff.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.coupons.items.[INDEX].percentOff","typeLabel":"number | null"},"amountsOff":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","uniqueKey":"data.subscription.oneOf.0.coupons.items.[INDEX].amountsOff.oneOf.0.items.[INDEX].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":"data.subscription.oneOf.0.coupons.items.[INDEX].amountsOff.oneOf.0.items.[INDEX].currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.subscription.oneOf.0.coupons.items.[INDEX].amountsOff.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Fixed amount discounts by currency","uniqueKey":"data.subscription.oneOf.0.coupons.items.[INDEX].amountsOff.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"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"}}},"description":"Fixed amount discounts by currency","uniqueKey":"data.subscription.oneOf.0.coupons.items.[INDEX].amountsOff.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.coupons.items.[INDEX].amountsOff","typeLabel":"object[] | null"}},"required":["id","name","status"],"title":"SubscriptionCouponResponse","description":"Coupon applied to a subscription","uniqueKey":"data.subscription.oneOf.0.coupons.items.[INDEX]","typeLabel":"SubscriptionCouponResponse · object"},"description":"Coupons applied to the subscription","uniqueKey":"data.subscription.oneOf.0.coupons","typeLabel":"SubscriptionCouponResponse · object[]"},"futureUpdates":{"default":[],"type":"array","items":{"type":"object","properties":{"scheduledExecutionTime":{"type":"string","format":"date-time","description":"Scheduled execution time","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.futureUpdates.items.[INDEX].scheduledExecutionTime","typeLabel":"string\u003cdate-time>"},"subscriptionScheduleType":{"type":"string","enum":["DOWNGRADE","PLAN","BILLING_PERIOD","UNIT_AMOUNT","RECURRING_CREDITS","PRICE_OVERRIDE","ADDON","COUPON","MIGRATE_TO_LATEST","ADDITIONAL_META_DATA","BILLING_INFO_METADATA"],"description":"Type of scheduled change","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.futureUpdates.items.[INDEX].subscriptionScheduleType","typeLabel":"enum\u003cstring>"},"scheduleStatus":{"type":"string","enum":["PENDING_PAYMENT","SCHEDULED","CANCELED","DONE","FAILED"],"description":"Status of the scheduled update","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.futureUpdates.items.[INDEX].scheduleStatus","typeLabel":"enum\u003cstring>"},"targetPackage":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","maxLength":255,"description":"Target package for the update","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.futureUpdates.items.[INDEX].targetPackage.oneOf.0.id","typeLabel":"string"}},"required":["id"],"description":"Target package for the update","uniqueKey":"data.subscription.oneOf.0.futureUpdates.items.[INDEX].targetPackage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","maxLength":255,"description":"Target package for the update"}},"required":["id"],"description":"Target package for the update","uniqueKey":"data.subscription.oneOf.0.futureUpdates.items.[INDEX].targetPackage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.futureUpdates.items.[INDEX].targetPackage","typeLabel":"object | null"}},"required":["scheduledExecutionTime","subscriptionScheduleType","scheduleStatus"],"title":"FutureUpdate","description":"Scheduled subscription update","uniqueKey":"data.subscription.oneOf.0.futureUpdates.items.[INDEX]","typeLabel":"FutureUpdate · object"},"description":"Scheduled future updates for the subscription","uniqueKey":"data.subscription.oneOf.0.futureUpdates","typeLabel":"FutureUpdate · object[]"},"budget":{"oneOf":[{"type":"object","properties":{"limit":{"type":"number","description":"Maximum spending limit","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.budget.oneOf.0.limit","typeLabel":"number"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget is a soft limit","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.budget.oneOf.0.hasSoftLimit","typeLabel":"boolean"}},"required":["limit","hasSoftLimit"],"additionalProperties":false,"description":"Budget configuration","uniqueKey":"data.subscription.oneOf.0.budget.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"limit":{"type":"number","description":"Maximum spending limit"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget is a soft limit"}},"required":["limit","hasSoftLimit"],"additionalProperties":false,"description":"Budget configuration","uniqueKey":"data.subscription.oneOf.0.budget.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.budget","typeLabel":"object | null"},"minimumSpend":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","uniqueKey":"data.subscription.oneOf.0.minimumSpend.oneOf.0.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":"data.subscription.oneOf.0.minimumSpend.oneOf.0.currency","typeLabel":"enum\u003cstring>"}},"description":"Minimum spend configuration","uniqueKey":"data.subscription.oneOf.0.minimumSpend.oneOf.0","typeLabel":"object"},{"type":"null","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"}},"description":"Minimum spend configuration","uniqueKey":"data.subscription.oneOf.0.minimumSpend.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.minimumSpend","typeLabel":"object | null"},"subscriptionEntitlements":{"default":[],"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["FEATURE","CREDIT"],"description":"Entitlement type (FEATURE or CREDIT)","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.subscriptionEntitlements.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","maxLength":255,"description":"Feature ID or currency ID","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.subscriptionEntitlements.items.[INDEX].id","typeLabel":"string"}},"required":["type","id"],"title":"SubscriptionEntitlementItem","description":"Subscription entitlement reference","uniqueKey":"data.subscription.oneOf.0.subscriptionEntitlements.items.[INDEX]","typeLabel":"SubscriptionEntitlementItem · object"},"description":"Entitlements associated with the subscription","uniqueKey":"data.subscription.oneOf.0.subscriptionEntitlements","typeLabel":"SubscriptionEntitlementItem · object[]"},"latestInvoice":{"oneOf":[{"type":"object","properties":{"billingId":{"type":"string","maxLength":255,"description":"Invoice billing ID","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.billingId","typeLabel":"string"},"status":{"type":"string","enum":["OPEN","CANCELED","PAID"],"description":"Invoice status","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","description":"Invoice creation date","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"requiresAction":{"type":"boolean","description":"Whether payment requires action","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.requiresAction","typeLabel":"boolean"},"total":{"oneOf":[{"type":"number","description":"Total amount","uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.total.oneOf.0","typeLabel":"number"},{"type":"null","description":"Total amount","uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.total.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.total","typeLabel":"number | null"},"amountDue":{"oneOf":[{"type":"number","description":"Amount due","uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.amountDue.oneOf.0","typeLabel":"number"},{"type":"null","description":"Amount due","uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.amountDue.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.amountDue","typeLabel":"number | null"},"currency":{"oneOf":[{"type":"string","maxLength":255,"description":"Invoice currency","uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.currency.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Invoice currency","uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.currency","typeLabel":"string | null"},"pdfUrl":{"oneOf":[{"type":"string","maxLength":2048,"description":"Invoice PDF URL","uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.pdfUrl.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":2048,"description":"Invoice PDF URL","uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.pdfUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.pdfUrl","typeLabel":"string | null"},"billingReason":{"oneOf":[{"type":"string","enum":["BILLING_CYCLE","SUBSCRIPTION_CREATION","SUBSCRIPTION_UPDATE","MANUAL","MINIMUM_INVOICE_AMOUNT_EXCEEDED","OTHER"],"description":"Billing reason","uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.billingReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["BILLING_CYCLE","SUBSCRIPTION_CREATION","SUBSCRIPTION_UPDATE","MANUAL","MINIMUM_INVOICE_AMOUNT_EXCEEDED","OTHER"],"description":"Billing reason","uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.billingReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0.billingReason","typeLabel":"enum\u003cstring> | null"}},"required":["billingId","status","createdAt","requiresAction"],"title":"LatestInvoice","description":"Latest invoice for the subscription","uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.0","typeLabel":"LatestInvoice · object"},{"type":"null","properties":{"billingId":{"type":"string","maxLength":255,"description":"Invoice billing ID"},"status":{"type":"string","enum":["OPEN","CANCELED","PAID"],"description":"Invoice status"},"createdAt":{"type":"string","format":"date-time","description":"Invoice creation date"},"total":{"oneOf":[{"type":"number","description":"Total amount"},{"type":"null","description":"Total amount"}]},"amountDue":{"oneOf":[{"type":"number","description":"Amount due"},{"type":"null","description":"Amount due"}]},"currency":{"oneOf":[{"type":"string","maxLength":255,"description":"Invoice currency"},{"type":"null","maxLength":255,"description":"Invoice currency"}]},"pdfUrl":{"oneOf":[{"type":"string","maxLength":2048,"description":"Invoice PDF URL"},{"type":"null","maxLength":2048,"description":"Invoice PDF URL"}]},"requiresAction":{"type":"boolean","description":"Whether payment requires action"},"billingReason":{"oneOf":[{"type":"string","enum":["BILLING_CYCLE","SUBSCRIPTION_CREATION","SUBSCRIPTION_UPDATE","MANUAL","MINIMUM_INVOICE_AMOUNT_EXCEEDED","OTHER"],"description":"Billing reason"},{"type":"null","enum":["BILLING_CYCLE","SUBSCRIPTION_CREATION","SUBSCRIPTION_UPDATE","MANUAL","MINIMUM_INVOICE_AMOUNT_EXCEEDED","OTHER"],"description":"Billing reason"}]}},"required":["billingId","status","createdAt","requiresAction"],"title":"LatestInvoice","description":"Latest invoice for the subscription","uniqueKey":"data.subscription.oneOf.0.latestInvoice.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.latestInvoice","typeLabel":"LatestInvoice · object | null"},"trial":{"oneOf":[{"type":"object","properties":{"trialEndBehavior":{"type":"string","enum":["CONVERT_TO_PAID","CANCEL_SUBSCRIPTION"],"description":"Behavior when the trial ends","isRequired":true,"uniqueKey":"data.subscription.oneOf.0.trial.oneOf.0.trialEndBehavior","typeLabel":"enum\u003cstring>"}},"required":["trialEndBehavior"],"title":"Trial","description":"Trial configuration","uniqueKey":"data.subscription.oneOf.0.trial.oneOf.0","typeLabel":"Trial · object"},{"type":"null","properties":{"trialEndBehavior":{"type":"string","enum":["CONVERT_TO_PAID","CANCEL_SUBSCRIPTION"],"description":"Behavior when the trial ends"}},"required":["trialEndBehavior"],"title":"Trial","description":"Trial configuration","uniqueKey":"data.subscription.oneOf.0.trial.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.subscription.oneOf.0.trial","typeLabel":"Trial · object | null"}},"required":["id","customerId","billingId","createdAt","startDate","status","pricingType","paymentCollection","planId"],"title":"Subscription","description":"Created subscription (when status is SUCCESS)","isRequired":true,"uniqueKey":"data.subscription.oneOf.0","typeLabel":"Subscription · object"},{"type":"null","properties":{"id":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Subscription ID"},"customerId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$","description":"Customer ID"},"payingCustomerId":{"oneOf":[{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$","description":"Paying customer ID for delegated billing"},{"type":"null","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$","description":"Paying customer ID for delegated billing"}]},"resourceId":{"oneOf":[{"type":"string","maxLength":255,"description":"Resource ID"},{"type":"null","maxLength":255,"description":"Resource ID"}]},"billingId":{"oneOf":[{"type":"string","maxLength":255,"description":"Billing ID"},{"type":"null","maxLength":255,"description":"Billing ID"}]},"contractId":{"oneOf":[{"type":"string","maxLength":255,"description":"The Stigg contract this subscription is linked to, when any"},{"type":"null","maxLength":255,"description":"The Stigg contract this subscription is linked to, when any"}]},"createdAt":{"type":"string","format":"date-time","description":"Created at"},"startDate":{"type":"string","format":"date-time","description":"Subscription start date"},"endDate":{"oneOf":[{"type":"string","format":"date-time","description":"Subscription end date"},{"type":"null","format":"date-time","description":"Subscription end date"}]},"effectiveEndDate":{"oneOf":[{"type":"string","format":"date-time","description":"Subscription effective end date"},{"type":"null","format":"date-time","description":"Subscription effective end date"}]},"cancellationDate":{"oneOf":[{"type":"string","format":"date-time","description":"Subscription cancellation date"},{"type":"null","format":"date-time","description":"Subscription cancellation date"}]},"trialEndDate":{"oneOf":[{"type":"string","format":"date-time","description":"Subscription trial end date"},{"type":"null","format":"date-time","description":"Subscription trial end date"}]},"status":{"type":"string","enum":["PAYMENT_PENDING","ACTIVE","EXPIRED","IN_TRIAL","CANCELED","NOT_STARTED"],"description":"Subscription status"},"cancelReason":{"oneOf":[{"type":"string","enum":["UPGRADE_OR_DOWNGRADE","CANCELLED_BY_BILLING","EXPIRED","DETACH_BILLING","TRIAL_ENDED","Immediate","TRIAL_CONVERTED","PENDING_PAYMENT_EXPIRED","ScheduledCancellation","CustomerArchived","AutoCancellationRule"],"description":"Subscription cancel reason"},{"type":"null","enum":["UPGRADE_OR_DOWNGRADE","CANCELLED_BY_BILLING","EXPIRED","DETACH_BILLING","TRIAL_ENDED","Immediate","TRIAL_CONVERTED","PENDING_PAYMENT_EXPIRED","ScheduledCancellation","CustomerArchived","AutoCancellationRule"],"description":"Subscription cancel reason"}]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional metadata for the subscription, stored as an arbitrary flat key-value object."},"currentBillingPeriodStart":{"oneOf":[{"type":"string","format":"date-time","description":"Start of the current billing period"},{"type":"null","format":"date-time","description":"Start of the current billing period"}]},"currentBillingPeriodEnd":{"oneOf":[{"type":"string","format":"date-time","description":"End of the current billing period"},{"type":"null","format":"date-time","description":"End of the current billing period"}]},"pricingType":{"type":"string","enum":["FREE","PAID","CUSTOM"],"description":"Pricing type"},"paymentCollection":{"type":"string","enum":["NOT_REQUIRED","PROCESSING","FAILED","ACTION_REQUIRED"],"description":"Payment collection"},"paymentCollectionMethod":{"oneOf":[{"type":"string","enum":["CHARGE","INVOICE","NONE"],"description":"The method used to collect payments for a subscription"},{"type":"null","enum":["CHARGE","INVOICE","NONE"],"description":"The method used to collect payments for a subscription"}]},"billingCycleAnchor":{"oneOf":[{"type":"string","format":"date-time","description":"Billing cycle anchor date"},{"type":"null","format":"date-time","description":"Billing cycle anchor date"}]},"planId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Plan ID"},"prices":{"default":[],"type":"array","items":{"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"},"featureId":{"oneOf":[{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Feature identifier for the price override"},{"type":"null","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Feature identifier for the price override"}]},"addonId":{"oneOf":[{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Addon identifier for the price override"},{"type":"null","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Addon identifier for the price override"}]},"baseCharge":{"type":"boolean","description":"Whether this is a base charge override"},"billingCountryCode":{"type":"string","maxLength":255,"description":"ISO 3166-1 alpha-2 country code this price applies to, or \"eu\" for the European Union group you map countries into. Omit for the default price shown to all countries; set one or more country-specific price periods on the same currency to localize the amount by billing country."},"blockSize":{"type":"number","description":"Block size for pricing"},"tiers":{"type":"array","items":{"type":"object","properties":{"upTo":{"type":"number","description":"The up to quantity of the price tier"},"unitPrice":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount"},"currency":{"description":"ISO 4217 currency code","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","currency"],"title":"Money","description":"The unit price of the price tier"},"flatPrice":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount"},"currency":{"description":"ISO 4217 currency code","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","currency"],"title":"Money","description":"The flat fee price of the price tier"}},"additionalProperties":false},"description":"Pricing tiers configuration"}}}},"addons":{"default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Addon ID"},"quantity":{"type":"integer","minimum":0,"description":"Number of addon instances"}},"required":["id","quantity"],"title":"SubscriptionAddon","description":"Addon configuration"}},"coupons":{"default":[],"type":"array","items":{"type":"object","properties":{"id":{"type":"string","maxLength":255,"description":"Coupon ID"},"name":{"type":"string","maxLength":255,"description":"Coupon name"},"status":{"type":"string","enum":["ACTIVE","EXPIRED","REMOVED"],"description":"Coupon status"},"percentOff":{"oneOf":[{"type":"number","description":"Percentage discount"},{"type":"null","description":"Percentage discount"}]},"amountsOff":{"oneOf":[{"type":"array","items":{"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"}}},"description":"Fixed amount discounts by currency"},{"type":"null","items":{"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"}}},"description":"Fixed amount discounts by currency"}]}},"required":["id","name","status"],"title":"SubscriptionCouponResponse","description":"Coupon applied to a subscription"},"description":"Coupons applied to the subscription"},"futureUpdates":{"default":[],"type":"array","items":{"type":"object","properties":{"scheduledExecutionTime":{"type":"string","format":"date-time","description":"Scheduled execution time"},"subscriptionScheduleType":{"type":"string","enum":["DOWNGRADE","PLAN","BILLING_PERIOD","UNIT_AMOUNT","RECURRING_CREDITS","PRICE_OVERRIDE","ADDON","COUPON","MIGRATE_TO_LATEST","ADDITIONAL_META_DATA","BILLING_INFO_METADATA"],"description":"Type of scheduled change"},"scheduleStatus":{"type":"string","enum":["PENDING_PAYMENT","SCHEDULED","CANCELED","DONE","FAILED"],"description":"Status of the scheduled update"},"targetPackage":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","maxLength":255,"description":"Target package for the update"}},"required":["id"],"description":"Target package for the update"},{"type":"null","properties":{"id":{"type":"string","maxLength":255,"description":"Target package for the update"}},"required":["id"],"description":"Target package for the update"}]}},"required":["scheduledExecutionTime","subscriptionScheduleType","scheduleStatus"],"title":"FutureUpdate","description":"Scheduled subscription update"},"description":"Scheduled future updates for the subscription"},"budget":{"oneOf":[{"type":"object","properties":{"limit":{"type":"number","description":"Maximum spending limit"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget is a soft limit"}},"required":["limit","hasSoftLimit"],"additionalProperties":false,"description":"Budget configuration"},{"type":"null","properties":{"limit":{"type":"number","description":"Maximum spending limit"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget is a soft limit"}},"required":["limit","hasSoftLimit"],"additionalProperties":false,"description":"Budget configuration"}]},"minimumSpend":{"oneOf":[{"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"}},"description":"Minimum spend configuration"},{"type":"null","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"}},"description":"Minimum spend configuration"}]},"subscriptionEntitlements":{"default":[],"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["FEATURE","CREDIT"],"description":"Entitlement type (FEATURE or CREDIT)"},"id":{"type":"string","maxLength":255,"description":"Feature ID or currency ID"}},"required":["type","id"],"title":"SubscriptionEntitlementItem","description":"Subscription entitlement reference"},"description":"Entitlements associated with the subscription"},"latestInvoice":{"oneOf":[{"type":"object","properties":{"billingId":{"type":"string","maxLength":255,"description":"Invoice billing ID"},"status":{"type":"string","enum":["OPEN","CANCELED","PAID"],"description":"Invoice status"},"createdAt":{"type":"string","format":"date-time","description":"Invoice creation date"},"total":{"oneOf":[{"type":"number","description":"Total amount"},{"type":"null","description":"Total amount"}]},"amountDue":{"oneOf":[{"type":"number","description":"Amount due"},{"type":"null","description":"Amount due"}]},"currency":{"oneOf":[{"type":"string","maxLength":255,"description":"Invoice currency"},{"type":"null","maxLength":255,"description":"Invoice currency"}]},"pdfUrl":{"oneOf":[{"type":"string","maxLength":2048,"description":"Invoice PDF URL"},{"type":"null","maxLength":2048,"description":"Invoice PDF URL"}]},"requiresAction":{"type":"boolean","description":"Whether payment requires action"},"billingReason":{"oneOf":[{"type":"string","enum":["BILLING_CYCLE","SUBSCRIPTION_CREATION","SUBSCRIPTION_UPDATE","MANUAL","MINIMUM_INVOICE_AMOUNT_EXCEEDED","OTHER"],"description":"Billing reason"},{"type":"null","enum":["BILLING_CYCLE","SUBSCRIPTION_CREATION","SUBSCRIPTION_UPDATE","MANUAL","MINIMUM_INVOICE_AMOUNT_EXCEEDED","OTHER"],"description":"Billing reason"}]}},"required":["billingId","status","createdAt","requiresAction"],"title":"LatestInvoice","description":"Latest invoice for the subscription"},{"type":"null","properties":{"billingId":{"type":"string","maxLength":255,"description":"Invoice billing ID"},"status":{"type":"string","enum":["OPEN","CANCELED","PAID"],"description":"Invoice status"},"createdAt":{"type":"string","format":"date-time","description":"Invoice creation date"},"total":{"oneOf":[{"type":"number","description":"Total amount"},{"type":"null","description":"Total amount"}]},"amountDue":{"oneOf":[{"type":"number","description":"Amount due"},{"type":"null","description":"Amount due"}]},"currency":{"oneOf":[{"type":"string","maxLength":255,"description":"Invoice currency"},{"type":"null","maxLength":255,"description":"Invoice currency"}]},"pdfUrl":{"oneOf":[{"type":"string","maxLength":2048,"description":"Invoice PDF URL"},{"type":"null","maxLength":2048,"description":"Invoice PDF URL"}]},"requiresAction":{"type":"boolean","description":"Whether payment requires action"},"billingReason":{"oneOf":[{"type":"string","enum":["BILLING_CYCLE","SUBSCRIPTION_CREATION","SUBSCRIPTION_UPDATE","MANUAL","MINIMUM_INVOICE_AMOUNT_EXCEEDED","OTHER"],"description":"Billing reason"},{"type":"null","enum":["BILLING_CYCLE","SUBSCRIPTION_CREATION","SUBSCRIPTION_UPDATE","MANUAL","MINIMUM_INVOICE_AMOUNT_EXCEEDED","OTHER"],"description":"Billing reason"}]}},"required":["billingId","status","createdAt","requiresAction"],"title":"LatestInvoice","description":"Latest invoice for the subscription"}]},"trial":{"oneOf":[{"type":"object","properties":{"trialEndBehavior":{"type":"string","enum":["CONVERT_TO_PAID","CANCEL_SUBSCRIPTION"],"description":"Behavior when the trial ends"}},"required":["trialEndBehavior"],"title":"Trial","description":"Trial configuration"},{"type":"null","properties":{"trialEndBehavior":{"type":"string","enum":["CONVERT_TO_PAID","CANCEL_SUBSCRIPTION"],"description":"Behavior when the trial ends"}},"required":["trialEndBehavior"],"title":"Trial","description":"Trial configuration"}]}},"required":["id","customerId","billingId","createdAt","startDate","status","pricingType","paymentCollection","planId"],"title":"Subscription","description":"Created subscription (when status is SUCCESS)","isRequired":true,"uniqueKey":"data.subscription.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.subscription","typeLabel":"Subscription · object | null"},"entitlements":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","required":["isGranted","type","accessDeniedReason"],"properties":{"isGranted":{"type":"boolean","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.isGranted","typeLabel":"boolean"},"type":{"type":"string","enum":["FEATURE"],"isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"accessDeniedReason":{"oneOf":[{"type":"string","enum":["FeatureNotFound","CustomerNotFound","CustomerIsArchived","CustomerResourceNotFound","NoActiveSubscription","NoFeatureEntitlementInSubscription","RequestedUsageExceedingLimit","RequestedValuesMismatch","BudgetExceeded","Unknown","FeatureTypeMismatch","Revoked","InsufficientCredits","EntitlementNotFound"],"isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.accessDeniedReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["FeatureNotFound","CustomerNotFound","CustomerIsArchived","CustomerResourceNotFound","NoActiveSubscription","NoFeatureEntitlementInSubscription","RequestedUsageExceedingLimit","RequestedValuesMismatch","BudgetExceeded","Unknown","FeatureTypeMismatch","Revoked","InsufficientCredits","EntitlementNotFound"],"isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.accessDeniedReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.accessDeniedReason","typeLabel":"enum\u003cstring> | null"},"feature":{"type":"object","properties":{"id":{"type":"string","maxLength":255,"description":"The unique reference ID of the entitlement.","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.feature.id","typeLabel":"string"},"displayName":{"type":"string","maxLength":255,"description":"The human-readable name of the entitlement, shown in UI elements.","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.feature.displayName","typeLabel":"string"},"featureType":{"type":"string","enum":["BOOLEAN","NUMBER","ENUM"],"description":"The type of feature associated with the entitlement.","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.feature.featureType","typeLabel":"enum\u003cstring>"},"featureStatus":{"type":"string","enum":["NEW","SUSPENDED","ACTIVE"],"description":"The current status of the feature.","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.feature.featureStatus","typeLabel":"enum\u003cstring>"}},"required":["id","displayName","featureType","featureStatus"],"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.feature","typeLabel":"object"},"usageLimit":{"oneOf":[{"type":"number","minimum":0,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.usageLimit.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.usageLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.usageLimit","typeLabel":"number | null"},"hasUnlimitedUsage":{"type":"boolean","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.hasUnlimitedUsage","typeLabel":"boolean"},"resetPeriod":{"oneOf":[{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","HOUR"],"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.resetPeriod.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["YEAR","MONTH","WEEK","DAY","HOUR"],"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.resetPeriod.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.resetPeriod","typeLabel":"enum\u003cstring> | null"},"currentUsage":{"type":"number","minimum":0,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.currentUsage","typeLabel":"number"},"usagePeriodAnchor":{"type":"string","format":"date-time","description":"The anchor for calculating the usage period for metered entitlements with a reset period configured","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.usagePeriodAnchor","typeLabel":"string\u003cdate-time>"},"usagePeriodStart":{"type":"string","format":"date-time","description":"The start date of the usage period for metered entitlements with a reset period configured","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.usagePeriodStart","typeLabel":"string\u003cdate-time>"},"usagePeriodEnd":{"type":"string","format":"date-time","description":"The end date of the usage period for metered entitlements with a reset period configured","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.usagePeriodEnd","typeLabel":"string\u003cdate-time>"},"entitlementUpdatedAt":{"type":"string","format":"date-time","description":"Timestamp of the last update to the entitlement grant or configuration.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.entitlementUpdatedAt","typeLabel":"string\u003cdate-time>"},"validUntil":{"type":"string","format":"date-time","description":"The next time the entitlement should be recalculated","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0.validUntil","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["isGranted","type","accessDeniedReason","usageLimit","currentUsage","usageUpdatedAt","currency"],"properties":{"isGranted":{"type":"boolean","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.isGranted","typeLabel":"boolean"},"type":{"type":"string","enum":["CREDIT"],"isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"accessDeniedReason":{"oneOf":[{"type":"string","enum":["FeatureNotFound","CustomerNotFound","CustomerIsArchived","CustomerResourceNotFound","NoActiveSubscription","NoFeatureEntitlementInSubscription","RequestedUsageExceedingLimit","RequestedValuesMismatch","BudgetExceeded","Unknown","FeatureTypeMismatch","Revoked","InsufficientCredits","EntitlementNotFound"],"isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.accessDeniedReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["FeatureNotFound","CustomerNotFound","CustomerIsArchived","CustomerResourceNotFound","NoActiveSubscription","NoFeatureEntitlementInSubscription","RequestedUsageExceedingLimit","RequestedValuesMismatch","BudgetExceeded","Unknown","FeatureTypeMismatch","Revoked","InsufficientCredits","EntitlementNotFound"],"isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.accessDeniedReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.accessDeniedReason","typeLabel":"enum\u003cstring> | null"},"usageLimit":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.usageLimit","typeLabel":"number"},"currentUsage":{"type":"number","minimum":0,"isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currentUsage","typeLabel":"number"},"usageUpdatedAt":{"type":"string","format":"date-time","description":"Timestamp of the last update to the credit usage.","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.usageUpdatedAt","typeLabel":"string\u003cdate-time>"},"currency":{"type":"object","properties":{"currencyId":{"type":"string","maxLength":255,"description":"The unique identifier of the custom currency.","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.currencyId","typeLabel":"string"},"displayName":{"type":"string","maxLength":255,"description":"The display name of the currency.","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.displayName","typeLabel":"string"},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"A description of the currency.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.description.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"A description of the currency.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.description","typeLabel":"string | null"},"unitSingular":{"oneOf":[{"type":"string","maxLength":255,"description":"The singular form of the currency unit.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.unitSingular.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The singular form of the currency unit.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.unitSingular.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.unitSingular","typeLabel":"string | null"},"unitPlural":{"oneOf":[{"type":"string","maxLength":255,"description":"The plural form of the currency unit.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.unitPlural.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The plural form of the currency unit.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.unitPlural.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.unitPlural","typeLabel":"string | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.metadata.oneOf.0.additionalProperties","typeLabel":"string"},"description":"Additional metadata associated with the currency.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.metadata.oneOf.1.additionalProperties","typeLabel":"string"},"description":"Additional metadata associated with the currency.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency.metadata","typeLabel":"object | null"}},"required":["currencyId","displayName"],"description":"The currency associated with a credit entitlement.","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.currency","typeLabel":"object"},"entitlementUpdatedAt":{"type":"string","format":"date-time","description":"Timestamp of the last update to the entitlement grant or configuration.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.entitlementUpdatedAt","typeLabel":"string\u003cdate-time>"},"validUntil":{"type":"string","format":"date-time","description":"The next time the entitlement should be recalculated","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.validUntil","typeLabel":"string\u003cdate-time>"},"usagePeriodEnd":{"type":"string","format":"date-time","description":"The end date of the current billing period for recurring credit grants.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.usagePeriodEnd","typeLabel":"string\u003cdate-time>"},"reserved":{"type":"number","minimum":0,"description":"Credits held by open reservations on active grants. Already included in currentUsage, so usageLimit - currentUsage is the available balance.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.reserved","typeLabel":"number"},"reservedOnExpiredGrants":{"type":"number","minimum":0,"description":"Credits still held by open reservations on grants that expired during the hold. They can still be released, but are not part of currentUsage or the balance and must not be subtracted from it.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.reservedOnExpiredGrants","typeLabel":"number"},"reservation":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","maxLength":255,"description":"The client-provided reservation ID.","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.reservation.oneOf.0.id","typeLabel":"string"},"amount":{"type":"number","minimum":0,"exclusiveMinimum":true,"description":"The amount of credits held.","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.reservation.oneOf.0.amount","typeLabel":"number"},"status":{"type":"string","enum":["ACTIVE","RELEASED","EXPIRED"],"description":"The status of the reservation.","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.reservation.oneOf.0.status","typeLabel":"enum\u003cstring>"},"expiresAt":{"type":"string","format":"date-time","description":"When the reservation expires. Unreleased credits return to the balance at this time.","isRequired":true,"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.reservation.oneOf.0.expiresAt","typeLabel":"string\u003cdate-time>"}},"required":["id","amount","status","expiresAt"],"description":"The reservation created by this request, when it asked to reserve credits and was granted.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.reservation.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","maxLength":255,"description":"The client-provided reservation ID."},"amount":{"type":"number","minimum":0,"exclusiveMinimum":true,"description":"The amount of credits held."},"status":{"type":"string","enum":["ACTIVE","RELEASED","EXPIRED"],"description":"The status of the reservation."},"expiresAt":{"type":"string","format":"date-time","description":"When the reservation expires. Unreleased credits return to the balance at this time."}},"required":["id","amount","status","expiresAt"],"description":"The reservation created by this request, when it asked to reserve credits and was granted.","uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.reservation.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1.reservation","typeLabel":"object | null"}},"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"data.entitlements.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.entitlements.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"oneOf":[{"type":"object","required":["isGranted","type","accessDeniedReason"],"properties":{"isGranted":{"type":"boolean"},"type":{"type":"string","enum":["FEATURE"]},"accessDeniedReason":{"oneOf":[{"type":"string","enum":["FeatureNotFound","CustomerNotFound","CustomerIsArchived","CustomerResourceNotFound","NoActiveSubscription","NoFeatureEntitlementInSubscription","RequestedUsageExceedingLimit","RequestedValuesMismatch","BudgetExceeded","Unknown","FeatureTypeMismatch","Revoked","InsufficientCredits","EntitlementNotFound"]},{"type":"null","enum":["FeatureNotFound","CustomerNotFound","CustomerIsArchived","CustomerResourceNotFound","NoActiveSubscription","NoFeatureEntitlementInSubscription","RequestedUsageExceedingLimit","RequestedValuesMismatch","BudgetExceeded","Unknown","FeatureTypeMismatch","Revoked","InsufficientCredits","EntitlementNotFound"]}]},"feature":{"type":"object","properties":{"id":{"type":"string","maxLength":255,"description":"The unique reference ID of the entitlement."},"displayName":{"type":"string","maxLength":255,"description":"The human-readable name of the entitlement, shown in UI elements."},"featureType":{"type":"string","enum":["BOOLEAN","NUMBER","ENUM"],"description":"The type of feature associated with the entitlement."},"featureStatus":{"type":"string","enum":["NEW","SUSPENDED","ACTIVE"],"description":"The current status of the feature."}},"required":["id","displayName","featureType","featureStatus"]},"usageLimit":{"oneOf":[{"type":"number","minimum":0},{"type":"null","minimum":0}]},"hasUnlimitedUsage":{"type":"boolean"},"resetPeriod":{"oneOf":[{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","HOUR"]},{"type":"null","enum":["YEAR","MONTH","WEEK","DAY","HOUR"]}]},"currentUsage":{"type":"number","minimum":0},"usagePeriodAnchor":{"type":"string","format":"date-time","description":"The anchor for calculating the usage period for metered entitlements with a reset period configured"},"usagePeriodStart":{"type":"string","format":"date-time","description":"The start date of the usage period for metered entitlements with a reset period configured"},"usagePeriodEnd":{"type":"string","format":"date-time","description":"The end date of the usage period for metered entitlements with a reset period configured"},"entitlementUpdatedAt":{"type":"string","format":"date-time","description":"Timestamp of the last update to the entitlement grant or configuration."},"validUntil":{"type":"string","format":"date-time","description":"The next time the entitlement should be recalculated"}}},{"type":"object","required":["isGranted","type","accessDeniedReason","usageLimit","currentUsage","usageUpdatedAt","currency"],"properties":{"isGranted":{"type":"boolean"},"type":{"type":"string","enum":["CREDIT"]},"accessDeniedReason":{"oneOf":[{"type":"string","enum":["FeatureNotFound","CustomerNotFound","CustomerIsArchived","CustomerResourceNotFound","NoActiveSubscription","NoFeatureEntitlementInSubscription","RequestedUsageExceedingLimit","RequestedValuesMismatch","BudgetExceeded","Unknown","FeatureTypeMismatch","Revoked","InsufficientCredits","EntitlementNotFound"]},{"type":"null","enum":["FeatureNotFound","CustomerNotFound","CustomerIsArchived","CustomerResourceNotFound","NoActiveSubscription","NoFeatureEntitlementInSubscription","RequestedUsageExceedingLimit","RequestedValuesMismatch","BudgetExceeded","Unknown","FeatureTypeMismatch","Revoked","InsufficientCredits","EntitlementNotFound"]}]},"usageLimit":{"type":"number","minimum":0},"currentUsage":{"type":"number","minimum":0},"usageUpdatedAt":{"type":"string","format":"date-time","description":"Timestamp of the last update to the credit usage."},"currency":{"type":"object","properties":{"currencyId":{"type":"string","maxLength":255,"description":"The unique identifier of the custom currency."},"displayName":{"type":"string","maxLength":255,"description":"The display name of the currency."},"description":{"oneOf":[{"type":"string","maxLength":255,"description":"A description of the currency."},{"type":"null","maxLength":255,"description":"A description of the currency."}]},"unitSingular":{"oneOf":[{"type":"string","maxLength":255,"description":"The singular form of the currency unit."},{"type":"null","maxLength":255,"description":"The singular form of the currency unit."}]},"unitPlural":{"oneOf":[{"type":"string","maxLength":255,"description":"The plural form of the currency unit."},{"type":"null","maxLength":255,"description":"The plural form of the currency unit."}]},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string"},"description":"Additional metadata associated with the currency."},{"type":"null","additionalProperties":{"type":"string"},"description":"Additional metadata associated with the currency."}]}},"required":["currencyId","displayName"],"description":"The currency associated with a credit entitlement."},"entitlementUpdatedAt":{"type":"string","format":"date-time","description":"Timestamp of the last update to the entitlement grant or configuration."},"validUntil":{"type":"string","format":"date-time","description":"The next time the entitlement should be recalculated"},"usagePeriodEnd":{"type":"string","format":"date-time","description":"The end date of the current billing period for recurring credit grants."},"reserved":{"type":"number","minimum":0,"description":"Credits held by open reservations on active grants. Already included in currentUsage, so usageLimit - currentUsage is the available balance."},"reservedOnExpiredGrants":{"type":"number","minimum":0,"description":"Credits still held by open reservations on grants that expired during the hold. They can still be released, but are not part of currentUsage or the balance and must not be subtracted from it."},"reservation":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","maxLength":255,"description":"The client-provided reservation ID."},"amount":{"type":"number","minimum":0,"exclusiveMinimum":true,"description":"The amount of credits held."},"status":{"type":"string","enum":["ACTIVE","RELEASED","EXPIRED"],"description":"The status of the reservation."},"expiresAt":{"type":"string","format":"date-time","description":"When the reservation expires. Unreleased credits return to the balance at this time."}},"required":["id","amount","status","expiresAt"],"description":"The reservation created by this request, when it asked to reserve credits and was granted."},{"type":"null","properties":{"id":{"type":"string","maxLength":255,"description":"The client-provided reservation ID."},"amount":{"type":"number","minimum":0,"exclusiveMinimum":true,"description":"The amount of credits held."},"status":{"type":"string","enum":["ACTIVE","RELEASED","EXPIRED"],"description":"The status of the reservation."},"expiresAt":{"type":"string","format":"date-time","description":"When the reservation expires. Unreleased credits return to the balance at this time."}},"required":["id","amount","status","expiresAt"],"description":"The reservation created by this request, when it asked to reserve credits and was granted."}]}}}]},"isRequired":true,"uniqueKey":"data.entitlements.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.entitlements","typeLabel":"object[] | null"},"checkoutBillingId":{"type":"string","maxLength":255,"description":"Checkout billing ID when payment is required","uniqueKey":"data.checkoutBillingId","typeLabel":"string"},"checkoutUrl":{"type":"string","maxLength":2048,"description":"URL to complete payment when PAYMENT_REQUIRED","uniqueKey":"data.checkoutUrl","typeLabel":"string"},"isScheduled":{"type":"boolean","description":"Whether the subscription is scheduled for future activation","uniqueKey":"data.isScheduled","typeLabel":"boolean"}},"required":["id","status","subscription","entitlements"],"title":"ProvisionSubscriptionResult","description":"Provisioning result with status and subscription or checkout URL.","isRequired":true,"uniqueKey":"data","typeLabel":"ProvisionSubscriptionResult · object"}},"required":["data"],"title":"Response","description":"Response object","uniqueKey":"","typeLabel":"Response · object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"\u003cstring>","status":"SUCCESS","subscription":{"id":"\u003cstring>","customerId":"\u003cstring>","billingId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","startDate":"2023-11-07T05:31:56Z","status":"PAYMENT_PENDING","pricingType":"FREE","paymentCollection":"NOT_REQUIRED","planId":"\u003cstring>","payingCustomerId":"\u003cstring>","resourceId":"\u003cstring>","contractId":"\u003cstring>","endDate":"2023-11-07T05:31:56Z","effectiveEndDate":"2023-11-07T05:31:56Z","cancellationDate":"2023-11-07T05:31:56Z","trialEndDate":"2023-11-07T05:31:56Z","cancelReason":"UPGRADE_OR_DOWNGRADE","metadata":{},"currentBillingPeriodStart":"2023-11-07T05:31:56Z","currentBillingPeriodEnd":"2023-11-07T05:31:56Z","paymentCollectionMethod":"CHARGE","billingCycleAnchor":"2023-11-07T05:31:56Z","prices":[],"addons":[],"coupons":[],"futureUpdates":[],"budget":{"limit":123,"hasSoftLimit":true},"minimumSpend":{"amount":123,"currency":"usd"},"subscriptionEntitlements":[],"latestInvoice":{"billingId":"\u003cstring>","status":"OPEN","createdAt":"2023-11-07T05:31:56Z","requiresAction":true,"total":123,"amountDue":123,"currency":"\u003cstring>","pdfUrl":"\u003cstring>","billingReason":"BILLING_CYCLE"},"trial":{"trialEndBehavior":"CONVERT_TO_PAID"}},"entitlements":[{"isGranted":true,"type":"FEATURE","accessDeniedReason":"FeatureNotFound","feature":{"id":"\u003cstring>","displayName":"\u003cstring>","featureType":"BOOLEAN","featureStatus":"NEW"},"usageLimit":1,"hasUnlimitedUsage":true,"resetPeriod":"YEAR","currentUsage":1,"usagePeriodAnchor":"2023-11-07T05:31:56Z","usagePeriodStart":"2023-11-07T05:31:56Z","usagePeriodEnd":"2023-11-07T05:31:56Z","entitlementUpdatedAt":"2023-11-07T05:31:56Z","validUntil":"2023-11-07T05:31:56Z"}],"checkoutBillingId":"\u003cstring>","checkoutUrl":"\u003cstring>","isScheduled":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"92aa1efd-eec1-44be-bfc1-02a4c8184d67":{"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","EntityNotFound","EntityTypeNotFound","EntityTypeArchived","EntityTypeHasActiveEntities","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","InvoicePreviewNotAvailableForFailedContractPublish"],"isRequired":true,"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["BadUserInput","EntityNotFound","EntityTypeNotFound","EntityTypeArchived","EntityTypeHasActiveEntities","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","InvoicePreviewNotAvailableForFailedContractPublish"],"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"},"3e6d9ae7-3833-40eb-84eb-8a61e4a87647":{"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"},"431ef208-1a61-497e-a8b5-890caff94f10":{"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"},"bbe6359d-ac5f-4801-b928-a65b7c2844bc":{"description":"Subscription conflict error.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","enum":["DuplicatedEntityNotAllowed","EntitlementBelongsToFeatureGroupError","ReservationConflict","ReservationExpired","EntityHasChildren","EntityHierarchyCycle","EntityHierarchyDepthExceeded"],"isRequired":true,"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["DuplicatedEntityNotAllowed","EntitlementBelongsToFeatureGroupError","ReservationConflict","ReservationExpired","EntityHasChildren","EntityHierarchyCycle","EntityHierarchyDepthExceeded"],"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":"DuplicatedEntityNotAllowed"}}},"exampleType":"generated"}},"exampleType":"generated"},"b6a285fa-d33f-428c-8b75-e187d15d5e6b":{"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":{"8e55133f-c13b-41c1-b14e-4830e2f798c1":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"Server API Key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"9155880b-7d06-47e2-972e-fa125ff7d65c":{"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":"Create Subscription - Stigg","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-08T16:30:55.553Z","originalFileLocation":"api-and-sdks/api-reference/rest/subscriptions-create.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=\"Creates a new subscription for an existing customer. When payment is required and no payment method exists, returns a checkout URL.\">\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=\"Create Subscription - Stigg\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new subscription for an existing customer. When payment is required and no payment method exists, returns a checkout URL.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Stigg\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.stigg.io/api-and-sdks/api-reference/rest/subscriptions-create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://stigg.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Create+Subscription\u0026amp;description=Creates+a+new+subscription+for+an+existing+customer.+When+payment+is+required+and+no+payment+method+exists%2C+returns+a+checkout+URL.\u0026amp;theme=95c7681964b0230df066a164\u0026amp;signature=2eb8d8ec8db22363146989a08b7c25d1b172b0725c210503baa0ee06056e3a98\">\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=\"Create Subscription - Stigg\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new subscription for an existing customer. When payment is required and no payment method exists, returns a checkout URL.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://stigg.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Create+Subscription\u0026amp;description=Creates+a+new+subscription+for+an+existing+customer.+When+payment+is+required+and+no+payment+method+exists%2C+returns+a+checkout+URL.\u0026amp;theme=95c7681964b0230df066a164\u0026amp;signature=2eb8d8ec8db22363146989a08b7c25d1b172b0725c210503baa0ee06056e3a98\">\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-and-sdks/api-reference/rest/subscriptions-create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-and-sdks/api-reference/rest/subscriptions-create.md\">\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","groups":[{"group":"Introduction","pages":[{"title":"Welcome to Stigg","sidebarTitle":"What's Stigg","href":"/documentation/getting-started/welcome-to-stigg"},{"title":"What problem Stigg solves","href":"/documentation/introduction/the-problem"},{"title":"How and why Stigg's approach works","href":"/documentation/introduction/how-stigg-solves-it"},{"title":"Core concepts","href":"/documentation/getting-started/core-concepts"}]},{"group":"Get started","pages":[{"title":"Get started with AI","sidebarTitle":"With AI","href":"/documentation/getting-started/get-started-with-ai"},{"title":"Get started with the SDKs","sidebarTitle":"With SDKs","href":"/documentation/getting-started/get-started-with-sdks"},{"title":"Get started with the API","sidebarTitle":"With API","href":"/documentation/getting-started/get-started-with-api"},{"title":"Get started with the CLI","sidebarTitle":"With CLI","href":"/api-and-sdks/cli"},{"title":"Quickstart per use case","url":"/guides/quick-start-guides/provisioning-customers","href":"/documentation/getting-started/quickstart"},{"title":"Go-live checklist","href":"/documentation/go-live/go-live-checklist"}]},{"group":"Usage metering","pages":[{"title":"Overview","href":"/documentation/getting-usage-data-into-stigg/overview"},{"title":"Choosing an ingestion method","href":"/documentation/getting-usage-data-into-stigg/choosing-an-ingestion-method"},{"group":"Reporting usage","pages":[{"title":"Reporting calculated usage","href":"/documentation/getting-usage-data-into-stigg/reporting-calculated-usage"},{"title":"Reporting raw events","href":"/documentation/getting-usage-data-into-stigg/reporting-raw-events/index"}]},{"group":"Ingestion connectors","pages":[{"title":"Ingestion from AWS S3","href":"/documentation/getting-usage-data-into-stigg/reporting-raw-events/ingestion-from-cloud-storage"},{"title":"Ingestion from GCP Pub/Sub","href":"/documentation/getting-usage-data-into-stigg/reporting-raw-events/ingestion-from-gcp"}]},{"group":"Working with reported usage","pages":[{"title":"Viewing usage events","href":"/documentation/getting-usage-data-into-stigg/viewing-usage-events"},{"title":"Handling reported usage","href":"/documentation/getting-usage-data-into-stigg/handling-reported-usage"}]},{"title":"Scalability and durability","href":"/documentation/getting-usage-data-into-stigg/metering-scalability-and-durability"}]},{"group":"Credits","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/credits/overview"},{"group":"Concepts","pages":[{"title":"Core concepts","href":"/documentation/modeling-your-pricing-in-stigg/credits/credits-core-concepts"},{"title":"Credit currency","href":"/documentation/modeling-your-pricing-in-stigg/credits/credit-types"},{"title":"Credit consumption logic","href":"/documentation/modeling-your-pricing-in-stigg/credits/credit-consumption-logic"}]},{"group":"Ways to grant credits","pages":[{"title":"Prepaid credits","href":"/documentation/modeling-your-pricing-in-stigg/credits/prepaid-credits"},{"title":"Recurring credits","href":"/documentation/modeling-your-pricing-in-stigg/credits/recurring-credits"},{"title":"Credits charge","href":"/documentation/modeling-your-pricing-in-stigg/plans/defining-plan-pricing/paid/charges/credits-charge"},{"title":"Credit entitlements","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/assigning-features-to-add-ons/credits"}]},{"group":"Consumption and pools","pages":[{"title":"Custom credit consumption formulas","href":"/documentation/modeling-your-pricing-in-stigg/credits/custom-formula"},{"title":"Seat-based credit pools","href":"/documentation/modeling-your-pricing-in-stigg/credits/seat-based-credit-pools"},{"title":"Resource-specific credit pools","href":"/documentation/modeling-your-pricing-in-stigg/credits/resource-specific-pools"},{"title":"Reserve and settle","href":"/documentation/modeling-your-pricing-in-stigg/credits/reserve-and-settle"}]},{"group":"Managing balances","pages":[{"title":"Customer credits","href":"/documentation/modeling-your-pricing-in-stigg/credits/customer-credits"},{"title":"Adjust credit balance","href":"/documentation/modeling-your-pricing-in-stigg/credits/adjust-credits"},{"title":"Enable self-serve top-ups","href":"/documentation/modeling-your-pricing-in-stigg/credits/self-service-top-up"},{"group":"Auto-recharge","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/credits/auto-recharge/overview"},{"title":"Viewing auto-recharge status per customer","href":"/documentation/modeling-your-pricing-in-stigg/credits/auto-recharge/viewing-auto-recharge"},{"title":"Configuring credit auto-recharge","href":"/documentation/modeling-your-pricing-in-stigg/credits/auto-recharge/configuring-auto-recharge"}]}]},{"group":"Billing and revenue","pages":[{"title":"Integrate credits with your billing provider","href":"/documentation/modeling-your-pricing-in-stigg/credits/integrate-credits-with-billing"},{"title":"Recognize revenue from credits","href":"/documentation/modeling-your-pricing-in-stigg/credits/recognize-credit-revenue"}]}]},{"group":"Entitlements and access enforcement","pages":[{"title":"How entitlement checks work","sidebarTitle":"Overview","href":"/documentation/managing-customers-and-subscriptions/entitlements/how-entitlement-checks-work"},{"group":"Concepts","pages":[{"title":"What is an entitlement","href":"/documentation/managing-customers-and-subscriptions/entitlements/overview"},{"title":"Features","href":"/documentation/managing-customers-and-subscriptions/entitlements/feature-types"},{"title":"How entitlements are calculated","href":"/documentation/managing-customers-and-subscriptions/entitlements/entitlement-calculation"},{"title":"Usage reset","href":"/documentation/managing-customers-and-subscriptions/entitlements/usage-reset"},{"title":"Package versioning","href":"/documentation/managing-customers-and-subscriptions/entitlements/package-versioning"},{"title":"Add-ons and promotional entitlements","href":"/documentation/managing-customers-and-subscriptions/entitlements/granting-additional-access"}]},{"group":"Checking entitlements in your app","pages":[{"title":"Best practices","href":"/documentation/managing-customers-and-subscriptions/entitlements/best-practices"},{"title":"Caching","href":"/documentation/managing-customers-and-subscriptions/entitlements/caching"},{"title":"Fallback strategy","href":"/documentation/managing-customers-and-subscriptions/entitlements/fallback-strategy"}]}]},{"group":"Governance","pages":[{"title":"Overview","href":"/documentation/governance/overview"},{"title":"Core concepts","href":"/documentation/governance/core-concepts"},{"group":"Setting up governance","pages":[{"title":"Set up governance via the Stigg app","sidebarTitle":"Via the Stigg app","href":"/documentation/governance/setting-up/stigg-app"},{"title":"Set up governance via the SDK","sidebarTitle":"Via the SDK","href":"/documentation/governance/setting-up/sdk"},{"title":"Set up governance via the REST API","sidebarTitle":"Via the REST API","href":"/documentation/governance/setting-up/rest-api"}]},{"title":"Check and ingest","href":"/documentation/governance/check-and-ingest"},{"title":"Query the governance tree","href":"/documentation/governance/query"}]},{"group":"AI agents","pages":[{"title":"AI agents","sidebarTitle":"Overview","href":"/documentation/ai-agents/overview"},{"title":"Usage metering","href":"/documentation/ai-agents/usage-metering"},{"title":"Access enforcement","href":"/documentation/ai-agents/access-enforcement"},{"title":"Usage governance","href":"/documentation/ai-agents/usage-governance"},{"group":"Providers and frameworks","pages":[{"title":"Providers and frameworks","sidebarTitle":"Overview","href":"/documentation/ai-agents/providers/overview"},{"group":"Providers","pages":[{"title":"Anthropic","href":"/documentation/ai-agents/providers/anthropic"},{"title":"OpenAI","href":"/documentation/ai-agents/providers/openai"},{"title":"Google Gemini","sidebarTitle":"Gemini","href":"/documentation/ai-agents/providers/gemini"},{"title":"Mistral","href":"/documentation/ai-agents/providers/mistral"},{"title":"Groq","href":"/documentation/ai-agents/providers/groq"},{"title":"xAI","href":"/documentation/ai-agents/providers/xai"},{"title":"DeepSeek","href":"/documentation/ai-agents/providers/deepseek"},{"title":"Perplexity","href":"/documentation/ai-agents/providers/perplexity"},{"title":"Together AI","href":"/documentation/ai-agents/providers/together"},{"title":"Fireworks AI","href":"/documentation/ai-agents/providers/fireworks"},{"title":"Ollama","href":"/documentation/ai-agents/providers/ollama"},{"title":"vLLM","href":"/documentation/ai-agents/providers/vllm"},{"title":"TypeSafe","href":"/documentation/ai-agents/providers/typesafe"}]},{"group":"AI gateways","pages":[{"title":"OpenRouter","href":"/documentation/ai-agents/providers/openrouter"},{"title":"LiteLLM Proxy","href":"/documentation/ai-agents/providers/litellm"},{"title":"Amazon Bedrock","sidebarTitle":"Bedrock","href":"/documentation/ai-agents/providers/bedrock"},{"title":"Cloudflare","href":"/documentation/ai-agents/providers/cloudflare"},{"title":"Databricks","href":"/documentation/ai-agents/providers/databricks"},{"title":"agentgateway","href":"/documentation/ai-agents/providers/agentgateway"}]},{"group":"Frameworks","pages":[{"title":"Vercel AI SDK","href":"/documentation/ai-agents/orchestrators/vercel-ai-sdk"},{"title":"LangChain and LangGraph","href":"/documentation/ai-agents/orchestrators/langchain"},{"title":"Google ADK","href":"/documentation/ai-agents/orchestrators/google-adk"}]},{"title":"Bring your own vendor or framework","sidebarTitle":"Bring your own","href":"/documentation/ai-agents/providers/custom"}]}]},{"group":"Architecture and deployment","pages":[{"group":"Availability and scale","pages":[{"title":"High availability architecture","href":"/documentation/high-availability-and-scale/high-availability-architecture"},{"title":"Errors, retries, and usage buffering","href":"/documentation/high-availability-and-scale/errors-retries-and-usage-buffering"},{"title":"Accessible from anywhere","href":"/documentation/high-availability-and-scale/accessible-from-everywhere"},{"title":"Local caching and fallback strategy","href":"/documentation/high-availability-and-scale/local-caching-and-fallback-strategy"},{"title":"Persistent cache","href":"/documentation/high-availability-and-scale/persistent-caching"},{"title":"Reliability, observability and monitoring","href":"/documentation/high-availability-and-scale/reliability-observability-monitoring"},{"title":"Network requirements and whitelisting","href":"/api-and-sdks/integration/additional-deployment-methods/network-requirements"},{"title":"Bring Your Own Solution","href":"/api-and-sdks/integration/additional-deployment-methods/bring-your-own-solution"}]},{"group":"Sidecar","pages":[{"title":"Sidecar Overview","href":"/documentation/high-availability-and-scale/sidecar/overview"},{"title":"Sidecar architecture and scaling","sidebarTitle":"Architecture and scaling","href":"/documentation/high-availability-and-scale/sidecar/architecture"},{"title":"Running the Sidecar service","sidebarTitle":"Running the Sidecar","href":"/documentation/high-availability-and-scale/sidecar/running-sidecar"},{"title":"Running Sidecar in production","href":"/documentation/high-availability-and-scale/sidecar/running-in-production"},{"title":"Persistent cache, fallback, and offline mode","sidebarTitle":"Cache, fallback, and offline mode","href":"/documentation/high-availability-and-scale/sidecar/resilience"},{"title":"Sidecar monitoring and troubleshooting","sidebarTitle":"Monitoring and troubleshooting","href":"/documentation/high-availability-and-scale/sidecar/service-monitoring"},{"title":"Service schema","href":"/documentation/high-availability-and-scale/sidecar/service-schema"}]},{"group":"BYOC","pages":[{"title":"Bring Your Own Cloud (BYOC)","href":"/documentation/high-availability-and-scale/byoc/overview"},{"title":"BYOC architecture","href":"/documentation/high-availability-and-scale/byoc/architecture"},{"title":"Installation","href":"/documentation/high-availability-and-scale/byoc/installation"},{"title":"Deployment and operations","href":"/documentation/high-availability-and-scale/byoc/deployment-and-operations"},{"title":"Networking, security, and data flow","href":"/documentation/high-availability-and-scale/byoc/networking-and-security"},{"title":"Observability and debugging","href":"/documentation/high-availability-and-scale/byoc/observability-and-debugging"},{"title":"Scaling and reliability","href":"/documentation/high-availability-and-scale/byoc/scaling-and-reliability"},{"title":"Metering architecture","href":"/documentation/high-availability-and-scale/byoc/metering-architecture"}]}]},{"group":"Pricing and packaging","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/overview"},{"title":"Usage-based pricing models","href":"/documentation/modeling-your-pricing-in-stigg/usage-based-pricing-models"},{"group":"Features","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/features/overview"},{"title":"Viewing the list of available features","href":"/documentation/modeling-your-pricing-in-stigg/features/viewing-available-features"},{"title":"Viewing feature usage across plans and add-ons","href":"/documentation/modeling-your-pricing-in-stigg/features/viewing-feature-usage"},{"group":"Creating features","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/features/creating-features/overview"},{"title":"Boolean features","href":"/documentation/modeling-your-pricing-in-stigg/features/creating-features/boolean-features"},{"title":"Configuration features","href":"/documentation/modeling-your-pricing-in-stigg/features/creating-features/configuration-features"},{"title":"Metered features","href":"/documentation/modeling-your-pricing-in-stigg/features/creating-features/metered-features"},{"title":"Importing an existing list of features","href":"/documentation/modeling-your-pricing-in-stigg/features/creating-features/importing-list-of-features"}]},{"title":"Storing metadata","href":"/documentation/modeling-your-pricing-in-stigg/features/storing-metadata"},{"title":"Editing feature details","href":"/documentation/modeling-your-pricing-in-stigg/features/editing-feature-details"},{"title":"Revoking access to features","href":"/documentation/modeling-your-pricing-in-stigg/features/revoking-access-features"},{"title":"Archiving features","href":"/documentation/modeling-your-pricing-in-stigg/features/archiving-features"},{"title":"Unarchiving features","href":"/documentation/modeling-your-pricing-in-stigg/features/unarchiving-features"},{"group":"Feature groups","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/features/feature-groups/overview"},{"title":"Creating feature groups","href":"/documentation/modeling-your-pricing-in-stigg/features/feature-groups/creating-feature-group"},{"title":"Updating feature groups","href":"/documentation/modeling-your-pricing-in-stigg/features/feature-groups/updating-feature-group"},{"title":"Adding feature groups to entitlements","href":"/documentation/modeling-your-pricing-in-stigg/features/feature-groups/adding-feature-group-entitlements"},{"title":"Archiving feature groups","href":"/documentation/modeling-your-pricing-in-stigg/features/feature-groups/archiving-feature-group"}]}]},{"group":"Products","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/products/overview"},{"title":"Viewing a list of products","href":"/documentation/modeling-your-pricing-in-stigg/products/viewing-list-of-products"},{"title":"Creating products","href":"/documentation/modeling-your-pricing-in-stigg/products/creating-products"},{"title":"Modeling your pricing","href":"/documentation/modeling-your-pricing-in-stigg/products/modeling-pricing"},{"title":"Defining the customer journey","href":"/documentation/modeling-your-pricing-in-stigg/products/defining-customer-journey"},{"title":"Storing metadata","href":"/documentation/modeling-your-pricing-in-stigg/products/storing-metadata"},{"title":"Editing product details","href":"/documentation/modeling-your-pricing-in-stigg/products/editing-product-details"},{"title":"Archiving products","href":"/documentation/modeling-your-pricing-in-stigg/products/archiving-products"}]},{"group":"Plans","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/plans/plans"},{"title":"Viewing a list of plans","href":"/documentation/modeling-your-pricing-in-stigg/plans/viewing-plans-list"},{"title":"Creating plans","href":"/documentation/modeling-your-pricing-in-stigg/plans/creating-plans"},{"group":"Plans pricing","pages":[{"title":"Defining the plans price","href":"/documentation/modeling-your-pricing-in-stigg/plans/defining-plan-pricing/defining-plan-price"},{"title":"Free plans","href":"/documentation/modeling-your-pricing-in-stigg/plans/defining-plan-pricing/free"},{"group":"Paid plans","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/plans/defining-plan-pricing/paid/paid"},{"title":"Billing period","href":"/documentation/modeling-your-pricing-in-stigg/plans/defining-plan-pricing/paid/billing-period"},{"group":"Charges","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/plans/defining-plan-pricing/paid/charges/charges"},{"title":"Base charge","href":"/documentation/modeling-your-pricing-in-stigg/plans/defining-plan-pricing/paid/charges/base-charge"},{"group":"Usage-based charge","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/plans/defining-plan-pricing/paid/charges/usage-based"},{"title":"In-advance commitment","href":"/documentation/modeling-your-pricing-in-stigg/plans/defining-plan-pricing/paid/charges/in-advance"},{"title":"Pay-as-you-go","href":"/documentation/modeling-your-pricing-in-stigg/plans/defining-plan-pricing/paid/charges/payg"}]}]},{"title":"Minimum spend","href":"/documentation/modeling-your-pricing-in-stigg/plans/defining-plan-pricing/paid/charges/minimum-spend"},{"title":"Free trial periods","href":"/documentation/modeling-your-pricing-in-stigg/plans/defining-plan-pricing/paid/charges/free-trials"},{"group":"Overages","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/plans/overages/overview"},{"title":"How overages work","href":"/documentation/modeling-your-pricing-in-stigg/plans/overages/working-principle"},{"title":"Supported overage models","href":"/documentation/modeling-your-pricing-in-stigg/plans/overages/supported-models"},{"title":"Defining overages","href":"/documentation/modeling-your-pricing-in-stigg/plans/overages/defining-overages"},{"title":"Notifications and webhooks","href":"/documentation/modeling-your-pricing-in-stigg/plans/overages/notifications"}]}]},{"group":"Custom plans","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/plans/custom-plans"},{"title":"Defining variable entitlement values","href":"/documentation/modeling-your-pricing-in-stigg/plans/variable-entitlement-values"}]}]},{"title":"Adding entitlements to plans","href":"/documentation/modeling-your-pricing-in-stigg/plans/assigning-features-plans"},{"title":"Plan visibility","href":"/documentation/modeling-your-pricing-in-stigg/plans/plan-visibility"},{"title":"Plan metadata","href":"/documentation/modeling-your-pricing-in-stigg/plans/plan-metadata"},{"title":"Publishing plans","href":"/documentation/modeling-your-pricing-in-stigg/plans/publishing-plans"},{"title":"Viewing plans history","href":"/documentation/modeling-your-pricing-in-stigg/plans/viewing-plans-history"},{"title":"Archiving plans","href":"/documentation/modeling-your-pricing-in-stigg/plans/archiving-plans"},{"title":"Subscription migration methods","href":"/documentation/modeling-your-pricing-in-stigg/plans/migrating-plans"}]},{"group":"Add-ons","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/overview"},{"title":"Viewing the list of add-ons","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/viewing-list-add-ons"},{"title":"Creating add-ons","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/creating-add-ons"},{"group":"Add-on pricing","pages":[{"title":"Defining the add-ons price","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/defining-add-on-price"},{"group":"Paid add-ons","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/paid/overview"},{"title":"Billing period","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/paid/billing-period"},{"title":"Charges","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/paid/charges"}]},{"title":"Custom add-ons","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/custom-add-ons"}]},{"group":"Assigning features to add-ons","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/assigning-features-to-add-ons/overview"},{"title":"Boolean features","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/assigning-features-to-add-ons/boolean"},{"title":"Configuration features","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/assigning-features-to-add-ons/configuration"},{"title":"Metered features","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/assigning-features-to-add-ons/metered"},{"title":"Entitlement behavior","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/assigning-features-to-add-ons/entitlement-behavior"},{"title":"Revoking entitlements","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/assigning-features-to-add-ons/revoking-entitlements"}]},{"title":"Controlling the add-on visibility","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/controlling-add-on-visibility"},{"title":"Storing metadata","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/storing-metadata"},{"title":"Publishing add-ons","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/publishing-add-ons"},{"title":"Defining add-on compatibility with specific plans","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/defining-compatibility"},{"title":"Editing published add-ons","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/editing-published-add-ons"},{"title":"Archiving add-ons","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/archiving-add-ons"},{"title":"Unarchiving add-ons","href":"/documentation/modeling-your-pricing-in-stigg/add-ons/unarchiving-add-ons"}]},{"group":"Coupons","pages":[{"title":"Overview","href":"/documentation/modeling-your-pricing-in-stigg/coupons/coupons"},{"title":"Viewing the list of coupons","href":"/documentation/modeling-your-pricing-in-stigg/coupons/viewing-list-of-coupons"},{"title":"Creating coupons","href":"/documentation/modeling-your-pricing-in-stigg/coupons/creating-coupons"},{"title":"Applying coupons","href":"/documentation/modeling-your-pricing-in-stigg/coupons/applying-coupons"},{"title":"Applying discounts to subscriptions","href":"/documentation/modeling-your-pricing-in-stigg/coupons/applying-discounts-to-subscriptions"},{"title":"Editing coupon details","href":"/documentation/modeling-your-pricing-in-stigg/coupons/editing-coupon-details"},{"title":"Storing metadata","href":"/documentation/modeling-your-pricing-in-stigg/coupons/storing-metadata"},{"title":"Archiving coupons","href":"/documentation/modeling-your-pricing-in-stigg/coupons/archiving-coupons"}]},{"group":"Price localization","pages":[{"title":"Price localization overview","href":"/documentation/price-localization/price-localization"},{"title":"No-code configuration in the Stigg app","href":"/documentation/price-localization/price-localization-no-code-configuration"},{"title":"Implementing price localization on your public website and application","href":"/documentation/price-localization/price-localization-codebase-integration"},{"title":"Localized billing","href":"/documentation/price-localization/price-localization-billing"},{"title":"Serving countries that pay in EUR","href":"/documentation/price-localization/price-localization-eurozone"}]},{"group":"Pricing insights and experiments","pages":[{"group":"Gaining insights about your pricing strategy","pages":[{"title":"Gaining insights about your pricing strategy","href":"/documentation/rolling-out-pricing-changes-with-confidence/dashboard"},{"title":"Active subscriptions","href":"/documentation/rolling-out-pricing-changes-with-confidence/active-subscriptions-dashboard"},{"title":"Feature inspector","href":"/documentation/rolling-out-pricing-changes-with-confidence/feature-inspector"}]},{"title":"Running pricing experiments","href":"/documentation/rolling-out-pricing-changes-with-confidence/experiments"}]}]},{"group":"Customers, subscriptions and contracts","pages":[{"group":"Customers","pages":[{"title":"Viewing the list of customers","href":"/documentation/managing-customers-and-subscriptions/customers/viewing-customers"},{"title":"Creating a new customer","href":"/documentation/managing-customers-and-subscriptions/customers/creating-customers"},{"title":"Applying customer-level coupons","href":"/documentation/managing-customers-and-subscriptions/customers/applying-coupon"},{"title":"Managing customers subscriptions","href":"/documentation/managing-customers-and-subscriptions/customers/manage-customer-subscription"},{"title":"Managing customers promotional entitlements","href":"/documentation/managing-customers-and-subscriptions/customers/managing-customers-promotional-entitlements"},{"group":"Entitlement usage","pages":[{"title":"Viewing customers entitlement usage","href":"/documentation/managing-customers-and-subscriptions/customers/viewing-customers-entitlement-usage"},{"title":"Viewing customers entitlement summary","href":"/documentation/managing-customers-and-subscriptions/customers/viewing-customers-entitlement-summary"},{"title":"Reporting entitlement usage","href":"/documentation/managing-customers-and-subscriptions/customers/reporting-entitlement-usage"}]},{"title":"Storing metadata","href":"/documentation/managing-customers-and-subscriptions/customers/storing-metadata"},{"title":"Editing customer details","href":"/documentation/managing-customers-and-subscriptions/customers/editing-customer-details"},{"title":"Managing customers payment methods","href":"/documentation/managing-customers-and-subscriptions/customers/managing-customers-payment-method"},{"title":"Archiving a customer","href":"/documentation/managing-customers-and-subscriptions/customers/archiving-customers"},{"title":"Unarchiving a customer","href":"/documentation/managing-customers-and-subscriptions/customers/unarchiving-customers"}]},{"group":"Subscriptions","pages":[{"title":"Viewing the list of subscriptions of a specific customer","href":"/documentation/managing-customers-and-subscriptions/subscriptions/viewing-list-subscriptions"},{"title":"Subscription statuses","href":"/documentation/managing-customers-and-subscriptions/subscriptions/subscription-statuses"},{"title":"Provisioning subscriptions","href":"/documentation/managing-customers-and-subscriptions/subscriptions/provisioning-subscriptions"},{"title":"Viewing the details of a specific subscription","href":"/documentation/managing-customers-and-subscriptions/subscriptions/viewing-details"},{"title":"Storing metadata","href":"/documentation/managing-customers-and-subscriptions/subscriptions/storing-metadata"},{"title":"Updating subscriptions","href":"/documentation/managing-customers-and-subscriptions/subscriptions/updating-subscriptions"},{"group":"Subscription updates","pages":[{"title":"Overview","href":"/documentation/managing-customers-and-subscriptions/subscription-updates/overview"},{"title":"Subscription upgrades","href":"/documentation/managing-customers-and-subscriptions/subscription-updates/subscription-upgrades"},{"title":"Subscription downgrades","href":"/documentation/managing-customers-and-subscriptions/subscription-updates/subscription-downgrades"},{"title":"Immediate downgrades","href":"/documentation/managing-customers-and-subscriptions/subscription-updates/immediate-downgrades"},{"title":"Scheduled updates","href":"/documentation/managing-customers-and-subscriptions/subscription-updates/scheduled-updates"},{"title":"Scheduled downgrades","href":"/documentation/managing-customers-and-subscriptions/subscription-updates/scheduled-downgrades"},{"title":"Updates to subscriptions with usage-based pricing","href":"/documentation/managing-customers-and-subscriptions/subscription-updates/updates-subscriptions-usage-based"},{"title":"Conversion of free trials to paid subscriptions","href":"/documentation/managing-customers-and-subscriptions/subscription-updates/converting-free-trials-paid"},{"title":"Additional resources","href":"/documentation/managing-customers-and-subscriptions/subscription-updates/additional-resources"}]},{"title":"Canceling subscriptions","href":"/documentation/managing-customers-and-subscriptions/subscriptions/canceling-subscriptions"},{"title":"Canceling scheduled updates","href":"/documentation/managing-customers-and-subscriptions/subscriptions/canceling-scheduled-updates"},{"title":"Handling payment errors","href":"/documentation/managing-customers-and-subscriptions/subscriptions/handling-payment-errors"},{"title":"Migrating subscriptions to the latest plan or add-on version","href":"/documentation/managing-customers-and-subscriptions/subscriptions/migrating-subscriptions"},{"title":"Multiple active subscriptions","href":"/documentation/managing-customers-and-subscriptions/subscriptions/multiple-active-subscriptions"}]},{"group":"Contracts","pages":[{"title":"Overview","href":"/documentation/managing-customers-and-subscriptions/contracts/overview"},{"title":"Setting up a contract","href":"/documentation/managing-customers-and-subscriptions/contracts/setup-flow"},{"title":"Usage-based billing","href":"/documentation/managing-customers-and-subscriptions/contracts/usage-based-billing"},{"title":"Invoice management","href":"/documentation/managing-customers-and-subscriptions/contracts/invoice-management"},{"title":"Managing the legal entity","href":"/documentation/managing-customers-and-subscriptions/contracts/legal-entity"}]}]},{"group":"Workflows","pages":[{"title":"Overview","href":"/documentation/workflows/overview"},{"title":"Key concepts","href":"/documentation/workflows/workflows-key-concepts"},{"group":"Building workflows","pages":[{"title":"Creating a workflow","href":"/documentation/workflows/workflow-creation"},{"title":"Triggers","href":"/documentation/workflows/workflow-triggers"},{"title":"Conditions","href":"/documentation/workflows/workflow-conditions"},{"title":"Expressions","href":"/documentation/workflows/workflow-expressions"},{"title":"Actions","href":"/documentation/workflows/workflow-actions"}]},{"group":"Running and managing","pages":[{"title":"Execution history","href":"/documentation/workflows/workflow-execution-history"},{"title":"Activity Log","href":"/documentation/workflows/workflow-activity-log"},{"title":"Error handling","href":"/documentation/workflows/error-handling"},{"title":"Managing workflows","href":"/documentation/workflows/managing-workflows"},{"title":"Managing credentials","href":"/documentation/workflows/managing-workflow-credentials"}]}]},{"group":"Widgets","pages":[{"title":"Overview","href":"/documentation/snap-in-widgets/overview"},{"title":"Storybook","href":"/documentation/snap-in-widgets/storybook"},{"title":"Pricing table","href":"/documentation/snap-in-widgets/pricing-table"},{"title":"Checkout","href":"/documentation/snap-in-widgets/checkout"},{"title":"Choosing a checkout experience","href":"/documentation/snap-in-widgets/choosing-a-checkout-experience"},{"title":"Customer portal","href":"/documentation/snap-in-widgets/customer-portal"},{"group":"Credits","pages":[{"title":"Credit balance","href":"/documentation/snap-in-widgets/credit-balance"},{"title":"Credit utilization","href":"/documentation/snap-in-widgets/credit-utilization"},{"title":"Credit usage chart","href":"/documentation/snap-in-widgets/credit-usage"},{"title":"Credit grants table","href":"/documentation/snap-in-widgets/credit-grants"},{"title":"Credit auto-recharge status","sidebarTitle":"Auto-recharge status","href":"/documentation/snap-in-widgets/credit-auto-recharge-status"},{"title":"Credit auto-recharge configuration","sidebarTitle":"Auto-recharge configuration","href":"/documentation/snap-in-widgets/credit-auto-recharge-configuration"}]}]},{"group":"Developer tools","pages":[{"title":"AI Terminal","href":"/api-and-sdks/ai-terminal"},{"title":"MCP Server","href":"/api-and-sdks/mcp-server"},{"title":"Agent Skills","href":"/api-and-sdks/agent-skills"}]},{"group":"Account management","pages":[{"group":"Account settings","pages":[{"title":"Account details","href":"/documentation/managing-your-account/account-details"},{"group":"Billing","pages":[{"title":"Managing your Stigg subscription","href":"/documentation/managing-your-account/billing/managing-your-subscription"},{"title":"Stigg plan limits and usage","href":"/documentation/managing-your-account/billing/plan-limits-and-usage"}]},{"title":"Theme","href":"/documentation/managing-your-account/theme"},{"title":"Switching accounts","href":"/documentation/managing-your-account/switching-accounts"}]},{"group":"Team and access","pages":[{"title":"Team members","href":"/documentation/managing-your-account/access-management/team-members"},{"title":"Role-based access control","href":"/documentation/managing-your-account/access-management/rbac"},{"title":"Invite-only login","href":"/documentation/managing-your-account/access-management/invite-only"},{"title":"Authorized domain","href":"/documentation/managing-your-account/access-management/authorized-domain"},{"title":"Single sign-on (SSO)","href":"/documentation/managing-your-account/access-management/single-sign-on"}]},{"group":"Environments","pages":[{"title":"Environments","sidebarTitle":"Overview","href":"/documentation/managing-your-account/environments/index"},{"title":"Copying changes between environments","href":"/documentation/managing-your-account/environments/copying-changes-between-environments"},{"title":"Download the product catalog","href":"/documentation/managing-your-account/environments/download-the-product-catalog"},{"title":"API Keys","href":"/documentation/managing-your-account/environments/api-keys"}]},{"group":"Finding and auditing","pages":[{"title":"Finding entities","href":"/documentation/managing-your-account/finding-entities"},{"title":"Activity log","href":"/documentation/managing-your-account/activity-log"},{"title":"Debugging requests with trace IDs","href":"/documentation/managing-your-account/debugging-with-trace-ids"}]}]},{"group":"Security \u0026 compliance","pages":[{"title":"Security Portal","href":"/documentation/security-compliance/security-portal"},{"title":"Data residency and PII","href":"/documentation/security-compliance/data-residency-and-pii"},{"title":"Terms of Use","href":"/documentation/security-compliance/terms-of-use"},{"title":"Privacy Policy","href":"/documentation/security-compliance/privacy-policy"}]}]},{"tab":"Guides","icon":"map","groups":[{"group":"Quick start","pages":[{"title":"Provisioning customers","href":"/guides/quick-start-guides/provisioning-customers"},{"title":"Provisioning subscriptions","href":"/guides/quick-start-guides/creating-subscriptions"},{"title":"Gating access to features","href":"/guides/quick-start-guides/gating-access-to-features"},{"title":"Rendering paywalls","href":"/guides/quick-start-guides/rendering-paywalls"},{"title":"Rendering custom paywalls","href":"/guides/quick-start-guides/rendering-custom-paywalls"},{"title":"Rendering a customer portal","href":"/guides/quick-start-guides/rendering-customer-portal"}]},{"group":"Credits","pages":[{"title":"Monetize my product using credits","href":"/guides/i-want-to/set-up-credits"},{"title":"Deduct credits directly","href":"/guides/i-want-to/deduct-credits-directly"},{"title":"Reserve and settle credits","href":"/guides/i-want-to/reserve-and-settle-credits"},{"title":"Charge credits for metered usage","href":"/guides/i-want-to/charge-credits-for-metered-usage"},{"title":"Monetize your product using recurring credits","href":"/guides/i-want-to/set-up-recurring-credits"},{"title":"Grant credits as entitlements in plans and add-ons","href":"/guides/i-want-to/grant-credits-in-plans-and-add-ons"},{"title":"Set up credits auto-recharge","href":"/guides/i-want-to/set-up-credits-auto-recharge"},{"title":"Notify customers about low credit balance","href":"/guides/i-want-to/notify-customers-about-low-credit-balance"},{"title":"Model OpenAI-style token pricing","href":"/guides/i-want-to/model-openai-style-token-pricing"}]},{"group":"AI agents","pages":[{"title":"Meter LLM token usage","href":"/guides/ai-agents/meter-llm-token-usage"},{"title":"Meter LLM gateway spend","href":"/guides/ai-agents/meter-llm-gateway-spend"},{"title":"Set budgets for AI agents","href":"/guides/ai-agents/set-budgets-for-ai-agents"},{"title":"Meter usage from your own gateway","href":"/guides/ai-agents/meter-usage-from-your-own-gateway"}]},{"group":"Entitlements and access enforcement","pages":[{"title":"Enforce metered feature limits","href":"/guides/i-want-to/enforce-metered-feature-limits"},{"title":"Implement a team plan with separate usage enforcement for each team member","href":"/guides/i-want-to/guide-team-plan"},{"title":"Gate API endpoints with AWS API Gateway","href":"/api-and-sdks/integration/additional-deployment-methods/aws-api-gateway"}]},{"group":"Pricing and packaging","pages":[{"title":"Implement a freemium model to increase conversion","href":"/guides/i-want-to/add-freemium"},{"title":"Configure hybrid pricing","href":"/guides/i-want-to/configure-hybrid-pricing"},{"group":"Trials","pages":[{"title":"Add a time-based trial experience to my product","href":"/guides/i-want-to/add-free-trials"},{"title":"Run a trial with add‑ons while keeping an active paid plan","href":"/guides/i-want-to/configure-trial-add-on"},{"title":"Launch a trial for a paid plan with unlimited usage-based features","href":"/guides/i-want-to/offer-unlimited-usage-during-trial"}]}]},{"group":"Subscriptions and billing","pages":[{"title":"Provision enterprise subscriptions","href":"/guides/i-want-to/provision-enterprise-subscriptions"},{"title":"Allow customers to have multiple subscriptions to the same product","href":"/guides/i-want-to/add-multiple-subscriptions"},{"title":"Allow customers to subscribe to my product using a payment link","href":"/guides/i-want-to/subscribe-using-payment-link"},{"title":"Bill customers using invoices","href":"/guides/i-want-to/bill-customers-using-invoices"}]},{"group":"Migration","pages":[{"title":"Migrate to Stigg from a legacy or in-house system","href":"/guides/i-want-to/migrate-from-legacy-systems"}]}]},{"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","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","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/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/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/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/entity-types/{id}/has-active-entities","href":"/api-reference/governance-entity-types/check-whether-an-entity-type-has-active-entities"}]},{"group":"Governance Entity Types (v1-beta)","pages":[{"title":"Get a list of entity types","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/entity-types","href":"/api-reference/governance-entity-types-v1-beta/get-a-list-of-entity-types"},{"title":"Upsert entity types","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1-beta/entity-types","href":"/api-reference/governance-entity-types-v1-beta/upsert-entity-types"},{"title":"Archive entity types","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1-beta/entity-types/archive","href":"/api-reference/governance-entity-types-v1-beta/archive-entity-types"},{"title":"Check whether an entity type has active entities","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/entity-types/{id}/has-active-entities","href":"/api-reference/governance-entity-types-v1-beta/check-whether-an-entity-type-has-active-entities"}]},{"group":"Governance Entities","pages":[{"title":"Get a list of entities","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/entities","href":"/api-reference/governance-entities/get-a-list-of-entities"},{"title":"Upsert entities","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1/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/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/customers/{id}/entities/archive","href":"/api-reference/governance-entities/archive-entities"}]},{"group":"Governance Entities (v1-beta)","pages":[{"title":"Get a list of entitys","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/entities","href":"/api-reference/governance-entities-v1-beta/get-a-list-of-entitys"},{"title":"Upsert entities","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1-beta/customers/{id}/entities","href":"/api-reference/governance-entities-v1-beta/upsert-entities"},{"title":"Get a single entity by ID","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/entities/{entityId}","href":"/api-reference/governance-entities-v1-beta/get-a-single-entity-by-id"},{"title":"Archive entities","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1-beta/customers/{id}/entities/archive","href":"/api-reference/governance-entities-v1-beta/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-v1-beta/unarchive-entities"}]},{"group":"Governance Entity Entitlements","pages":[{"title":"Get a list of entity entitlements","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/entities/entitlements","href":"/api-reference/governance-entity-entitlements/get-a-list-of-entity-entitlements"},{"title":"Upsert entity entitlements","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1/customers/{id}/entities/entitlements","href":"/api-reference/governance-entity-entitlements/upsert-entity-entitlements"}]},{"group":"Governance Assignments (v1-beta)","pages":[{"title":"Get a list of assignments","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/assignments","href":"/api-reference/governance-assignments-v1-beta/get-a-list-of-assignments"},{"title":"Upsert assignments","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1-beta/customers/{id}/assignments","href":"/api-reference/governance-assignments-v1-beta/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 (v1-beta)","pages":[{"title":"Check entitlement (beta)","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/entitlements/check","href":"/api-reference/governance-entitlements-check-v1-beta/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"}]},{"group":"Entity types","pages":[{"title":"Entity type created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity_type.created","href":"/api-reference/entity-types/entity-type-created"},{"title":"Entity type updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity_type.updated","href":"/api-reference/entity-types/entity-type-updated"}]},{"group":"Entities","pages":[{"title":"Entity created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity.created","href":"/api-reference/entities/entity-created"},{"title":"Entity updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity.updated","href":"/api-reference/entities/entity-updated"}]},{"group":"Entity entitlements","pages":[{"title":"Entity entitlement created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity.entitlement.created","href":"/api-reference/entity-entitlements/entity-entitlement-created"},{"title":"Entity entitlement updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity.entitlement.updated","href":"/api-reference/entity-entitlements/entity-entitlement-updated"},{"title":"Entity entitlement usage exceeded","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity.entitlement.usage_exceeded","href":"/api-reference/entity-entitlements/entity-entitlement-usage-exceeded"}]}]}]},{"tab":"Integrations","icon":"puzzle-piece","groups":[{"group":"Overview","pages":[{"title":"Integrations","href":"/documentation/native-integrations/overview"}]},{"group":"Billing","pages":[{"group":"Stripe","pages":[{"title":"Overview","href":"/documentation/native-integrations/billing/stripe/overview"},{"title":"Integration when using Stripe Elements for checkout","href":"/documentation/native-integrations/billing/stripe/integration-when-using-stripe-elements-for-checkout"},{"title":"Integration when using Stripe-hosted checkout","href":"/documentation/native-integrations/billing/stripe/integration-when-using-stripe-hosted-checkout"},{"title":"Stripe App Marketplace","href":"/documentation/native-integrations/billing/stripe/stripe-app-marketplace"},{"title":"Stripe Projects","href":"/documentation/native-integrations/billing/stripe/stripe-projects"}]},{"group":"Zuora","pages":[{"title":"Overview","href":"/documentation/native-integrations/billing/zuora/overview"},{"title":"Integration with Zuora payment form","href":"/documentation/native-integrations/billing/zuora/integration-with-zuora-payment-form"},{"title":"Defining bill runs in Zuora","href":"/documentation/native-integrations/billing/zuora/zuora-bill-runs"},{"title":"Import my Zuora catalog into Stigg","href":"/documentation/native-integrations/billing/zuora/import-zuora-catalog-into-stigg"},{"title":"Termed subscriptions","href":"/documentation/native-integrations/billing/zuora/termed-subscriptions"},{"title":"Zuora callouts and incoming events","href":"/documentation/native-integrations/billing/zuora/zuora-incoming-webhooks"},{"title":"Zuora APIs used by Stigg","href":"/documentation/native-integrations/billing/zuora/zuora-apis-used-by-stigg"}]},{"title":"Airwallex","href":"/documentation/native-integrations/billing/airwallex"},{"title":"Integration with multiple billing providers","href":"/documentation/native-integrations/billing/multiple-billing-provider-integration"}]},{"group":"CRM","pages":[{"group":"Salesforce","pages":[{"title":"Salesforce","href":"/documentation/native-integrations/crm/salesforce/salesforce"},{"title":"Set up the integration","href":"/documentation/native-integrations/crm/salesforce/salesforce-setup"},{"title":"Supported actions","href":"/documentation/native-integrations/crm/salesforce/salesforce-supported-actions"},{"title":"Automation flows","href":"/documentation/native-integrations/crm/salesforce/salesforce-create-automation-flows"},{"title":"Custom flows","href":"/documentation/native-integrations/crm/salesforce/salesforce-create-your-flow"},{"title":"Salesforce Remove Integration","href":"/documentation/native-integrations/crm/salesforce/salesforce-remove-integration"},{"title":"Changelog","href":"/documentation/native-integrations/crm/salesforce/salesforce-changelog"}]},{"group":"Hubspot","pages":[{"title":"HubSpot","href":"/documentation/native-integrations/crm/hubspot/index"},{"title":"Detailed entity mapping","href":"/documentation/native-integrations/crm/hubspot/hubspot-entity-mapping"},{"title":"Example - email automation for trial subscriptions","href":"/documentation/native-integrations/crm/hubspot/hubspot-example-email-automation-trial"}]}]},{"group":"Marketplaces","pages":[{"title":"AWS Marketplace","href":"/documentation/native-integrations/marketplaces/aws-marketplace"},{"title":"Apple App Store","href":"/documentation/native-integrations/marketplaces/apple-app-store"}]},{"group":"Data import","pages":[{"title":"Overview","href":"/documentation/importing-and-exporting-data/import/overview"},{"title":"Prerequisites","href":"/documentation/importing-and-exporting-data/import/prerequisites"},{"title":"Importing customers","href":"/documentation/importing-and-exporting-data/import/importing-customers"},{"title":"Importing subscriptions","href":"/documentation/importing-and-exporting-data/import/importing-subscriptions"},{"title":"Importing feature usage","href":"/documentation/importing-and-exporting-data/import/importing-feature-usage"}]},{"group":"Data export","pages":[{"title":"Overview","href":"/documentation/importing-and-exporting-data/export/overview"},{"title":"Schema","href":"/documentation/importing-and-exporting-data/export/schema"},{"title":"Upgrading your data export","href":"/documentation/importing-and-exporting-data/export/migration-guide"},{"title":"Snowflake","href":"/documentation/importing-and-exporting-data/export/snowflake"},{"title":"BigQuery","href":"/documentation/importing-and-exporting-data/export/bigquery"},{"title":"Amazon Redshift","href":"/documentation/importing-and-exporting-data/export/redshift"},{"title":"Amazon Redshift Serverless","href":"/documentation/importing-and-exporting-data/export/redshift-serverless"},{"title":"Amazon Athena","href":"/documentation/importing-and-exporting-data/export/athena"},{"title":"Amazon S3","href":"/documentation/importing-and-exporting-data/export/s3"},{"title":"Databricks","href":"/documentation/importing-and-exporting-data/export/databricks"},{"title":"ClickHouse","href":"/documentation/importing-and-exporting-data/export/clickhouse"},{"title":"SingleStore","href":"/documentation/importing-and-exporting-data/export/singlestore"},{"title":"MotherDuck","href":"/documentation/importing-and-exporting-data/export/motherduck"},{"title":"Delta Lake","href":"/documentation/importing-and-exporting-data/export/delta-lake"},{"title":"Apache Iceberg","href":"/documentation/importing-and-exporting-data/export/iceberg"},{"title":"PostgreSQL","href":"/documentation/importing-and-exporting-data/export/postgresql"},{"title":"MySQL","href":"/documentation/importing-and-exporting-data/export/mysql"},{"title":"Microsoft SQL Server","href":"/documentation/importing-and-exporting-data/export/mssql"},{"title":"Oracle","href":"/documentation/importing-and-exporting-data/export/oracle"},{"title":"Amazon Aurora (PostgreSQL)","href":"/documentation/importing-and-exporting-data/export/aurora-postgresql"},{"title":"Amazon Aurora (MySQL)","href":"/documentation/importing-and-exporting-data/export/aurora-mysql"},{"title":"MongoDB","href":"/documentation/importing-and-exporting-data/export/mongodb"},{"title":"Google Cloud Storage","href":"/documentation/importing-and-exporting-data/export/gcs"},{"title":"Azure Blob Storage","href":"/documentation/importing-and-exporting-data/export/azure-blob"},{"title":"S3-compatible storage","href":"/documentation/importing-and-exporting-data/export/s3-compatible"},{"title":"SFTP","href":"/documentation/importing-and-exporting-data/export/sftp"},{"title":"Google Sheets","href":"/documentation/importing-and-exporting-data/export/google-sheets"}]},{"group":"Authentication","pages":[{"title":"Auth0","href":"/documentation/native-integrations/authentication/auth0"}]},{"group":"Events","pages":[{"title":"Webhooks","href":"/documentation/native-integrations/events/webhooks"},{"title":"Integrate webhooks with Segment","href":"/guides/i-want-to/integrate-webhooks-with-segment"},{"title":"Integrate webhooks with Zapier","href":"/guides/i-want-to/integrate-webhooks-with-zapier"},{"title":"Durable queues (SQS)","href":"/documentation/native-integrations/events/durable-queues"}]}]},{"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"}]}]}]},"basePath":"","title":"Create Subscription - Stigg","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}