Adds subscriptions to the contract, alongside the ones already attached. Each entry either references an existing custom subscription or carries a newSubscription body, which is provisioned and attached in the same call — so a contract can be created first and its subscriptions added after, without a subscription ever existing unattached. subscriptionIds is shorthand for a list of existing references. Every subscription must belong to the contract’s customer and be custom-priced. A subscription joining the contract must cover a product no other subscription on it already covers; re-sending one that is already attached is accepted unchanged, so the duplicate-product rule never fires on a repeat. Use this instead of updating the contract with the full subscription set, which replaces it.
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).
Shorthand for attaching existing custom subscriptions by ref ID. Added to what the contract already carries — the set is never replaced. To provision a new subscription into the contract, send it in subscriptions as a newSubscription entry instead.
Shorthand for attaching existing custom subscriptions by ref ID. Added to what the contract already carries — the set is never replaced. To provision a new subscription into the contract, send it in subscriptions as a newSubscription entry instead.
Required string length: 1 - 255
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$
Response
The contract, including its full set of attached subscriptions.
A billing contract as reported by the connected billing provider.
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":"6af0847f9dea37c9b462196a","clientVersion":"0.0.4087","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-reference/contracts/attach-subscriptions-to-contract","slug":"/api-reference/contracts/attach-subscriptions-to-contract","pageMetadata":{"title":"Attach subscriptions to contract","description":"Adds subscriptions to the contract, alongside the ones already attached. Each entry either references an existing custom subscription or carries a newSubscription body, which is provisioned and attached in the same call — so a contract can be created first and its subscriptions added after, without a subscription ever existing unattached. subscriptionIds is shorthand for a list of existing references. Every subscription must belong to the contract's customer and be custom-priced. A subscription joining the contract must cover a product no other subscription on it already covers; re-sending one that is already attached is accepted unchanged, so the duplicate-product rule never fires on a repeat. Use this instead of updating the contract with the full subscription set, which replaces it.","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/subscriptions","href":"/api-reference/contracts/attach-subscriptions-to-contract","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Adds subscriptions to the contract, alongside the ones already attached. Each entry either references an existing custom subscription or carries a newSubscription body, which is provisioned and attached in the same call — so a contract can be created first and its subscriptions added after, without a subscription ever existing unattached. subscriptionIds is shorthand for a list of existing references. Every subscription must belong to the contract’s customer and be custom-priced. A subscription joining the contract must cover a product no other subscription on it already covers; re-sending one that is already attached is accepted unchanged, so the duplicate-product rule never fires on a repeat. Use this instead of updating the contract with the full subscription set, which replaces it.\"\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":"Attach subscriptions to contract","description":"Adds subscriptions to the contract, alongside the ones already attached. Each entry either references an existing custom subscription or carries a newSubscription body, which is provisioned and attached in the same call — so a contract can be created first and its subscriptions added after, without a subscription ever existing unattached. subscriptionIds is shorthand for a list of existing references. Every subscription must belong to the contract's customer and be custom-priced. A subscription joining the contract must cover a product no other subscription on it already covers; re-sending one that is already attached is accepted unchanged, so the duplicate-product rule never fires on a repeat. Use this instead of updating the contract with the full subscription set, which replaces it.","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/subscriptions","href":"/api-reference/contracts/attach-subscriptions-to-contract","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/stigg/14aedc563c3207a3/content/custom.js"],"openApiReferenceData":{"operation":{"description":"Adds subscriptions to the contract, alongside the ones already attached. Each entry either references an existing custom subscription or carries a newSubscription body, which is provisioned and attached in the same call — so a contract can be created first and its subscriptions added after, without a subscription ever existing unattached. subscriptionIds is shorthand for a list of existing references. Every subscription must belong to the contract's customer and be custom-priced. A subscription joining the contract must cover a product no other subscription on it already covers; re-sending one that is already attached is accepted unchanged, so the duplicate-product rule never fires on a repeat. Use this instead of updating the contract with the full subscription set, which replaces it.","operationId":"ContractController_attachSubscriptions","parameters":["6ed85465-686f-48f9-a429-79cd4fc88cad","71b1eba9-e4e1-4177-b807-4b8665d603ee","27f503e3-2f9c-486a-bf18-813bd3477435"],"requestBody":"55bee356-7ee9-4251-84ee-e842538d5d4a","responses":{"200":"9e04563b-a72c-4c50-b143-aef3199f247e","400":"c7413f81-fc71-4148-9222-760fbfe4720b","401":"d1210c11-43a5-48df-aa1b-182f1b225e8b","403":"b1e78cbb-995b-4142-8c88-8ecd28a21a05","404":"4f4a5745-252a-4b30-a345-b59311929beb","409":"a7e10002-bca8-4266-ba13-7c97b1bf06e5","429":"83c06418-efb3-485c-b313-e53221b4d425"},"summary":"Attach subscriptions to contract","tags":["Contracts"],"method":"post","type":"path","servers":["accb2a7e-36f5-469f-aa4d-35d4d44cc096"],"security":["f5cdfbf7-c55a-4c39-8cc2-cc095621dc0f"],"path":"/api/v1/contracts/{id}/subscriptions","baseUrlOptions":["https://api.stigg.io"],"title":"Attach subscriptions to contract","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"6ed85465-686f-48f9-a429-79cd4fc88cad":{"name":"id","required":true,"in":"path","description":"The unique identifier of the entity","schema":{"minLength":1,"maxLength":255,"type":"string","isRequired":true,"description":"The unique identifier of the entity","uniqueKey":"","typeLabel":"string"}},"71b1eba9-e4e1-4177-b807-4b8665d603ee":{"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"}},"27f503e3-2f9c-486a-bf18-813bd3477435":{"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":{"subscriptions":{"type":"array","items":{"type":"object","properties":{"newSubscription":{"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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.payingCustomerId.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.resourceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.resourceId","typeLabel":"string | null"},"billingPeriod":{"type":"string","enum":["MONTHLY","ANNUALLY"],"description":"Billing period (MONTHLY or ANNUALLY)","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.addons.items.[INDEX].id","typeLabel":"string"},"quantity":{"type":"integer","minimum":0,"description":"Number of addon instances","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.addons.items.[INDEX].quantity","typeLabel":"integer"}},"required":["id","quantity"],"title":"SubscriptionAddon","description":"Addon configuration","uniqueKey":"subscriptions.items.[INDEX].newSubscription.addons.items.[INDEX]","typeLabel":"SubscriptionAddon · object"},"uniqueKey":"subscriptions.items.[INDEX].newSubscription.addons","typeLabel":"SubscriptionAddon · object[]"},"charges":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["FEATURE","CREDIT"],"description":"Charge type","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.charges.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","maxLength":255,"description":"Charge ID","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.charges.items.[INDEX].id","typeLabel":"string"},"quantity":{"type":"number","minimum":0,"description":"Charge quantity. Minimum is 0 (zero is allowed).","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.charges.items.[INDEX]","typeLabel":"SubscriptionCharge · object"},"uniqueKey":"subscriptions.items.[INDEX].newSubscription.charges","typeLabel":"SubscriptionCharge · object[]"},"startDate":{"type":"string","format":"date-time","description":"Subscription start date","uniqueKey":"subscriptions.items.[INDEX].newSubscription.startDate","typeLabel":"string\u003cdate-time>"},"cancellationDate":{"type":"string","format":"date-time","description":"Subscription cancellation date","uniqueKey":"subscriptions.items.[INDEX].newSubscription.cancellationDate","typeLabel":"string\u003cdate-time>"},"billingInformation":{"type":"object","properties":{"taxRateIds":{"type":"array","items":{"type":"string","maxLength":255,"description":"Tax rate identifiers to apply","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.taxRateIds.items.[INDEX]","typeLabel":"string"},"description":"Tax rate identifiers to apply","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.taxRateIds","typeLabel":"string[]"},"taxPercentage":{"type":"number","minimum":0,"maximum":100,"description":"Tax percentage (0-100)","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.taxPercentage","typeLabel":"number"},"billingAddress":{"type":"object","properties":{"city":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.billingAddress.city","typeLabel":"string"},"country":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.billingAddress.country","typeLabel":"string"},"line1":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.billingAddress.line1","typeLabel":"string"},"line2":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.billingAddress.line2","typeLabel":"string"},"postalCode":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.billingAddress.state","typeLabel":"string"}},"description":"Billing address for the subscription","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.billingAddress","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.metadata.additionalProperties","typeLabel":"string"},"description":"Additional metadata for the subscription, stored as an arbitrary flat key-value object.","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.metadata","typeLabel":"object"},"chargeOnBehalfOfAccount":{"oneOf":[{"type":"string","maxLength":255,"description":"Stripe Connect account to charge on behalf of","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.chargeOnBehalfOfAccount.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Stripe Connect account to charge on behalf of","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.chargeOnBehalfOfAccount.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.chargeOnBehalfOfAccount","typeLabel":"string | null"},"isBackdated":{"default":false,"type":"boolean","description":"Whether the subscription is backdated","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.isBackdated","typeLabel":"boolean"},"isInvoicePaid":{"default":false,"type":"boolean","description":"Whether the invoice is marked as paid","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.isInvoicePaid","typeLabel":"boolean"},"invoiceDaysUntilDue":{"type":"number","description":"Number of days until invoice is due","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.invoiceDaysUntilDue","typeLabel":"number"},"integrationId":{"oneOf":[{"type":"string","maxLength":255,"description":"Billing integration identifier","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.integrationId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Billing integration identifier","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.integrationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.integrationId","typeLabel":"string | null"},"prorationBehavior":{"type":"string","enum":["INVOICE_IMMEDIATELY","CREATE_PRORATIONS","NONE"],"description":"How to handle proration for billing changes","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.billingInformation.taxIds.items.[INDEX].type","typeLabel":"string"},"value":{"type":"string","maxLength":255,"description":"The actual tax identifier value","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.billingInformation.taxIds.items.[INDEX]","typeLabel":"TaxExemptInput · object"},"description":"Customer tax identification numbers","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation.taxIds","typeLabel":"TaxExemptInput · object[]"}},"additionalProperties":false,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingInformation","typeLabel":"object"},"billingId":{"oneOf":[{"type":"string","maxLength":255,"description":"External billing system identifier","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"External billing system identifier","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingId.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.billingCountryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.0.id","typeLabel":"string"},"usageLimit":{"type":"integer","minimum":0,"description":"Maximum allowed usage for the feature","uniqueKey":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.0.usageLimit","typeLabel":"integer"},"hasUnlimitedUsage":{"type":"boolean","description":"Whether usage is unlimited","uniqueKey":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.0.hasUnlimitedUsage","typeLabel":"boolean"},"hasSoftLimit":{"type":"boolean","description":"Whether the usage limit is a soft limit","uniqueKey":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.0.hasSoftLimit","typeLabel":"boolean"},"resetPeriod":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","HOUR"],"description":"Period at which usage resets","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.0.yearlyResetPeriodConfiguration.oneOf.0.accordingTo","typeLabel":"enum\u003cstring>"}},"required":["accordingTo"],"title":"YearlyResetPeriodConfig","description":"Configuration for yearly reset period","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.0.yearlyResetPeriodConfiguration.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.0.monthlyResetPeriodConfiguration.oneOf.0.accordingTo","typeLabel":"enum\u003cstring>"}},"required":["accordingTo"],"title":"MonthlyResetPeriodConfig","description":"Configuration for monthly reset period","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.0.monthlyResetPeriodConfiguration.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.0.weeklyResetPeriodConfiguration.oneOf.0.accordingTo","typeLabel":"enum\u003cstring>"}},"required":["accordingTo"],"title":"WeeklyResetPeriodConfig","description":"Configuration for weekly reset period","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.0.weeklyResetPeriodConfiguration.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.0.weeklyResetPeriodConfiguration","typeLabel":"WeeklyResetPeriodConfig · object | null"}},"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.1.id","typeLabel":"string"},"amount":{"type":"number","minimum":0,"description":"Credit grant amount","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.1.amount","typeLabel":"number"},"cadence":{"type":"string","enum":["MONTH","YEAR"],"description":"Credit grant cadence (MONTH or YEAR)","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.1.cadence","typeLabel":"enum\u003cstring>"},"hasSoftLimit":{"type":"boolean","description":"Whether the credit balance is a soft limit","uniqueKey":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.1.hasSoftLimit","typeLabel":"boolean"}},"uniqueKey":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX].oneOf.1","typeLabel":"SubscriptionCreditEntitlementRequest · object"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.entitlements.items.[INDEX]","typeLabel":"SubscriptionFeatureEntitlementRequest · object | SubscriptionCreditEntitlementRequest · object"},"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.trialOverrideConfiguration.trialEndBehavior","typeLabel":"enum\u003cstring>"},"trialEndDate":{"type":"string","format":"date-time","description":"Custom trial end date","uniqueKey":"subscriptions.items.[INDEX].newSubscription.trialOverrideConfiguration.trialEndDate","typeLabel":"string\u003cdate-time>"}},"required":["isTrial"],"description":"Trial period override settings","uniqueKey":"subscriptions.items.[INDEX].newSubscription.trialOverrideConfiguration","typeLabel":"object"},"scheduleStrategy":{"type":"string","enum":["END_OF_BILLING_PERIOD","END_OF_BILLING_MONTH","IMMEDIATE"],"description":"Strategy for scheduling subscription changes","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.checkoutOptions.successUrl","typeLabel":"string\u003curi>"},"cancelUrl":{"type":"string","maxLength":2048,"format":"uri","description":"URL to redirect to if checkout is canceled","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.checkoutOptions.cancelUrl","typeLabel":"string\u003curi>"},"allowPromoCodes":{"default":false,"type":"boolean","description":"Allow promotional codes during checkout","uniqueKey":"subscriptions.items.[INDEX].newSubscription.checkoutOptions.allowPromoCodes","typeLabel":"boolean"},"allowTaxIdCollection":{"default":false,"type":"boolean","description":"Allow tax ID collection during checkout","uniqueKey":"subscriptions.items.[INDEX].newSubscription.checkoutOptions.allowTaxIdCollection","typeLabel":"boolean"},"collectBillingAddress":{"default":false,"type":"boolean","description":"Collect billing address during checkout","uniqueKey":"subscriptions.items.[INDEX].newSubscription.checkoutOptions.collectBillingAddress","typeLabel":"boolean"},"referenceId":{"oneOf":[{"type":"string","maxLength":255,"description":"Optional reference ID for the checkout session","uniqueKey":"subscriptions.items.[INDEX].newSubscription.checkoutOptions.referenceId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Optional reference ID for the checkout session","uniqueKey":"subscriptions.items.[INDEX].newSubscription.checkoutOptions.referenceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.checkoutOptions.referenceId","typeLabel":"string | null"},"collectPhoneNumber":{"default":false,"type":"boolean","description":"Collect phone number during checkout","uniqueKey":"subscriptions.items.[INDEX].newSubscription.checkoutOptions.collectPhoneNumber","typeLabel":"boolean"}},"required":["successUrl","cancelUrl"],"description":"Checkout page configuration for payment collection","uniqueKey":"subscriptions.items.[INDEX].newSubscription.checkoutOptions","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"subscriptions.items.[INDEX].newSubscription.metadata.additionalProperties","typeLabel":"string"},"description":"Additional metadata for the subscription, stored as an arbitrary flat key-value object.","uniqueKey":"subscriptions.items.[INDEX].newSubscription.metadata","typeLabel":"object"},"salesforceId":{"oneOf":[{"type":"string","maxLength":255,"description":"Salesforce ID","uniqueKey":"subscriptions.items.[INDEX].newSubscription.salesforceId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Salesforce ID","uniqueKey":"subscriptions.items.[INDEX].newSubscription.salesforceId.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.salesforceId","typeLabel":"string | null"},"budget":{"oneOf":[{"type":"object","properties":{"limit":{"type":"number","description":"Maximum spending limit","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.budget.oneOf.0.limit","typeLabel":"number"},"hasSoftLimit":{"type":"boolean","description":"Whether the budget is a soft limit","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.budget.oneOf.0.hasSoftLimit","typeLabel":"boolean"}},"required":["limit","hasSoftLimit"],"additionalProperties":false,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.budget.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.budget","typeLabel":"object | null"},"minimumSpend":{"oneOf":[{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.minimumSpend.oneOf.0.currency","typeLabel":"enum\u003cstring>"}},"description":"Minimum spend amount","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.minimumSpend.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.minimumSpend","typeLabel":"object | null"},"priceOverrides":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.priceOverrides.items.[INDEX].featureId.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.priceOverrides.items.[INDEX].addonId.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.priceOverrides.items.[INDEX].addonId","typeLabel":"string | null"},"baseCharge":{"type":"boolean","description":"Whether this is a base charge override","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.priceOverrides.items.[INDEX].billingCountryCode","typeLabel":"string"},"blockSize":{"type":"number","description":"Block size for pricing","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.priceOverrides.items.[INDEX].tiers.items.[INDEX].upTo","typeLabel":"number"},"unitPrice":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.priceOverrides.items.[INDEX].tiers.items.[INDEX].unitPrice","typeLabel":"Money · object"},"flatPrice":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.priceOverrides.items.[INDEX].tiers.items.[INDEX].flatPrice","typeLabel":"Money · object"}},"additionalProperties":false,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.priceOverrides.items.[INDEX].tiers.items.[INDEX]","typeLabel":"object"},"description":"Pricing tiers configuration","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.priceOverrides.items.[INDEX].creditRate.costFormula.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.priceOverrides.items.[INDEX].creditRate.costFormula","typeLabel":"string | null"}},"required":["amount","currencyId"],"additionalProperties":false,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.priceOverrides.items.[INDEX].creditRate","typeLabel":"object"},"creditGrantCadence":{"type":"string","enum":["BEGINNING_OF_BILLING_PERIOD","MONTHLY"],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.priceOverrides.items.[INDEX].creditGrantCadence","typeLabel":"enum\u003cstring>"}},"uniqueKey":"subscriptions.items.[INDEX].newSubscription.priceOverrides.items.[INDEX]","typeLabel":"object"},"uniqueKey":"subscriptions.items.[INDEX].newSubscription.priceOverrides","typeLabel":"object[]"},"paymentCollectionMethod":{"default":"CHARGE","type":"string","enum":["CHARGE","INVOICE","NONE"],"description":"How payments should be collected for this subscription","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.couponId","typeLabel":"string"},"billingCouponId":{"type":"string","maxLength":255,"description":"Billing provider coupon ID","uniqueKey":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.billingCouponId","typeLabel":"string"},"promotionCode":{"type":"string","maxLength":255,"description":"Promotion code to apply","uniqueKey":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.promotionCode","typeLabel":"string"},"discount":{"type":"object","properties":{"name":{"type":"string","maxLength":255,"description":"Discount name","uniqueKey":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.discount.name","typeLabel":"string"},"description":{"type":"string","maxLength":255,"description":"Ad-hoc discount","uniqueKey":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.discount.description","typeLabel":"string"},"durationInMonths":{"type":"number","minimum":1,"description":"Duration in months","uniqueKey":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.discount.durationInMonths","typeLabel":"number"},"percentOff":{"type":"number","minimum":1,"maximum":100,"description":"Percentage discount","uniqueKey":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.discount.percentOff","typeLabel":"number"},"amountsOff":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.discount.amountsOff.oneOf.0.items.[INDEX].currency","typeLabel":"enum\u003cstring>"}},"required":["amount","currency"],"additionalProperties":false,"uniqueKey":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.discount.amountsOff.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Fixed amounts off by currency","uniqueKey":"subscriptions.items.[INDEX].newSubscription.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":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.discount.amountsOff.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.discount.amountsOff","typeLabel":"object[] | null"}},"additionalProperties":false,"title":"SubscriptionCouponDiscount","description":"Ad-hoc discount configuration","uniqueKey":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.discount","typeLabel":"SubscriptionCouponDiscount · object"},"configuration":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"Coupon start date","uniqueKey":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.configuration.startDate","typeLabel":"string\u003cdate-time>"}},"additionalProperties":false,"description":"Coupon timing configuration","uniqueKey":"subscriptions.items.[INDEX].newSubscription.appliedCoupon.configuration","typeLabel":"object"}},"additionalProperties":false,"title":"SubscriptionCoupon","description":"Coupon configuration","uniqueKey":"subscriptions.items.[INDEX].newSubscription.appliedCoupon","typeLabel":"SubscriptionCoupon · object"},"awaitPaymentConfirmation":{"default":true,"type":"boolean","description":"Whether to wait for payment confirmation before returning the subscription","uniqueKey":"subscriptions.items.[INDEX].newSubscription.awaitPaymentConfirmation","typeLabel":"boolean"},"unitQuantity":{"type":"integer","minimum":0,"description":"Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).","uniqueKey":"subscriptions.items.[INDEX].newSubscription.unitQuantity","typeLabel":"integer"},"billingCycleAnchor":{"type":"string","enum":["UNCHANGED","NOW"],"description":"Billing cycle anchor behavior for the subscription","uniqueKey":"subscriptions.items.[INDEX].newSubscription.billingCycleAnchor","typeLabel":"enum\u003cstring>"}},"required":["customerId","planId"],"additionalProperties":false,"title":"ProvisionSubscriptionRequest","description":"A new subscription to create, using the same body the provision-subscription endpoint accepts","uniqueKey":"subscriptions.items.[INDEX].newSubscription","typeLabel":"ProvisionSubscriptionRequest · object"},"existingSubscriptionId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"The subscription ref ID of an already-created custom subscription to link","uniqueKey":"subscriptions.items.[INDEX].existingSubscriptionId","typeLabel":"string"}},"additionalProperties":false,"title":"ContractSubscriptionEntry","description":"A single subscription on a contract: exactly one of newSubscription or existingSubscriptionId must be set.","uniqueKey":"subscriptions.items.[INDEX]","typeLabel":"ContractSubscriptionEntry · object"},"uniqueKey":"subscriptions","typeLabel":"ContractSubscriptionEntry · object[]"},"subscriptionIds":{"type":"array","items":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"Shorthand for attaching existing custom subscriptions by ref ID. Added to what the contract already carries — the set is never replaced. To provision a new subscription into the contract, send it in subscriptions as a newSubscription entry instead.","uniqueKey":"subscriptionIds.items.[INDEX]","typeLabel":"string"},"description":"Shorthand for attaching existing custom subscriptions by ref ID. Added to what the contract already carries — the set is never replaced. To provision a new subscription into the contract, send it in subscriptions as a newSubscription entry instead.","uniqueKey":"subscriptionIds","typeLabel":"string[]"}},"additionalProperties":false,"title":"AttachContractSubscriptionsRequest","description":"Input for attaching existing custom subscriptions to a contract.","uniqueKey":"","typeLabel":"AttachContractSubscriptionsRequest · object"},"examples":{"Example":{"title":"Example","value":{"subscriptions":[{"existingSubscriptionId":"\u003cstring>"}],"subscriptionIds":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"9e04563b-a72c-4c50-b143-aef3199f247e":{"description":"The contract, including its full set of attached subscriptions.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"contractId":{"type":"string","maxLength":255,"description":"The Stigg contract ref ID (the key used to fetch/update/delete this contract)","isRequired":true,"uniqueKey":"data.contractId","typeLabel":"string"},"billingId":{"oneOf":[{"type":"string","maxLength":255,"description":"The billing provider (Received) contract ID; null until the contract has synced to the billing provider","isRequired":true,"uniqueKey":"data.billingId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The billing provider (Received) contract ID; null until the contract has synced to the billing provider","isRequired":true,"uniqueKey":"data.billingId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.billingId","typeLabel":"string | null"},"id":{"oneOf":[{"type":"string","maxLength":255,"description":"The persisted Stigg contract id (matches a subscription’s contractId; present for Stigg-managed contracts)","isRequired":true,"uniqueKey":"data.id.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The persisted Stigg contract id (matches a subscription’s contractId; present for Stigg-managed contracts)","isRequired":true,"uniqueKey":"data.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.id","typeLabel":"string | null"},"refId":{"oneOf":[{"type":"string","maxLength":255,"description":"The Stigg contract ref ID (present for Stigg-managed contracts; the key used to update/delete)","isRequired":true,"uniqueKey":"data.refId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The Stigg contract ref ID (present for Stigg-managed contracts; the key used to update/delete)","isRequired":true,"uniqueKey":"data.refId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.refId","typeLabel":"string | null"},"poNumber":{"oneOf":[{"type":"string","maxLength":255,"description":"Purchase-order number, when set on the contract","isRequired":true,"uniqueKey":"data.poNumber.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Purchase-order number, when set on the contract","isRequired":true,"uniqueKey":"data.poNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.poNumber","typeLabel":"string | null"},"externalId":{"type":"string","maxLength":255,"description":"The external identifier of the contract","isRequired":true,"uniqueKey":"data.externalId","typeLabel":"string"},"customerExternalId":{"oneOf":[{"type":"string","maxLength":255,"description":"The external identifier of the customer the contract belongs to","isRequired":true,"uniqueKey":"data.customerExternalId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The external identifier of the customer the contract belongs to","isRequired":true,"uniqueKey":"data.customerExternalId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.customerExternalId","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","maxLength":255,"description":"The contract name (the purchase-order number when set, otherwise the contract/customer name)","isRequired":true,"uniqueKey":"data.name.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The contract name (the purchase-order number when set, otherwise the contract/customer name)","isRequired":true,"uniqueKey":"data.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.name","typeLabel":"string | null"},"state":{"type":"string","enum":["DRAFT","ACTIVE","CANCELED","END_BILLING"],"description":"The current state of the contract","isRequired":true,"uniqueKey":"data.state","typeLabel":"enum\u003cstring>"},"billingState":{"oneOf":[{"type":"string","enum":["DRAFT","ACTIVE","CANCELED","END_BILLING"],"description":"The current state of the contract","isRequired":true,"uniqueKey":"data.billingState.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["DRAFT","ACTIVE","CANCELED","END_BILLING"],"description":"The current state of the contract","isRequired":true,"uniqueKey":"data.billingState.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.billingState","typeLabel":"enum\u003cstring> | null"},"activationStartDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date the contract becomes active","isRequired":true,"uniqueKey":"data.activationStartDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date the contract becomes active","isRequired":true,"uniqueKey":"data.activationStartDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.activationStartDate","typeLabel":"string\u003cdate-time> | null"},"activationEndDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date the contract activation ends","isRequired":true,"uniqueKey":"data.activationEndDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date the contract activation ends","isRequired":true,"uniqueKey":"data.activationEndDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.activationEndDate","typeLabel":"string\u003cdate-time> | null"},"createdAt":{"oneOf":[{"type":"string","format":"date-time","description":"The date the contract was created","isRequired":true,"uniqueKey":"data.createdAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date the contract was created","isRequired":true,"uniqueKey":"data.createdAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time> | null"},"nextInvoice":{"oneOf":[{"type":"object","properties":{"invoiceId":{"oneOf":[{"type":"string","maxLength":255,"description":"The billing provider ID of the draft invoice this preview describes","isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.invoiceId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The billing provider ID of the draft invoice this preview describes","isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.invoiceId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.invoiceId","typeLabel":"string | null"},"amount":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.amount.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.nextInvoice.oneOf.0.amount.currency","typeLabel":"enum\u003cstring>"}},"required":["amount","currency"],"description":"The total amount of the upcoming invoice","isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.amount","typeLabel":"object"},"dueDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date the upcoming invoice is due","isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.dueDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date the upcoming invoice is due","isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.dueDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.dueDate","typeLabel":"string\u003cdate-time> | null"},"periodStart":{"oneOf":[{"type":"string","format":"date-time","description":"The start of the billing period the upcoming invoice covers","isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.periodStart.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The start of the billing period the upcoming invoice covers","isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.periodStart.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.periodStart","typeLabel":"string\u003cdate-time> | null"},"periodEnd":{"oneOf":[{"type":"string","format":"date-time","description":"The end of the billing period the upcoming invoice covers","isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.periodEnd.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The end of the billing period the upcoming invoice covers","isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.periodEnd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0.periodEnd","typeLabel":"string\u003cdate-time> | null"}},"required":["invoiceId","amount","dueDate","periodStart","periodEnd"],"title":"ContractNextInvoice","description":"A preview of the contract's upcoming invoice, or null when none is available","isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.0","typeLabel":"ContractNextInvoice · object"},{"type":"null","properties":{"invoiceId":{"oneOf":[{"type":"string","maxLength":255,"description":"The billing provider ID of the draft invoice this preview describes"},{"type":"null","maxLength":255,"description":"The billing provider ID of the draft invoice this preview describes"}]},"amount":{"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"],"description":"The total amount of the upcoming invoice"},"dueDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date the upcoming invoice is due"},{"type":"null","format":"date-time","description":"The date the upcoming invoice is due"}]},"periodStart":{"oneOf":[{"type":"string","format":"date-time","description":"The start of the billing period the upcoming invoice covers"},{"type":"null","format":"date-time","description":"The start of the billing period the upcoming invoice covers"}]},"periodEnd":{"oneOf":[{"type":"string","format":"date-time","description":"The end of the billing period the upcoming invoice covers"},{"type":"null","format":"date-time","description":"The end of the billing period the upcoming invoice covers"}]}},"required":["invoiceId","amount","dueDate","periodStart","periodEnd"],"title":"ContractNextInvoice","description":"A preview of the contract's upcoming invoice, or null when none is available","isRequired":true,"uniqueKey":"data.nextInvoice.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.nextInvoice","typeLabel":"ContractNextInvoice · object | null"},"latestInvoice":{"oneOf":[{"type":"object","properties":{"billingId":{"type":"string","maxLength":255,"description":"Invoice billing ID","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.billingId","typeLabel":"string"},"status":{"type":"string","enum":["OPEN","CANCELED","PAID"],"description":"Invoice status","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","description":"Invoice creation date","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"requiresAction":{"type":"boolean","description":"Whether payment requires action","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.requiresAction","typeLabel":"boolean"},"total":{"oneOf":[{"type":"number","description":"Total amount","uniqueKey":"data.latestInvoice.oneOf.0.total.oneOf.0","typeLabel":"number"},{"type":"null","description":"Total amount","uniqueKey":"data.latestInvoice.oneOf.0.total.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.latestInvoice.oneOf.0.total","typeLabel":"number | null"},"amountDue":{"oneOf":[{"type":"number","description":"Amount due","uniqueKey":"data.latestInvoice.oneOf.0.amountDue.oneOf.0","typeLabel":"number"},{"type":"null","description":"Amount due","uniqueKey":"data.latestInvoice.oneOf.0.amountDue.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.latestInvoice.oneOf.0.amountDue","typeLabel":"number | null"},"currency":{"oneOf":[{"type":"string","maxLength":255,"description":"Invoice currency","uniqueKey":"data.latestInvoice.oneOf.0.currency.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Invoice currency","uniqueKey":"data.latestInvoice.oneOf.0.currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.latestInvoice.oneOf.0.currency","typeLabel":"string | null"},"pdfUrl":{"oneOf":[{"type":"string","maxLength":2048,"description":"Invoice PDF URL","uniqueKey":"data.latestInvoice.oneOf.0.pdfUrl.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":2048,"description":"Invoice PDF URL","uniqueKey":"data.latestInvoice.oneOf.0.pdfUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.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.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.latestInvoice.oneOf.0.billingReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.latestInvoice.oneOf.0.billingReason","typeLabel":"enum\u003cstring> | null"}},"required":["billingId","status","createdAt","requiresAction"],"title":"LatestInvoice","description":"The most recent non-draft invoice for this contract (open, paid, or canceled), or null when none exists","isRequired":true,"uniqueKey":"data.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":"The most recent non-draft invoice for this contract (open, paid, or canceled), or null when none exists","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.latestInvoice","typeLabel":"LatestInvoice · object | null"},"subscriptions":{"type":"array","items":{"type":"object","properties":{"subscriptionId":{"type":"string","maxLength":255,"description":"The subscription ref ID (use it to deep-link to the subscription)","isRequired":true,"uniqueKey":"data.subscriptions.items.[INDEX].subscriptionId","typeLabel":"string"},"planDisplayName":{"oneOf":[{"type":"string","maxLength":255,"description":"Display name of the subscription plan","isRequired":true,"uniqueKey":"data.subscriptions.items.[INDEX].planDisplayName.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Display name of the subscription plan","isRequired":true,"uniqueKey":"data.subscriptions.items.[INDEX].planDisplayName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.subscriptions.items.[INDEX].planDisplayName","typeLabel":"string | null"},"productDisplayName":{"oneOf":[{"type":"string","maxLength":255,"description":"Display name of the product the subscription plan belongs to","isRequired":true,"uniqueKey":"data.subscriptions.items.[INDEX].productDisplayName.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Display name of the product the subscription plan belongs to","isRequired":true,"uniqueKey":"data.subscriptions.items.[INDEX].productDisplayName.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.subscriptions.items.[INDEX].productDisplayName","typeLabel":"string | null"}},"required":["subscriptionId","planDisplayName","productDisplayName"],"title":"ContractSubscriptionRef","description":"A custom subscription attached to a contract.","uniqueKey":"data.subscriptions.items.[INDEX]","typeLabel":"ContractSubscriptionRef · object"},"description":"The custom subscriptions attached to this contract (empty when none)","isRequired":true,"uniqueKey":"data.subscriptions","typeLabel":"ContractSubscriptionRef · object[]"}},"required":["contractId","billingId","id","refId","poNumber","externalId","customerExternalId","name","state","billingState","activationStartDate","activationEndDate","createdAt","nextInvoice","latestInvoice","subscriptions"],"title":"Contract","description":"A billing contract as reported by the connected billing provider.","isRequired":true,"uniqueKey":"data","typeLabel":"Contract · object"}},"required":["data"],"title":"Response","description":"Response object","uniqueKey":"","typeLabel":"Response · object"},"examples":{"default":{"title":"default","value":{"data":{"contractId":"contract-acme-2026","billingId":"ct_1a2b3c4d","id":"3452155b-deca-4d7f-91e5-82d486dc8bb0","refId":"contract-acme-2026","poNumber":"PO-4821","externalId":"contract-acme-2026","customerExternalId":"customer-acme","name":"PO-4821","state":"ACTIVE","billingState":"ACTIVE","activationStartDate":"2026-01-01T00:00:00.000Z","activationEndDate":"2026-12-31T00:00:00.000Z","createdAt":"2025-12-15T09:30:00.000Z","nextInvoice":{"invoiceId":"a3f1c2de-5b47-4c8e-9f10-2d6b8e4a7c31","amount":{"amount":4900,"currency":"usd"},"dueDate":"2026-08-01T00:00:00.000Z","periodStart":"2026-07-01T00:00:00.000Z","periodEnd":"2026-08-01T00:00:00.000Z"},"latestInvoice":{"billingId":"inv_abc123","status":"OPEN","createdAt":"2026-07-01T00:00:00.000Z","total":4900,"amountDue":4900,"currency":"usd","pdfUrl":null,"requiresAction":false,"billingReason":null},"subscriptions":[{"subscriptionId":"subscription-acme-platform","planDisplayName":"Enterprise Platform","productDisplayName":"Revvenu"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"c7413f81-fc71-4148-9222-760fbfe4720b":{"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"},"d1210c11-43a5-48df-aa1b-182f1b225e8b":{"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"},"b1e78cbb-995b-4142-8c88-8ecd28a21a05":{"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"},"4f4a5745-252a-4b30-a345-b59311929beb":{"description":"Contract not found.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"oneOf":[{"type":"string","enum":["CustomerNotFound","CustomCurrencyNotFound","CreditGrantNotFound","ReservationNotFound","ContractNotFound","InvoiceNotFound","MemberNotFound","PackageGroupNotFound","AddonNotFound","AddonsNotFound","EnvironmentMissing","IntegrationNotFound","VendorIsNotSupported","CouponNotFound","FutureUpdateNotFound","CustomerNoBillingId","SubscriptionNoBillingId","StripeCustomerIsDeleted","InitStripePaymentMethodError","PreparePaymentMethodFormError","AccountNotFoundError","ExperimentNotFoundError","NoDraftOfferFound","PromotionCodeNotFound","FailedToCreateCheckoutSessionError","PaymentMethodNotFoundError","ProductNotFoundError","ProductNotPublishedError","MissingBillingInvoiceError","BillingInvoiceStatusError","FeatureGroupNotFoundError","CannotArchiveFeatureGroupError","OfferNotFound","CustomerResourceNotFound","FeatureNotFound","PriceNotFound","NoActiveSubscriptionForCustomer","PlanNotFound","PromotionalEntitlementNotFoundError","SubscriptionNotFound","ApiKeyNotFound"],"isRequired":true,"uniqueKey":"code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["CustomerNotFound","CustomCurrencyNotFound","CreditGrantNotFound","ReservationNotFound","ContractNotFound","InvoiceNotFound","MemberNotFound","PackageGroupNotFound","AddonNotFound","AddonsNotFound","EnvironmentMissing","IntegrationNotFound","VendorIsNotSupported","CouponNotFound","FutureUpdateNotFound","CustomerNoBillingId","SubscriptionNoBillingId","StripeCustomerIsDeleted","InitStripePaymentMethodError","PreparePaymentMethodFormError","AccountNotFoundError","ExperimentNotFoundError","NoDraftOfferFound","PromotionCodeNotFound","FailedToCreateCheckoutSessionError","PaymentMethodNotFoundError","ProductNotFoundError","ProductNotPublishedError","MissingBillingInvoiceError","BillingInvoiceStatusError","FeatureGroupNotFoundError","CannotArchiveFeatureGroupError","OfferNotFound","CustomerResourceNotFound","FeatureNotFound","PriceNotFound","NoActiveSubscriptionForCustomer","PlanNotFound","PromotionalEntitlementNotFoundError","SubscriptionNotFound","ApiKeyNotFound"],"isRequired":true,"uniqueKey":"code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring> | null"}},"required":["message","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":"CustomerNotFound"}}},"exampleType":"generated"}},"exampleType":"generated"},"a7e10002-bca8-4266-ba13-7c97b1bf06e5":{"description":"Contract 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"},"83c06418-efb3-485c-b313-e53221b4d425":{"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":{"f5cdfbf7-c55a-4c39-8cc2-cc095621dc0f":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"Server API Key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"accb2a7e-36f5-469f-aa4d-35d4d44cc096":{"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":"Attach subscriptions to contract - Stigg","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-08T14:17:53.764Z","originalFileLocation":"api-reference/contracts/attach-subscriptions-to-contract.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=\"Adds subscriptions to the contract, alongside the ones already attached. Each entry either references an existing custom subscription or carries a newSubscription body, which is provisioned and attached in the same call — so a contract can be created first and its subscriptions added after, without a subscription ever existing unattached. subscriptionIds is shorthand for a list of existing references. Every subscription must belong to the contract\u0026#x27;s customer and be custom-priced. A subscription joining the contract must cover a product no other subscription on it already covers; re-sending one that is already attached is accepted unchanged, so the duplicate-product rule never fires on a repeat. Use this instead of updating the contract with the full subscription set, which replaces it.\">\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=\"Attach subscriptions to contract - Stigg\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds subscriptions to the contract, alongside the ones already attached. Each entry either references an existing custom subscription or carries a newSubscription body, which is provisioned and attached in the same call — so a contract can be created first and its subscriptions added after, without a subscription ever existing unattached. subscriptionIds is shorthand for a list of existing references. Every subscription must belong to the contract\u0026#x27;s customer and be custom-priced. A subscription joining the contract must cover a product no other subscription on it already covers; re-sending one that is already attached is accepted unchanged, so the duplicate-product rule never fires on a repeat. Use this instead of updating the contract with the full subscription set, which replaces it.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Stigg\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.stigg.io/api-reference/contracts/attach-subscriptions-to-contract\">\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=Contracts\u0026amp;title=Attach+subscriptions+to+contract\u0026amp;description=Adds+subscriptions+to+the+contract%2C+alongside+the+ones+already+attached.+Each+entry+either+references+an+existing+custom+subscription+or+carries+a+newSubscripti\u0026amp;theme=2f1adfbb069b3c699f8f4495\u0026amp;signature=2407644c530142bf0563e0fdf08702e7b863d7b358e6fb2f5ea59210ef245764\">\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=\"Attach subscriptions to contract - Stigg\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds subscriptions to the contract, alongside the ones already attached. Each entry either references an existing custom subscription or carries a newSubscription body, which is provisioned and attached in the same call — so a contract can be created first and its subscriptions added after, without a subscription ever existing unattached. subscriptionIds is shorthand for a list of existing references. Every subscription must belong to the contract\u0026#x27;s customer and be custom-priced. A subscription joining the contract must cover a product no other subscription on it already covers; re-sending one that is already attached is accepted unchanged, so the duplicate-product rule never fires on a repeat. Use this instead of updating the contract with the full subscription set, which replaces it.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://stigg.mintlify.site/_mintlify/api/og/v2?division=Contracts\u0026amp;title=Attach+subscriptions+to+contract\u0026amp;description=Adds+subscriptions+to+the+contract%2C+alongside+the+ones+already+attached.+Each+entry+either+references+an+existing+custom+subscription+or+carries+a+newSubscripti\u0026amp;theme=2f1adfbb069b3c699f8f4495\u0026amp;signature=2407644c530142bf0563e0fdf08702e7b863d7b358e6fb2f5ea59210ef245764\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Stigg\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#436633\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.stigg.io/api-reference/contracts/attach-subscriptions-to-contract\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/contracts/attach-subscriptions-to-contract.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.stigg.io/#organization\",\"name\":\"Stigg\",\"url\":\"https://docs.stigg.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/stigg/HmCBL4eVQuHwqjnY/logo/light.svg?fit=max\u0026auto=format\u0026n=HmCBL4eVQuHwqjnY\u0026q=85\u0026s=8579b37d1f3d11f4198506c9e602caa3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.stigg.io#website\",\"name\":\"Stigg\",\"url\":\"https://docs.stigg.io\",\"publisher\":{\"@id\":\"https://docs.stigg.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.stigg.io/api-reference/contracts/attach-subscriptions-to-contract#webpage\",\"url\":\"https://docs.stigg.io/api-reference/contracts/attach-subscriptions-to-contract\",\"name\":\"Attach subscriptions to contract\",\"description\":\"Adds subscriptions to the contract, alongside the ones already attached. Each entry either references an existing custom subscription or carries a newSubscription body, which is provisioned and attached in the same call — so a contract can be created first and its subscriptions added after, without a subscription ever existing unattached. subscriptionIds is shorthand for a list of existing references. Every subscription must belong to the contract's customer and be custom-priced. A subscription joining the contract must cover a product no other subscription on it already covers; re-sending one that is already attached is accepted unchanged, so the duplicate-product rule never fires on a repeat. Use this instead of updating the contract with the full subscription set, which replaces it.\",\"dateModified\":\"2026-11-08T14:17:53.764Z\",\"isPartOf\":{\"@id\":\"https://docs.stigg.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.stigg.io/api-reference/contracts/attach-subscriptions-to-contract#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.stigg.io/api-reference/contracts/attach-subscriptions-to-contract#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Contracts\",\"item\":\"https://docs.stigg.io/api-reference/contracts/get-a-list-of-contracts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Attach subscriptions to contract\",\"item\":\"https://docs.stigg.io/api-reference/contracts/attach-subscriptions-to-contract\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.stigg.io/api-reference/contracts/attach-subscriptions-to-contract#apireference\",\"headline\":\"Attach subscriptions to contract\",\"name\":\"Attach subscriptions to contract\",\"description\":\"Adds subscriptions to the contract, alongside the ones already attached. Each entry either references an existing custom subscription or carries a newSubscription body, which is provisioned and attached in the same call — so a contract can be created first and its subscriptions added after, without a subscription ever existing unattached. subscriptionIds is shorthand for a list of existing references. Every subscription must belong to the contract's customer and be custom-priced. A subscription joining the contract must cover a product no other subscription on it already covers; re-sending one that is already attached is accepted unchanged, so the duplicate-product rule never fires on a repeat. Use this instead of updating the contract with the full subscription set, which replaces it.\",\"url\":\"https://docs.stigg.io/api-reference/contracts/attach-subscriptions-to-contract\",\"mainEntityOfPage\":{\"@id\":\"https://docs.stigg.io/api-reference/contracts/attach-subscriptions-to-contract#webpage\"},\"dateModified\":\"2026-11-08T14:17:53.764Z\",\"publisher\":{\"@id\":\"https://docs.stigg.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.stigg.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Stigg\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Stigg","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/documentation/getting-started/welcome-to-stigg"}]},{"tab":"Guides","icon":"map","pages":[{"title":"Guides","href":"/guides/quick-start-guides/provisioning-customers"}]},{"tab":"API Reference","icon":"code","dropdowns":[{"dropdown":"Overview","icon":"compass","pages":[{"title":"API Reference","mode":"custom","href":"/api-and-sdks/api-reference/overview"}]},{"dropdown":"REST","icon":"server","groups":[{"group":"Get started","pages":[{"title":"Introduction","href":"/api-and-sdks/api-reference/rest/introduction"}]},{"group":"Essentials","pages":[{"title":"Authentication","href":"/api-and-sdks/api-reference/rest/authentication"},{"title":"Pagination","href":"/api-and-sdks/api-reference/rest/pagination"},{"title":"Responses","href":"/api-and-sdks/api-reference/rest/responses"},{"title":"Rate Limits","href":"/api-and-sdks/integration/rest/rate-limits"},{"title":"Access enforcement at scale","href":"/api-and-sdks/api-reference/rest/using-at-scale"}]},{"group":"SDK reference","pages":[{"title":"Backend","href":"/api-and-sdks/references/sdk/backend/rest/index"},{"title":"Agent SDK","href":"/api-and-sdks/references/sdk/backend/rest/agent-sdk"},{"group":"Frontend","pages":[{"title":"JavaScript SDK","href":"/api-and-sdks/references/sdk/frontend/javascript-rest"},{"title":"React SDK","href":"/api-and-sdks/references/sdk/frontend/react-rest"},{"title":"Vue.js SDK","href":"/api-and-sdks/references/sdk/frontend/vue-rest"},{"title":"Embed SDK","href":"/api-and-sdks/references/sdk/frontend/embed-rest"}]}]},{"group":"CLI reference","pages":[{"title":"CLI reference","href":"/api-and-sdks/cli-reference"}]},{"group":"SDK documentation","pages":[{"group":"Frontend","pages":[{"title":"JavaScript","href":"/api-and-sdks/integration/frontend/javascript"},{"title":"React","href":"/api-and-sdks/integration/frontend/react"},{"title":"Vue.js","href":"/api-and-sdks/integration/frontend/vuejs"},{"title":"Next.js","href":"/api-and-sdks/integration/frontend/nextjs"},{"title":"Webflow, Wordpress and plain HTML SDK","href":"/api-and-sdks/integration/frontend/html"},{"title":"Hardening client-side access","href":"/api-and-sdks/integration/frontend/hardening-client-side-access"}]}]},{"group":"Subscriptions","pages":[{"title":"Get a single subscription by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/subscriptions/{id}","href":"/api-reference/subscriptions/get-a-single-subscription-by-id"},{"title":"Update a subscription","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/subscriptions/{id}","href":"/api-reference/subscriptions/update-a-subscription"},{"title":"Get a list of subscriptions","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/subscriptions","href":"/api-reference/subscriptions/get-a-list-of-subscriptions"},{"title":"Provision subscription","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions","href":"/api-reference/subscriptions/provision-subscription"},{"title":"Transfer subscription to resource","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/transfer","href":"/api-reference/subscriptions/transfer-subscription-to-resource"},{"title":"Migrate subscription to latest plan version","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/migrate","href":"/api-reference/subscriptions/migrate-subscription-to-latest-plan-version"},{"title":"Delegate subscription payment to customer","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/delegate","href":"/api-reference/subscriptions/delegate-subscription-payment-to-customer"},{"title":"Cancel pending payment update","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/subscriptions/{id}/future-update/pending-payment","href":"/api-reference/subscriptions/cancel-pending-payment-update"},{"title":"Cancel scheduled update","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/subscriptions/{id}/future-update/schedule","href":"/api-reference/subscriptions/cancel-scheduled-update"},{"title":"Preview subscription","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/preview","href":"/api-reference/subscriptions/preview-subscription"},{"title":"Cancel subscription","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/cancel","href":"/api-reference/subscriptions/cancel-subscription"},{"title":"Charge subscription usage","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/usage/charge","href":"/api-reference/subscriptions/charge-subscription-usage"},{"title":"Trigger subscription usage sync","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/usage/sync","href":"/api-reference/subscriptions/trigger-subscription-usage-sync"},{"title":"Mark subscription invoice as paid","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/{id}/invoice/paid","href":"/api-reference/subscriptions/mark-subscription-invoice-as-paid"}]},{"group":"Bulk Import","pages":[{"title":"Bulk import subscriptions","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/subscriptions/import","href":"/api-reference/bulk-import/bulk-import-subscriptions"},{"title":"Bulk import customers","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/import","href":"/api-reference/bulk-import/bulk-import-customers"}]},{"group":"Usage","pages":[{"title":"Get usage history","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/usage/{customerId}/history/{featureId}","href":"/api-reference/usage/get-usage-history"},{"title":"Report usage events","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/events","href":"/api-reference/usage/report-usage-events"},{"title":"Estimate event credit cost","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/events/estimate","href":"/api-reference/usage/estimate-event-credit-cost"},{"title":"Report usage measurements","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/usage","href":"/api-reference/usage/report-usage-measurements"},{"title":"Estimate usage credit cost","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/usage/estimate","href":"/api-reference/usage/estimate-usage-credit-cost"},{"title":"Report usage measurements (v2)","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v2/usage","href":"/api-reference/usage/report-usage-measurements-v2"}]},{"group":"Coupons","pages":[{"title":"Get a list of coupons","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/coupons","href":"/api-reference/coupons/get-a-list-of-coupons"},{"title":"Create coupon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/coupons","href":"/api-reference/coupons/create-coupon"},{"title":"Get a single coupon by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/coupons/{id}","href":"/api-reference/coupons/get-a-single-coupon-by-id"},{"title":"Update a coupon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/coupons/{id}","href":"/api-reference/coupons/update-a-coupon"},{"title":"Archive coupon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/coupons/{id}/archive","href":"/api-reference/coupons/archive-coupon"}]},{"group":"Products","pages":[{"title":"Get a list of products","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/products","href":"/api-reference/products/get-a-list-of-products"},{"title":"Create product","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/products","href":"/api-reference/products/create-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/products/{id}","href":"/api-reference/products/update-a-product"},{"title":"Archive product","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/products/{id}/archive","href":"/api-reference/products/archive-product"},{"title":"Unarchive product","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/products/{id}/unarchive","href":"/api-reference/products/unarchive-product"},{"title":"Duplicate product","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/products/{id}/duplicate","href":"/api-reference/products/duplicate-product"}]},{"group":"Features","pages":[{"title":"Get a single feature by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/features/{id}","href":"/api-reference/features/get-a-single-feature-by-id"},{"title":"Update a feature","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/features/{id}","href":"/api-reference/features/update-a-feature"},{"title":"Get a list of features","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/features","href":"/api-reference/features/get-a-list-of-features"},{"title":"Create a feature","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/features","href":"/api-reference/features/create-a-feature"},{"title":"Archive feature","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/features/{id}/archive","href":"/api-reference/features/archive-feature"},{"title":"Unarchive feature","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/features/{id}/unarchive","href":"/api-reference/features/unarchive-feature"}]},{"group":"Addons","pages":[{"title":"Get a list of addons","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/addons","href":"/api-reference/addons/get-a-list-of-addons"},{"title":"Create an addon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/addons","href":"/api-reference/addons/create-an-addon"},{"title":"Get a single addon by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/addons/{id}","href":"/api-reference/addons/get-a-single-addon-by-id"},{"title":"Update a addon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/addons/{id}","href":"/api-reference/addons/update-a-addon"},{"title":"Archive an addon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/addons/{id}/archive","href":"/api-reference/addons/archive-an-addon"},{"title":"List addon charges","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/addons/{id}/charges","href":"/api-reference/addons/list-addon-charges"},{"title":"Create addon draft","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/addons/{id}/draft","href":"/api-reference/addons/create-addon-draft"},{"title":"Remove addon draft","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/addons/{id}/draft","href":"/api-reference/addons/remove-addon-draft"},{"title":"Publish addon","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/addons/{id}/publish","href":"/api-reference/addons/publish-addon"}]},{"group":"Plans","pages":[{"title":"Get a list of plans","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/plans","href":"/api-reference/plans/get-a-list-of-plans"},{"title":"Create plan","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/plans","href":"/api-reference/plans/create-plan"},{"title":"Get a single plan by ID","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","description":"Amends a contract whose billing is already live: it stays active and the invoices affected by the change are regenerated, which is what editing a live contract does in the dashboard. Invoices that can no longer change are never touched, and what may change is validated — an ongoing period's dates cannot move. Set `includeCurrentInvoice` to land the change on the invoice currently open rather than the next one.","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","description":"Detaches a single subscription from the contract. The subscription itself is left untouched and stays active — only its link to the contract is removed. Idempotent: detaching a subscription that is not attached succeeds and changes nothing.","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","pages":[{"title":"Integrations","href":"/documentation/native-integrations/overview"}]},{"tab":"Changelog","icon":"clock-rotate-left","dropdowns":[{"dropdown":"Overview","icon":"compass","pages":[{"title":"Changelog","mode":"custom","href":"/api-and-sdks/changelog/overview"}]},{"dropdown":"Product","icon":"sparkles","href":"https://changelog.stigg.io/"},{"dropdown":"REST","icon":"server","pages":[{"title":"TypeScript","mode":"wide","href":"/api-and-sdks/changelog/backend-rest/typescript"},{"title":"Python","mode":"wide","href":"/api-and-sdks/changelog/backend-rest/python"},{"title":"Go","mode":"wide","href":"/api-and-sdks/changelog/backend-rest/go"},{"title":"Java","mode":"wide","href":"/api-and-sdks/changelog/backend-rest/java"},{"title":"Ruby","mode":"wide","href":"/api-and-sdks/changelog/backend-rest/ruby"},{"title":"C#","mode":"wide","href":"/api-and-sdks/changelog/backend-rest/csharp"}]},{"dropdown":"GraphQL","icon":"diagram-project","pages":[{"title":"Node.js SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/node"},{"title":"Python SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/python"},{"title":"Ruby SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/ruby"},{"title":"Go SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/go"},{"title":"Java SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/java"},{"title":".NET SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/dotnet"},{"title":"API Client (JS)","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/api-client-js"}]},{"dropdown":"Frontend SDKs","icon":"window-maximize","pages":[{"title":"JavaScript SDK","mode":"wide","href":"/api-and-sdks/changelog/frontend/javascript"},{"title":"React SDK","mode":"wide","href":"/api-and-sdks/changelog/frontend/react"},{"title":"Vue.js SDK","mode":"wide","href":"/api-and-sdks/changelog/frontend/vuejs"},{"title":"Next.js SDK","mode":"wide","href":"/api-and-sdks/changelog/frontend/nextjs"},{"title":"Embed SDK","mode":"wide","href":"/api-and-sdks/changelog/frontend/embed"}]},{"dropdown":"Sidecar","icon":"circle-nodes","pages":[{"title":"Sidecar Service","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/sidecar-service"},{"title":"Sidecar SDK","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/sidecar"}]},{"dropdown":"Agent SDK","icon":"robot","pages":[{"title":"JavaScript","mode":"wide","href":"/api-and-sdks/changelog/agent-sdk/javascript"}]},{"dropdown":"Persistent Cache Service","icon":"database","pages":[{"title":"Persistent Cache Service","mode":"wide","href":"/api-and-sdks/changelog/backend-graphql/persistent-cache"}]}]}]},"basePath":"","title":"Attach subscriptions to contract - Stigg","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}