import Stigg from '@stigg/typescript';
const client = new Stigg({
apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});
const creditGrantResponse = await client.v1.credits.grants.create({
amount: 0,
currencyId: 'currencyId',
customerId: 'customerId',
displayName: 'displayName',
grantType: 'PAID',
});
console.log(creditGrantResponse.data);
import os
from stigg import Stigg
client = Stigg(
api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted
)
credit_grant_response = client.v1.credits.grants.create(
amount=0,
currency_id="currencyId",
customer_id="customerId",
display_name="displayName",
grant_type="PAID",
)
print(credit_grant_response.data)
Creates a new credit grant for a customer with specified amount, type, and optional billing configuration.
POST
/
api
/
v1
/
credits
/
grants
JavaScript
import Stigg from '@stigg/typescript';
const client = new Stigg({
apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});
const creditGrantResponse = await client.v1.credits.grants.create({
amount: 0,
currencyId: 'currencyId',
customerId: 'customerId',
displayName: 'displayName',
grantType: 'PAID',
});
console.log(creditGrantResponse.data);
import os
from stigg import Stigg
client = Stigg(
api_key=os.environ.get("STIGG_API_KEY"), # This is the default and can be omitted
)
credit_grant_response = client.v1.credits.grants.create(
amount=0,
currency_id="currencyId",
customer_id="customerId",
display_name="displayName",
grant_type="PAID",
)
print(credit_grant_response.data)
Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).
Body
application/json
Request body for creating a credit grant. Grants cannot be edited after creation — void and re-grant if the amount, priority, or expiration needs to change.
Determines which grant is drawn down first when the customer has multiple active grants in the same currency (0-100). Lower numbers are consumed first. Defaults to 50 — the same default used for recurring credits granted by a plan or price — so without setting this explicitly, draw order against plan-included credits falls back to expiration date and grant type. To have this grant consumed before or after plan-included credits, set a lower or higher priority than the plan/price credit configuration.
The payment collection method (CHARGE, INVOICE, NONE). Optional if the grant has no cost, since there is nothing to collect payment for. With NONE or CHARGE, the grant is active and its credits are usable right away (or as soon as the charge succeeds). With INVOICE, the grant stays pending — its credits are not usable — until the generated invoice is paid.
Whether to wait for payment confirmation before returning (default: true). When false, the request returns immediately while payment (if any) is collected asynchronously; check the returned status to see whether the credits are already usable.
Billing information for the credit grant, used when the grant has a payment collection method that requires collecting payment (e.g. invoice due date, billing address).
Credit grant object representing allocated credits for a customer. Credit grants cannot be edited after creation via this API — void the grant to stop further consumption from it, then create a new grant with the corrected amount, priority, or expiration.
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":""},"chroma":{"liveDeploymentHistoryId":"6ae759b2b03e174242bb5763","collectionId":"b6a69f73-68db-4cb4-9eed-c607a8664336","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae759b2b03e174242bb5763"},"feedback":{"thumbs":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae89d58883d97e41aaf2468","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Documentation","count":282},{"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":65},{"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":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"content/custom.css","content":"@keyframes welcome-dash{to{background-position:0 10px}}@keyframes welcome-dash-h{to{background-position:10px 0}}@font-face{font-family:\"Söhne\";src:url(/fonts/soehne-buch.woff2) format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:\"Söhne\";src:url(/fonts/soehne-leicht.woff2) format(\"woff2\");font-weight:300;font-style:normal;font-display:swap}@font-face{font-family:\"Söhne Mono\";src:url(/fonts/soehne-mono-buch.woff2) format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}:root{--font-inter:\"Söhne\", -apple-system, BlinkMacSystemFont, \"Segoe UI\",\n system-ui, sans-serif!important;--font-paper-mono:\"Söhne Mono\", ui-monospace, SFMono-Regular, Menlo,\n Monaco, Consolas, \"Liberation Mono\", \"Courier New\", monospace!important;--gray-50:255 255 255!important;--gray-100:255 255 255!important;--gray-200:234 234 234!important;--gray-300:213 213 213!important;--gray-400:181 181 181!important;--gray-500:149 149 149!important;--gray-600:128 128 128!important;--gray-700:104 104 104!important;--gray-800:81 81 81!important;--gray-900:57 57 57!important;--gray-950:19 19 19!important}#page-title{font-size:34px;font-weight:400;line-height:1.2}#page-title,.mdx-content,.prose{font-family:\"Söhne\",sans-serif}.mdx-content :where(p, [data-as=\"p\"]):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:16px;font-weight:400;margin-top:0;margin-bottom:24px}.mdx-content :where(h1):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:34px;font-weight:400;line-height:1.2;margin-top:48px;margin-bottom:24px}.mdx-content :where(h2):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:28px;font-weight:400;line-height:1.3;margin-top:48px;margin-bottom:24px}.mdx-content :where(h3):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:24px;font-weight:400;line-height:1.35;margin-top:32px;margin-bottom:16px}.mdx-content :where(h4):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:18px;font-weight:400;line-height:1.4;margin-top:32px;margin-bottom:16px}.mdx-content :where(h5):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:22px;font-weight:400;line-height:1.4;margin-top:24px;margin-bottom:12px}.mdx-content :where(h6):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:20px;font-weight:400;line-height:1.4;margin-top:24px;margin-bottom:12px}.mdx-content :where(ol):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)),.mdx-content :where(ul):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:16px;font-weight:400}.mdx-content :where(blockquote):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:16px;font-weight:400;line-height:1.5;padding:12px 16px;margin-top:16px;margin-bottom:16px}.mdx-content :where(blockquote cite):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, [class~=\"not-prose\"] *)){display:block;font-family:\"Söhne Mono\",monospace;font-size:14px;text-transform:uppercase;font-style:normal}.mdx-content :where(img):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){border-radius:8px;margin-top:80px;margin-bottom:80px;max-width:min(850px,100%)}.mdx-content :where(figcaption):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:14px;margin-top:20px}.eyebrow{font-family:\"Söhne Mono\",monospace;font-size:14px;font-weight:400;text-transform:uppercase;letter-spacing:.04em}@media (max-width:768px){#page-title{font-size:28px}.mdx-content :where(p, [data-as=\"p\"]):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:16px;margin-bottom:20px}.mdx-content :where(h1):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:28px;margin-bottom:20px}.mdx-content :where(h2):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:24px;margin-top:36px;margin-bottom:20px}.mdx-content :where(h3):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:20px;margin-top:24px;margin-bottom:12px}.mdx-content :where(h4):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:18px;margin-top:24px;margin-bottom:12px}.mdx-content :where(h5):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)),.mdx-content :where(h6):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:18px}.mdx-content :where(ol):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)),.mdx-content :where(ul):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:16px}.mdx-content :where(blockquote):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){font-size:16px;padding:12px 16px;margin-top:12px;margin-bottom:12px}.mdx-content :where(img):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){margin-top:60px;margin-bottom:60px;max-width:100%}.mdx-content :where(figcaption):not(:where(.card *, [data-component-part=\"tab-content\"] *, [data-component-part=\"callout-content\"] *, blockquote *, [class~=\"not-prose\"] *)){margin-top:16px}.eyebrow{font-size:12px}}#topbar-cta-button a>span:first-child{background-color:#fff;border-radius:4px;opacity:1;transition:background-color .15s ease}#topbar-cta-button a:hover>span:first-child{background-color:#92e759;opacity:1}#topbar-cta-button a .z-10,#topbar-cta-button a .z-10 span,#topbar-cta-button a .z-10 svg{color:#131512!important}.navbar-link a:hover,.navbar-link a:hover span{color:#436633!important}.dark .navbar-link a:hover,.dark .navbar-link a:hover span{color:#92e759!important}.mdx-content,.prose{--tw-prose-links:#436633;--tw-prose-invert-links:#92e759}.mdx-content :where(a):not(:where([class~=\"not-prose\"] *)),.prose :where(a){text-decoration-color:#92e759}.mdx-content :where(a):not(:where([class~=\"not-prose\"] *)):hover,.prose :where(a):hover{color:#28382b}.dark .mdx-content :where(a):not(:where([class~=\"not-prose\"] *)):hover,.dark .prose :where(a):hover{color:#436633}:root{--welcome-accent:#436633;--welcome-accent-fg:#ffffff;--welcome-subtle:#f2f7f3;--welcome-subtle-border:#dfe8d6;--welcome-surface:#ffffff;--welcome-panel:#fafafa;--welcome-border:#e4e4e7;--welcome-text:#18181b;--welcome-text-2:#52525b;--welcome-text-3:#8a8a93}.dark{--welcome-accent:#92e759;--welcome-accent-fg:#131512;--welcome-subtle:rgba(146, 231, 89, 0.08);--welcome-subtle-border:rgba(146, 231, 89, 0.22);--welcome-surface:#131512;--welcome-panel:#1a1d19;--welcome-border:rgba(255, 255, 255, 0.1);--welcome-text:#f4f4f5;--welcome-text-2:#b5b5b5;--welcome-text-3:#8a8a8a}.welcome-featured{margin:32px 0 16px;padding:16px;border:1px solid var(--welcome-subtle-border);border-radius:12px;background:linear-gradient(180deg,var(--welcome-subtle),var(--welcome-surface))}.welcome-featured-head{display:flex;align-items:flex-start;gap:12px;color:var(--welcome-text);text-decoration:none}.welcome-featured-head:hover .welcome-arrow,.welcome-featured-head:hover .welcome-featured-title,.welcome-icon{color:var(--welcome-accent)}.welcome-icon{flex:none;width:34px;height:34px;border-radius:8px;background:var(--welcome-subtle);display:flex;align-items:center;justify-content:center}.welcome-arrow svg,.welcome-flow-arrow svg,.welcome-flow-outcome svg,.welcome-icon svg{background-color:currentColor!important}.welcome-featured-text{display:flex;flex-direction:column;gap:4px}.welcome-featured-title{font-size:16px;font-weight:500}.welcome-featured-desc{font-size:14px;line-height:1.6;color:var(--welcome-text-2)}.welcome-arrow{margin-left:auto;align-self:center;color:var(--welcome-text-3)}.welcome-featured [class*=code-block],.welcome-featured pre{margin-bottom:0!important}.welcome-flow,.welcome-step{border:1px solid var(--welcome-border)}.welcome-flow{margin:24px 0 8px;padding:20px;border-radius:12px;background:var(--welcome-panel)}.welcome-step{display:flex;flex-direction:column;align-items:center;gap:6px;padding:14px;border-radius:8px;background:var(--welcome-surface);color:var(--welcome-text);text-align:center}.welcome-step strong{font-size:14px;font-weight:500}.welcome-step-key{border:1.5px solid var(--welcome-accent);background:var(--welcome-subtle)}.welcome-label{font-size:11px;font-weight:600;letter-spacing:.04em;text-transform:uppercase;color:var(--welcome-text-3)}.welcome-muted{font-size:12px;color:var(--welcome-text-3)}.welcome-pills{display:flex;flex-wrap:wrap;justify-content:center;gap:6px;margin-top:4px}.welcome-pill{padding:3px 9px;border:1px solid var(--welcome-subtle-border);border-radius:9999px;background:var(--welcome-surface);color:var(--welcome-accent);font-size:11px;font-weight:600}.welcome-flow-steps{display:flex;align-items:stretch}.welcome-step{flex:1;min-width:0;justify-content:flex-start}.welcome-flow-arrow,.welcome-step-n{display:flex;align-items:center;justify-content:center}.welcome-step-n{width:22px;height:22px;border:1px solid var(--welcome-border);border-radius:9999px;background:var(--welcome-panel);color:var(--welcome-text-2);font-size:11px;font-weight:600}.welcome-step-key .welcome-step-n{border-color:var(--welcome-accent);background:var(--welcome-accent);color:var(--welcome-accent-fg)}.welcome-flow-arrow{flex:0 0 26px;color:var(--welcome-text-3)}.welcome-flow-outcomes{display:flex;flex-direction:column;align-items:center;gap:6px;margin-top:14px}.welcome-flow-outcome{display:flex;align-items:center;gap:8px;font-size:13px;color:var(--welcome-text-2)}.welcome-flow-pass svg,.welcome-runtime>.welcome-label{color:var(--welcome-accent)}.welcome-flow-fail svg{color:#dc2626}.welcome-flow-outcome strong{font-weight:600;color:var(--welcome-text)}@media (max-width:768px){.welcome-flow-steps{flex-direction:column}.welcome-flow-arrow{height:26px;transform:rotate(90deg)}}.welcome-runtime,.welcome-stack{display:flex;flex-direction:column}.welcome-stack{margin:24px 0 8px;padding:20px;align-items:center;border:1px solid var(--welcome-border);border-radius:12px;background:var(--welcome-panel)}.welcome-runtime{width:100%;padding:16px;gap:12px;border:1.5px solid var(--welcome-accent);border-radius:10px;background:var(--welcome-subtle)}.welcome-caps{display:grid;grid-template-columns:repeat(2,minmax(0,1fr));gap:10px}.welcome-cap,.welcome-deploy-opts span,.welcome-downstream{border:1px solid var(--welcome-border);background:var(--welcome-surface)}.welcome-cap,.welcome-downstream{display:flex;flex-direction:column;gap:8px;padding:14px;border-radius:8px;color:var(--welcome-text);text-decoration:none;transition:border-color .15s ease}.welcome-cap:hover,.welcome-downstream:hover{border-color:var(--welcome-accent)}.welcome-cap-head{display:flex;align-items:center;gap:10px}.welcome-cap-head .welcome-icon{width:28px;height:28px}.welcome-cap-head strong{font-size:15px;font-weight:500}.welcome-cap-desc{font-size:13px;line-height:1.55;color:var(--welcome-text-2)}.welcome-cap-link{margin-top:auto;display:inline-flex;align-items:center;gap:6px;font-size:12px;font-weight:600;color:var(--welcome-accent)}.welcome-cap-link svg,.welcome-stack-arrow svg{background-color:currentColor!important}.welcome-stack-arrow{height:32px;display:flex;align-items:center;color:var(--welcome-text-3)}.welcome-downstream{width:min(100%,360px)}.welcome-icon-neutral{background:var(--welcome-panel);color:var(--welcome-text-2)}.welcome-deploy-strip{width:100%;margin-top:16px;padding:10px 14px;display:flex;align-items:center;justify-content:center;gap:12px;border:1px dashed var(--welcome-border);border-radius:8px}.welcome-deploy-opts{display:flex;gap:8px}.welcome-deploy-opts span{padding:2px 10px;border-radius:9999px;color:var(--welcome-text-2);font-size:12px;font-weight:600}@media (max-width:768px){.welcome-caps{grid-template-columns:1fr}.welcome-deploy-strip{flex-direction:column;gap:8px}}.welcome-sys,.welcome-zone{border:1px solid var(--welcome-border)}.welcome-sys{margin:24px 0 8px;padding:28px 20px 20px;display:flex;flex-direction:column;border-radius:12px;background-color:var(--welcome-panel);background-image:radial-gradient(var(--welcome-border) 1px,transparent 1px);background-size:16px 16px}.welcome-zone{position:relative;border-radius:10px;background:var(--welcome-surface)}.welcome-zone-key{border:1.5px solid var(--welcome-accent)}.welcome-zone-tab{position:absolute;top:-11px;left:12px;padding:2px 8px;border:1px solid var(--welcome-border);border-radius:9999px;background:var(--welcome-surface);color:var(--welcome-text-2);font-size:11px;font-weight:600;white-space:nowrap}.welcome-zone-key .welcome-zone-tab{border-color:var(--welcome-accent);background:var(--welcome-accent);color:var(--welcome-accent-fg)}.welcome-zone-body{padding:20px 12px 12px;display:flex;flex-direction:column;gap:8px}.welcome-zone-key .welcome-zone-body{border-radius:9px;background:var(--welcome-subtle)}.welcome-zone-body>.welcome-label:not(:first-child){margin-top:4px}.welcome-row{display:grid;grid-template-columns:repeat(auto-fit,minmax(140px,1fr));gap:8px}.welcome-box{display:flex;align-items:center;gap:10px;padding:8px 10px;border:1px solid var(--welcome-border);border-radius:8px;background:var(--welcome-surface);color:var(--welcome-text)}.welcome-box>span:last-child:not(.welcome-icon){display:flex;flex-direction:column;min-width:0}.welcome-box strong{font-size:13px;font-weight:500;line-height:1.3}.welcome-box .welcome-muted{font-size:11px;line-height:1.3}.welcome-box .welcome-icon{width:26px;height:26px;border-radius:6px}.welcome-box .welcome-icon svg{width:13px;height:13px}.welcome-wires{display:flex;justify-content:center;gap:48px;padding:2px 0}.welcome-wire-row{display:flex;align-items:center;gap:10px}.welcome-wire-label{font-size:11px;line-height:1.3;color:var(--welcome-text-2)}.welcome-wire{position:relative;display:block;width:2px;height:40px;margin:8px 0;background-image:repeating-linear-gradient(180deg,var(--welcome-accent) 0 5px,transparent 5px 10px);background-size:2px 10px;animation:welcome-dash .9s linear infinite}.welcome-wire-both::before,.welcome-wire::after{content:\"\";position:absolute;left:-4px;border:5px solid transparent}.welcome-wire::after{bottom:-8px;border-top-color:var(--welcome-accent)}.welcome-wire-both::before,.welcome-wire-up::after{top:-8px;border-bottom-color:var(--welcome-accent)}.welcome-wire-up{animation-direction:reverse}.welcome-wire-up::after{bottom:auto;border-top-color:transparent}@media (prefers-reduced-motion:reduce){.welcome-wire{animation:none}}@media (max-width:768px){.welcome-row{grid-template-columns:1fr}.welcome-wires{gap:16px}.welcome-wire-label{max-width:110px}}.welcome-split{display:grid;grid-template-columns:minmax(0,1fr) 120px minmax(0,1fr);align-items:center}.welcome-split-wide{grid-template-columns:minmax(0,1.7fr) 120px minmax(0,1fr)}.welcome-link,.welcome-links{display:flex;flex-direction:column}.welcome-links{gap:18px;padding:0 4px}.welcome-link{gap:6px}.welcome-link .welcome-wire-label{font-size:10.5px;text-align:center}.welcome-wire-h{width:auto;height:2px;margin:0 8px;background-image:repeating-linear-gradient(90deg,var(--welcome-accent) 0 5px,transparent 5px 10px);background-size:10px 2px;animation-name:welcome-dash-h}.welcome-wire-h::after{top:-4px;bottom:auto;left:auto;right:-8px;border-color:transparent;border-left-color:var(--welcome-accent)}.welcome-wire-h.welcome-wire-rev{animation-direction:reverse}.welcome-wire-h.welcome-wire-rev::after{right:auto;left:-8px;border-left-color:transparent;border-right-color:var(--welcome-accent)}.welcome-wire-h.welcome-wire-both::before{top:-4px;left:-8px;border-color:transparent;border-right-color:var(--welcome-accent)}.welcome-group,.welcome-lock{display:flex;flex-direction:column}.welcome-lock{align-items:center;gap:6px;font-size:10.5px;line-height:1.3;text-align:center;color:var(--welcome-text-3)}.welcome-lock svg{width:14px;height:14px;background-color:currentColor!important}.welcome-group{gap:8px;padding:10px;border:1px dashed var(--welcome-border);border-radius:8px}.welcome-group-managed{border-color:var(--welcome-accent);background:var(--welcome-subtle)}.welcome-group-managed>.welcome-label{color:var(--welcome-accent)}.welcome-pipe{display:flex;flex-direction:column;align-items:flex-start;gap:2px}.welcome-chip{padding:4px 9px;border:1px solid var(--welcome-border);border-radius:6px;background:var(--welcome-surface);color:var(--welcome-text);font-size:12px;line-height:1.3}.welcome-pipe-arrow{padding-left:14px;color:var(--welcome-accent);font-size:12px;line-height:1.2}.welcome-inline-wire{display:flex;align-items:center;gap:10px;padding-left:24px}@media (max-width:768px){.welcome-split,.welcome-split-wide{grid-template-columns:1fr}.welcome-links{flex-direction:row;flex-wrap:wrap;justify-content:center;gap:8px 16px;padding:8px 0 18px}.welcome-link{flex-direction:row-reverse;align-items:center;gap:10px}.welcome-link .welcome-wire-label{max-width:110px;text-align:left}.welcome-wire-h{width:2px;height:36px;margin:8px 0;background-image:repeating-linear-gradient(180deg,var(--welcome-accent) 0 5px,transparent 5px 10px);background-size:2px 10px;animation-name:welcome-dash}.welcome-wire-h::after{top:auto;bottom:-8px;left:-4px;right:auto;border-color:transparent;border-top-color:var(--welcome-accent)}.welcome-wire-h.welcome-wire-rev::after{bottom:auto}.welcome-wire-h.welcome-wire-both::before,.welcome-wire-h.welcome-wire-rev::after{top:-8px;left:-4px;border-color:transparent;border-bottom-color:var(--welcome-accent)}}"}],"page":{"pagePath":"api-reference/credit-grants/create-a-credit-grant","slug":"/api-reference/credit-grants/create-a-credit-grant","pageMetadata":{"title":"Create a credit grant","description":"Creates a new credit grant for a customer with specified amount, type, and optional billing configuration.","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/grants","href":"/api-reference/credit-grants/create-a-credit-grant","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: \"Creates a new credit grant for a customer with specified amount, type, and optional billing configuration.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a credit grant","description":"Creates a new credit grant for a customer with specified amount, type, and optional billing configuration.","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/grants","href":"/api-reference/credit-grants/create-a-credit-grant","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/stigg/14aedc563c3207a3/content/custom.js"],"openApiReferenceData":{"operation":{"description":"Creates a new credit grant for a customer with specified amount, type, and optional billing configuration.","operationId":"CreditGrantController_grantCredits","parameters":["78002167-e9ca-40aa-a1b4-cbe58e13bd6e","64dc4631-2477-4feb-93c8-27d9e5040a86"],"requestBody":"b17b3a2a-8710-42fc-8295-c9765302bdbc","responses":{"201":"09d6a912-ceda-47d3-a5f4-44b58096a9f3","400":"31434244-e9c9-4b3c-a6fb-b5f41299dccc","401":"23a316bd-6bc3-406f-a2e4-4f028515365f","403":"f5c1de5a-9c2a-4fe1-b74d-a8388c15ebc6","409":"683c3cde-05aa-46d3-8269-37bf2eac9c23","429":"01d8d3b7-50a1-43da-aa21-6346592f80b5"},"summary":"Create a credit grant","tags":["Credit grants"],"x-codeSamples":[{"lang":"JavaScript","source":"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst creditGrantResponse = await client.v1.credits.grants.create({\n amount: 0,\n currencyId: 'currencyId',\n customerId: 'customerId',\n displayName: 'displayName',\n grantType: 'PAID',\n});\n\nconsole.log(creditGrantResponse.data);"},{"lang":"Python","source":"import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get(\"STIGG_API_KEY\"), # This is the default and can be omitted\n)\ncredit_grant_response = client.v1.credits.grants.create(\n amount=0,\n currency_id=\"currencyId\",\n customer_id=\"customerId\",\n display_name=\"displayName\",\n grant_type=\"PAID\",\n)\nprint(credit_grant_response.data)"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/stiggio/stigg-go\"\n\t\"github.com/stiggio/stigg-go/option\"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcreditGrantResponse, err := client.V1.Credits.Grants.New(context.TODO(), stigg.V1CreditGrantNewParams{\n\t\tAmount: 0,\n\t\tCurrencyID: \"currencyId\",\n\t\tCustomerID: \"customerId\",\n\t\tDisplayName: \"displayName\",\n\t\tGrantType: stigg.V1CreditGrantNewParamsGrantTypePaid,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", creditGrantResponse.Data)\n}\n"},{"lang":"Java","source":"package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.grants.CreditGrantResponse;\nimport io.stigg.models.v1.credits.grants.GrantCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n GrantCreateParams params = GrantCreateParams.builder()\n .amount(0.0)\n .currencyId(\"currencyId\")\n .customerId(\"customerId\")\n .displayName(\"displayName\")\n .grantType(GrantCreateParams.GrantType.PAID)\n .build();\n CreditGrantResponse creditGrantResponse = client.v1().credits().grants().create(params);\n }\n}"},{"lang":"Ruby","source":"require \"stigg\"\n\nstigg = Stigg::Client.new(api_key: \"My API Key\")\n\ncredit_grant_response = stigg.v1.credits.grants.create(\n amount: 0,\n currency_id: \"currencyId\",\n customer_id: \"customerId\",\n display_name: \"displayName\",\n grant_type: :PAID\n)\n\nputs(credit_grant_response)"},{"lang":"C#","source":"using System;\nusing Stigg.Client;\nusing Stigg.Client.Models.V1.Credits.Grants;\n\nStiggClient client = new();\n\nGrantCreateParams parameters = new()\n{\n Amount = 0,\n CurrencyID = \"currencyId\",\n CustomerID = \"customerId\",\n DisplayName = \"displayName\",\n GrantType = GrantType.Paid,\n};\n\nvar creditGrantResponse = await client.V1.Credits.Grants.Create(parameters);\n\nConsole.WriteLine(creditGrantResponse);"},{"lang":"CLI","source":"stigg v1:credits:grants create \\\n --api-key 'My API Key' \\\n --amount 0 \\\n --currency-id currencyId \\\n --customer-id customerId \\\n --display-name displayName \\\n --grant-type PAID"}],"method":"post","type":"path","servers":["965bfafb-3020-43f4-9190-ffd0664cbe30"],"security":["aca68cbb-91ac-4e9a-a46e-79ed4ad7e7d6"],"path":"/api/v1/credits/grants","baseUrlOptions":["https://api.stigg.io"],"title":"Create a credit grant","codeSamples":[{"lang":"JavaScript","source":"import Stigg from '@stigg/typescript';\n\nconst client = new Stigg({\n apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted\n});\n\nconst creditGrantResponse = await client.v1.credits.grants.create({\n amount: 0,\n currencyId: 'currencyId',\n customerId: 'customerId',\n displayName: 'displayName',\n grantType: 'PAID',\n});\n\nconsole.log(creditGrantResponse.data);"},{"lang":"Python","source":"import os\nfrom stigg import Stigg\n\nclient = Stigg(\n api_key=os.environ.get(\"STIGG_API_KEY\"), # This is the default and can be omitted\n)\ncredit_grant_response = client.v1.credits.grants.create(\n amount=0,\n currency_id=\"currencyId\",\n customer_id=\"customerId\",\n display_name=\"displayName\",\n grant_type=\"PAID\",\n)\nprint(credit_grant_response.data)"},{"lang":"Go","source":"package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/stiggio/stigg-go\"\n\t\"github.com/stiggio/stigg-go/option\"\n)\n\nfunc main() {\n\tclient := stigg.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcreditGrantResponse, err := client.V1.Credits.Grants.New(context.TODO(), stigg.V1CreditGrantNewParams{\n\t\tAmount: 0,\n\t\tCurrencyID: \"currencyId\",\n\t\tCustomerID: \"customerId\",\n\t\tDisplayName: \"displayName\",\n\t\tGrantType: stigg.V1CreditGrantNewParamsGrantTypePaid,\n\t})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", creditGrantResponse.Data)\n}\n"},{"lang":"Java","source":"package io.stigg.example;\n\nimport io.stigg.client.StiggClient;\nimport io.stigg.client.okhttp.StiggOkHttpClient;\nimport io.stigg.models.v1.credits.grants.CreditGrantResponse;\nimport io.stigg.models.v1.credits.grants.GrantCreateParams;\n\npublic final class Main {\n private Main() {}\n\n public static void main(String[] args) {\n StiggClient client = StiggOkHttpClient.fromEnv();\n\n GrantCreateParams params = GrantCreateParams.builder()\n .amount(0.0)\n .currencyId(\"currencyId\")\n .customerId(\"customerId\")\n .displayName(\"displayName\")\n .grantType(GrantCreateParams.GrantType.PAID)\n .build();\n CreditGrantResponse creditGrantResponse = client.v1().credits().grants().create(params);\n }\n}"},{"lang":"Ruby","source":"require \"stigg\"\n\nstigg = Stigg::Client.new(api_key: \"My API Key\")\n\ncredit_grant_response = stigg.v1.credits.grants.create(\n amount: 0,\n currency_id: \"currencyId\",\n customer_id: \"customerId\",\n display_name: \"displayName\",\n grant_type: :PAID\n)\n\nputs(credit_grant_response)"},{"lang":"C#","source":"using System;\nusing Stigg.Client;\nusing Stigg.Client.Models.V1.Credits.Grants;\n\nStiggClient client = new();\n\nGrantCreateParams parameters = new()\n{\n Amount = 0,\n CurrencyID = \"currencyId\",\n CustomerID = \"customerId\",\n DisplayName = \"displayName\",\n GrantType = GrantType.Paid,\n};\n\nvar creditGrantResponse = await client.V1.Credits.Grants.Create(parameters);\n\nConsole.WriteLine(creditGrantResponse);"},{"lang":"CLI","source":"stigg v1:credits:grants create \\\n --api-key 'My API Key' \\\n --amount 0 \\\n --currency-id currencyId \\\n --customer-id customerId \\\n --display-name displayName \\\n --grant-type PAID"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"78002167-e9ca-40aa-a1b4-cbe58e13bd6e":{"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"}},"64dc4631-2477-4feb-93c8-27d9e5040a86":{"name":"X-ENVIRONMENT-ID","in":"header","description":"Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).","required":false,"schema":{"type":"string","isRequired":false,"description":"Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","maxLength":255,"description":"The display name for the credit grant","isRequired":true,"uniqueKey":"displayName","typeLabel":"string"},"amount":{"type":"number","description":"The credit amount to grant","isRequired":true,"uniqueKey":"amount","typeLabel":"number"},"grantType":{"type":"string","enum":["PAID","PROMOTIONAL"],"description":"The type of credit grant (PAID, PROMOTIONAL)","isRequired":true,"uniqueKey":"grantType","typeLabel":"enum\u003cstring>"},"customerId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.@-]*$","description":"The customer ID to grant credits to (required)","isRequired":true,"uniqueKey":"customerId","typeLabel":"string"},"currencyId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"The credit currency ID (required)","isRequired":true,"uniqueKey":"currencyId","typeLabel":"string"},"priority":{"type":"integer","minimum":0,"maximum":100,"description":"Determines which grant is drawn down first when the customer has multiple active grants in the same currency (0-100). Lower numbers are consumed first. Defaults to 50 — the same default used for recurring credits granted by a plan or price — so without setting this explicitly, draw order against plan-included credits falls back to expiration date and grant type. To have this grant consumed before or after plan-included credits, set a lower or higher priority than the plan/price credit configuration.","uniqueKey":"priority","typeLabel":"integer"},"effectiveAt":{"type":"string","format":"date-time","description":"The date when the credit grant becomes effective","uniqueKey":"effectiveAt","typeLabel":"string\u003cdate-time>"},"expireAt":{"type":"string","format":"date-time","description":"The date when the credit grant expires","uniqueKey":"expireAt","typeLabel":"string\u003cdate-time>"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.additionalProperties","typeLabel":"string"},"description":"Additional metadata for the credit grant","uniqueKey":"metadata","typeLabel":"object"},"cost":{"type":"object","properties":{"amount":{"type":"number","description":"The price amount","isRequired":true,"uniqueKey":"cost.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":"cost.currency","typeLabel":"enum\u003cstring>"}},"required":["amount","currency"],"title":"Money","description":"The monetary cost of the credit grant","uniqueKey":"cost","typeLabel":"Money · object"},"comment":{"type":"string","maxLength":255,"description":"An optional comment on the credit grant","uniqueKey":"comment","typeLabel":"string"},"resourceId":{"type":"string","maxLength":255,"minLength":1,"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$","description":"The resource ID to scope the grant to","uniqueKey":"resourceId","typeLabel":"string"},"paymentCollectionMethod":{"type":"string","enum":["CHARGE","INVOICE","NONE"],"description":"The payment collection method (CHARGE, INVOICE, NONE). Optional if the grant has no `cost`, since there is nothing to collect payment for. With NONE or CHARGE, the grant is active and its credits are usable right away (or as soon as the charge succeeds). With INVOICE, the grant stays pending — its credits are not usable — until the generated invoice is paid.","uniqueKey":"paymentCollectionMethod","typeLabel":"enum\u003cstring>"},"awaitPaymentConfirmation":{"type":"boolean","description":"Whether to wait for payment confirmation before returning (default: true). When false, the request returns immediately while payment (if any) is collected asynchronously; check the returned status to see whether the credits are already usable.","uniqueKey":"awaitPaymentConfirmation","typeLabel":"boolean"},"billingInformation":{"type":"object","properties":{"isInvoicePaid":{"type":"boolean","description":"Whether the invoice is already paid","uniqueKey":"billingInformation.isInvoicePaid","typeLabel":"boolean"},"invoiceDaysUntilDue":{"type":"number","description":"Days until the invoice is due","uniqueKey":"billingInformation.invoiceDaysUntilDue","typeLabel":"number"},"billingAddress":{"type":"object","properties":{"city":{"type":"string","description":"City name","uniqueKey":"billingInformation.billingAddress.city","typeLabel":"string"},"country":{"type":"string","description":"Country code or name","uniqueKey":"billingInformation.billingAddress.country","typeLabel":"string"},"line1":{"type":"string","description":"Street address line 1","uniqueKey":"billingInformation.billingAddress.line1","typeLabel":"string"},"line2":{"type":"string","description":"Street address line 2","uniqueKey":"billingInformation.billingAddress.line2","typeLabel":"string"},"postalCode":{"type":"string","description":"Postal or ZIP code","uniqueKey":"billingInformation.billingAddress.postalCode","typeLabel":"string"},"state":{"type":"string","description":"State or province","uniqueKey":"billingInformation.billingAddress.state","typeLabel":"string"}},"additionalProperties":false,"title":"Address","description":"The billing address","uniqueKey":"billingInformation.billingAddress","typeLabel":"Address · object"}},"additionalProperties":false,"title":"CreditGrantBillingInfo","description":"Billing information for the credit grant, used when the grant has a payment collection method that requires collecting payment (e.g. invoice due date, billing address).","uniqueKey":"billingInformation","typeLabel":"CreditGrantBillingInfo · object"}},"required":["displayName","amount","grantType","customerId","currencyId"],"additionalProperties":false,"title":"GrantCreditRequest","description":"Request body for creating a credit grant. Grants cannot be edited after creation — void and re-grant if the amount, priority, or expiration needs to change.","uniqueKey":"","typeLabel":"GrantCreditRequest · object"},"examples":{"Example":{"title":"Example","value":{"displayName":"\u003cstring>","amount":123,"customerId":"\u003cstring>","currencyId":"\u003cstring>","priority":50,"effectiveAt":"2023-11-07T05:31:56Z","expireAt":"2023-11-07T05:31:56Z","metadata":{},"comment":"\u003cstring>","resourceId":"\u003cstring>","awaitPaymentConfirmation":true,"billingInformation":{"isInvoicePaid":true,"invoiceDaysUntilDue":123,"billingAddress":{"city":"\u003cstring>","country":"\u003cstring>","line1":"\u003cstring>","line2":"\u003cstring>","postalCode":"\u003cstring>","state":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"09d6a912-ceda-47d3-a5f4-44b58096a9f3":{"description":"The newly created credit grant object.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","maxLength":255,"description":"The unique readable identifier of the credit grant","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"displayName":{"type":"string","maxLength":255,"description":"The display name of the credit grant","isRequired":true,"uniqueKey":"data.displayName","typeLabel":"string"},"amount":{"type":"number","description":"The total credits granted","isRequired":true,"uniqueKey":"data.amount","typeLabel":"number"},"consumedAmount":{"type":"number","description":"The total credits consumed from this grant","isRequired":true,"uniqueKey":"data.consumedAmount","typeLabel":"number"},"grantType":{"type":"string","enum":["PAID","PROMOTIONAL","RECURRING","OVERDRAFT"],"description":"The type of credit grant (PAID, PROMOTIONAL, RECURRING, OVERDRAFT)","isRequired":true,"uniqueKey":"data.grantType","typeLabel":"enum\u003cstring>"},"sourceType":{"oneOf":[{"type":"string","enum":["PRICE","PLAN_ENTITLEMENT","ADDON_ENTITLEMENT"],"description":"The source type of the grant (PRICE, PLAN_ENTITLEMENT, ADDON_ENTITLEMENT)","isRequired":true,"uniqueKey":"data.sourceType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["PRICE","PLAN_ENTITLEMENT","ADDON_ENTITLEMENT"],"description":"The source type of the grant (PRICE, PLAN_ENTITLEMENT, ADDON_ENTITLEMENT)","isRequired":true,"uniqueKey":"data.sourceType.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.sourceType","typeLabel":"enum\u003cstring> | null"},"priority":{"type":"number","description":"The priority of the credit grant (lower number = higher priority)","isRequired":true,"uniqueKey":"data.priority","typeLabel":"number"},"effectiveAt":{"type":"string","format":"date-time","description":"The date when the credit grant becomes effective","isRequired":true,"uniqueKey":"data.effectiveAt","typeLabel":"string\u003cdate-time>"},"expireAt":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the credit grant expires","isRequired":true,"uniqueKey":"data.expireAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date when the credit grant expires","isRequired":true,"uniqueKey":"data.expireAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.expireAt","typeLabel":"string\u003cdate-time> | null"},"voidedAt":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the credit grant was voided","isRequired":true,"uniqueKey":"data.voidedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date when the credit grant was voided","isRequired":true,"uniqueKey":"data.voidedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.voidedAt","typeLabel":"string\u003cdate-time> | null"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"data.metadata.additionalProperties","typeLabel":"string"},"description":"Metadata associated with the entity","isRequired":true,"uniqueKey":"data.metadata","typeLabel":"object"},"cost":{"type":"object","properties":{"amount":{"type":"number","description":"The cost amount","isRequired":true,"uniqueKey":"data.cost.amount","typeLabel":"number"},"currency":{"type":"string","maxLength":255,"description":"The currency code","isRequired":true,"uniqueKey":"data.cost.currency","typeLabel":"string"}},"required":["amount","currency"],"description":"The monetary cost of the credit grant","isRequired":true,"uniqueKey":"data.cost","typeLabel":"object"},"comment":{"oneOf":[{"type":"string","maxLength":255,"description":"An optional comment on the credit grant","isRequired":true,"uniqueKey":"data.comment.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"An optional comment on the credit grant","isRequired":true,"uniqueKey":"data.comment.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.comment","typeLabel":"string | null"},"customerId":{"type":"string","maxLength":255,"description":"The customer ID this grant belongs to","isRequired":true,"uniqueKey":"data.customerId","typeLabel":"string"},"resourceId":{"oneOf":[{"type":"string","maxLength":255,"description":"The resource ID this grant is scoped to","isRequired":true,"uniqueKey":"data.resourceId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The resource ID this grant is scoped to","isRequired":true,"uniqueKey":"data.resourceId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.resourceId","typeLabel":"string | null"},"currencyId":{"type":"string","maxLength":255,"description":"The currency identifier for this grant","isRequired":true,"uniqueKey":"data.currencyId","typeLabel":"string"},"invoiceId":{"oneOf":[{"type":"string","maxLength":255,"description":"The billing invoice ID associated with this grant","isRequired":true,"uniqueKey":"data.invoiceId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The billing invoice ID associated with this grant","isRequired":true,"uniqueKey":"data.invoiceId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.invoiceId","typeLabel":"string | null"},"latestInvoice":{"oneOf":[{"type":"object","properties":{"billingId":{"type":"string","maxLength":255,"description":"The billing provider invoice ID","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.billingId","typeLabel":"string"},"status":{"type":"string","enum":["OPEN","PAID","CANCELED"],"description":"The invoice status","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","description":"The invoice creation date","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"The invoice last update date","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.updatedAt","typeLabel":"string\u003cdate-time>"},"dueDate":{"oneOf":[{"type":"string","format":"date-time","description":"The invoice due date","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.dueDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The invoice due date","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.dueDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.dueDate","typeLabel":"string\u003cdate-time> | null"},"requiresAction":{"type":"boolean","description":"Whether the invoice requires user action","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.requiresAction","typeLabel":"boolean"},"billingReason":{"oneOf":[{"type":"string","enum":["MANUAL","OTHER"],"description":"The billing reason for the invoice","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.billingReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["MANUAL","OTHER"],"description":"The billing reason for the invoice","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.billingReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.billingReason","typeLabel":"enum\u003cstring> | null"},"paymentUrl":{"oneOf":[{"type":"string","maxLength":255,"description":"The payment URL for settling the invoice","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.paymentUrl.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The payment URL for settling the invoice","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.paymentUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.paymentUrl","typeLabel":"string | null"},"errorMessage":{"oneOf":[{"type":"string","maxLength":255,"description":"Error message if payment failed","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.errorMessage.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"Error message if payment failed","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.errorMessage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.errorMessage","typeLabel":"string | null"},"pdfUrl":{"oneOf":[{"type":"string","maxLength":2048,"description":"The PDF URL of the invoice","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.pdfUrl.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":2048,"description":"The PDF URL of the invoice","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.pdfUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.pdfUrl","typeLabel":"string | null"},"currency":{"oneOf":[{"type":"string","maxLength":255,"description":"The invoice currency","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.currency.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The invoice currency","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.currency","typeLabel":"string | null"},"subTotal":{"oneOf":[{"type":"number","description":"The subtotal amount before tax","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.subTotal.oneOf.0","typeLabel":"number"},{"type":"null","description":"The subtotal amount before tax","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.subTotal.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.subTotal","typeLabel":"number | null"},"total":{"oneOf":[{"type":"number","description":"The total amount including tax","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.total.oneOf.0","typeLabel":"number"},{"type":"null","description":"The total amount including tax","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.total.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.total","typeLabel":"number | null"},"tax":{"oneOf":[{"type":"number","description":"The tax amount","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.tax.oneOf.0","typeLabel":"number"},{"type":"null","description":"The tax amount","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.tax.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0.tax","typeLabel":"number | null"}},"required":["billingId","status","createdAt","updatedAt","dueDate","requiresAction","billingReason","paymentUrl","errorMessage","pdfUrl","currency","subTotal","total","tax"],"title":"CreditGrantInvoice","description":"The latest invoice details for this grant","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.0","typeLabel":"CreditGrantInvoice · object"},{"type":"null","properties":{"billingId":{"type":"string","maxLength":255,"description":"The billing provider invoice ID"},"status":{"type":"string","enum":["OPEN","PAID","CANCELED"],"description":"The invoice status"},"createdAt":{"type":"string","format":"date-time","description":"The invoice creation date"},"updatedAt":{"type":"string","format":"date-time","description":"The invoice last update date"},"dueDate":{"oneOf":[{"type":"string","format":"date-time","description":"The invoice due date"},{"type":"null","format":"date-time","description":"The invoice due date"}]},"requiresAction":{"type":"boolean","description":"Whether the invoice requires user action"},"billingReason":{"oneOf":[{"type":"string","enum":["MANUAL","OTHER"],"description":"The billing reason for the invoice"},{"type":"null","enum":["MANUAL","OTHER"],"description":"The billing reason for the invoice"}]},"paymentUrl":{"oneOf":[{"type":"string","maxLength":255,"description":"The payment URL for settling the invoice"},{"type":"null","maxLength":255,"description":"The payment URL for settling the invoice"}]},"errorMessage":{"oneOf":[{"type":"string","maxLength":255,"description":"Error message if payment failed"},{"type":"null","maxLength":255,"description":"Error message if payment failed"}]},"pdfUrl":{"oneOf":[{"type":"string","maxLength":2048,"description":"The PDF URL of the invoice"},{"type":"null","maxLength":2048,"description":"The PDF URL of the invoice"}]},"currency":{"oneOf":[{"type":"string","maxLength":255,"description":"The invoice currency"},{"type":"null","maxLength":255,"description":"The invoice currency"}]},"subTotal":{"oneOf":[{"type":"number","description":"The subtotal amount before tax"},{"type":"null","description":"The subtotal amount before tax"}]},"total":{"oneOf":[{"type":"number","description":"The total amount including tax"},{"type":"null","description":"The total amount including tax"}]},"tax":{"oneOf":[{"type":"number","description":"The tax amount"},{"type":"null","description":"The tax amount"}]}},"required":["billingId","status","createdAt","updatedAt","dueDate","requiresAction","billingReason","paymentUrl","errorMessage","pdfUrl","currency","subTotal","total","tax"],"title":"CreditGrantInvoice","description":"The latest invoice details for this grant","isRequired":true,"uniqueKey":"data.latestInvoice.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.latestInvoice","typeLabel":"CreditGrantInvoice · object | null"},"syncStates":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"vendorIdentifier":{"type":"string","enum":["AUTH0","ZUORA","STRIPE","HUBSPOT","AWS_MARKETPLACE","SNOWFLAKE","SALESFORCE","BIG_QUERY","OPEN_FGA","APP_STORE","RECEIVED","PREQUEL","AIRWALLEX","STRIPE_INVOICING"],"description":"The vendor identifier of the integration (e.g. STRIPE, SALESFORCE, SNOWFLAKE)","isRequired":true,"uniqueKey":"data.syncStates.oneOf.0.items.[INDEX].vendorIdentifier","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["PENDING","ERROR","SUCCESS","NO_SYNC_REQUIRED"],"description":"Status of the integration sync","isRequired":true,"uniqueKey":"data.syncStates.oneOf.0.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"syncedEntityId":{"oneOf":[{"type":"string","maxLength":255,"description":"The external entity ID this record is linked to in the vendor system (e.g. the Stripe customer ID). Null until the link has synced; required when creating the link.","isRequired":true,"uniqueKey":"data.syncStates.oneOf.0.items.[INDEX].syncedEntityId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":255,"description":"The external entity ID this record is linked to in the vendor system (e.g. the Stripe customer ID). Null until the link has synced; required when creating the link.","isRequired":true,"uniqueKey":"data.syncStates.oneOf.0.items.[INDEX].syncedEntityId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.syncStates.oneOf.0.items.[INDEX].syncedEntityId","typeLabel":"string | null"}},"required":["vendorIdentifier","status","syncedEntityId"],"uniqueKey":"data.syncStates.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"The synchronization states of the entity with external systems","isRequired":true,"uniqueKey":"data.syncStates.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"vendorIdentifier":{"type":"string","enum":["AUTH0","ZUORA","STRIPE","HUBSPOT","AWS_MARKETPLACE","SNOWFLAKE","SALESFORCE","BIG_QUERY","OPEN_FGA","APP_STORE","RECEIVED","PREQUEL","AIRWALLEX","STRIPE_INVOICING"],"description":"The vendor identifier of the integration (e.g. STRIPE, SALESFORCE, SNOWFLAKE)"},"status":{"type":"string","enum":["PENDING","ERROR","SUCCESS","NO_SYNC_REQUIRED"],"description":"Status of the integration sync"},"syncedEntityId":{"oneOf":[{"type":"string","maxLength":255,"description":"The external entity ID this record is linked to in the vendor system (e.g. the Stripe customer ID). Null until the link has synced; required when creating the link."},{"type":"null","maxLength":255,"description":"The external entity ID this record is linked to in the vendor system (e.g. the Stripe customer ID). Null until the link has synced; required when creating the link."}]}},"required":["vendorIdentifier","status","syncedEntityId"]},"description":"The synchronization states of the entity with external systems","isRequired":true,"uniqueKey":"data.syncStates.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.syncStates","typeLabel":"object[] | null"},"paymentCollection":{"type":"string","enum":["NOT_REQUIRED","PROCESSING","FAILED","ACTION_REQUIRED"],"description":"The payment collection status","isRequired":true,"uniqueKey":"data.paymentCollection","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["PAYMENT_PENDING","ACTIVE","EXPIRED","VOIDED","SCHEDULED"],"description":"The effective status of the credit grant. A grant with paymentCollectionMethod NONE or CHARGE becomes ACTIVE (and its credits become usable) as soon as it's created (or as soon as the charge succeeds). A grant with paymentCollectionMethod INVOICE stays PAYMENT_PENDING — its credits are not usable — until the invoice is paid.","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp of when the record was created","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp of when the record was last updated","isRequired":true,"uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","displayName","amount","consumedAmount","grantType","sourceType","priority","effectiveAt","expireAt","voidedAt","metadata","cost","comment","customerId","resourceId","currencyId","invoiceId","latestInvoice","syncStates","paymentCollection","status","createdAt","updatedAt"],"title":"CreditGrant","description":"Credit grant object representing allocated credits for a customer. Credit grants cannot be edited after creation via this API — void the grant to stop further consumption from it, then create a new grant with the corrected amount, priority, or expiration.","isRequired":true,"uniqueKey":"data","typeLabel":"CreditGrant · object"}},"required":["data"],"title":"Response","description":"Response object","uniqueKey":"","typeLabel":"Response · object"},"examples":{"default":{"title":"default","value":{"data":{"id":"cred-grant-abc123","displayName":"Monthly credits","amount":1000,"consumedAmount":250,"grantType":"PROMOTIONAL","sourceType":null,"priority":1,"effectiveAt":"2024-01-01T00:00:00.000Z","expireAt":"2024-12-31T23:59:59.000Z","voidedAt":null,"metadata":{},"cost":{"amount":0,"currency":"usd"},"comment":null,"customerId":"customer-123","resourceId":null,"currencyId":"credits","invoiceId":null,"latestInvoice":null,"syncStates":[{"vendorIdentifier":"STRIPE","status":"PENDING","syncedEntityId":null}],"paymentCollection":"NOT_REQUIRED","status":"ACTIVE","createdAt":"2025-10-26T10:00:00.000Z","updatedAt":"2025-10-26T10:00:00.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"31434244-e9c9-4b3c-a6fb-b5f41299dccc":{"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"],"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"],"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"},"23a316bd-6bc3-406f-a2e4-4f028515365f":{"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"},"f5c1de5a-9c2a-4fe1-b74d-a8388c15ebc6":{"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"},"683c3cde-05aa-46d3-8269-37bf2eac9c23":{"description":"CreditGrant 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"},"01d8d3b7-50a1-43da-aa21-6346592f80b5":{"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":{"aca68cbb-91ac-4e9a-a46e-79ed4ad7e7d6":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"Server API Key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"965bfafb-3020-43f4-9190-ffd0664cbe30":{"url":"https://api.stigg.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"Server API Key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"X-API-KEY","type":"string","description":"Server API Key","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-KEY"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi/stigg-api.documented.yml"},"subdomain":"stigg","siteName":"Stigg","title":"Create a credit grant - Stigg","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T14:26:13.240Z","originalFileLocation":"api-reference/credit-grants/create-a-credit-grant.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a new credit grant for a customer with specified amount, type, and optional billing configuration.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Stigg\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/stigg/7i-fa_rP-Js-8M8l/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a credit grant - Stigg\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new credit grant for a customer with specified amount, type, and optional billing configuration.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Stigg\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.stigg.io/api-reference/credit-grants/create-a-credit-grant\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://stigg.mintlify.app/_mintlify/api/og/v2?division=Credit+grants\u0026amp;title=Create+a+credit+grant\u0026amp;description=Creates+a+new+credit+grant+for+a+customer+with+specified+amount%2C+type%2C+and+optional+billing+configuration.\u0026amp;theme=2f1adfbb069b3c699f8f4495\u0026amp;signature=c8f6486f56e4731610acc0f1aef893e280e9be3796c11b5a90cef83910034825\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a credit grant - Stigg\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new credit grant for a customer with specified amount, type, and optional billing configuration.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://stigg.mintlify.app/_mintlify/api/og/v2?division=Credit+grants\u0026amp;title=Create+a+credit+grant\u0026amp;description=Creates+a+new+credit+grant+for+a+customer+with+specified+amount%2C+type%2C+and+optional+billing+configuration.\u0026amp;theme=2f1adfbb069b3c699f8f4495\u0026amp;signature=c8f6486f56e4731610acc0f1aef893e280e9be3796c11b5a90cef83910034825\">\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/credit-grants/create-a-credit-grant\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/credit-grants/create-a-credit-grant.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/credit-grants/create-a-credit-grant#webpage\",\"url\":\"https://docs.stigg.io/api-reference/credit-grants/create-a-credit-grant\",\"name\":\"Create a credit grant\",\"description\":\"Creates a new credit grant for a customer with specified amount, type, and optional billing configuration.\",\"dateModified\":\"2026-11-02T14:26:13.240Z\",\"isPartOf\":{\"@id\":\"https://docs.stigg.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.stigg.io/api-reference/credit-grants/create-a-credit-grant#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.stigg.io/api-reference/credit-grants/create-a-credit-grant#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Credit grants\",\"item\":\"https://docs.stigg.io/api-reference/credit-grants/get-a-list-of-credit-grants\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a credit grant\",\"item\":\"https://docs.stigg.io/api-reference/credit-grants/create-a-credit-grant\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.stigg.io/api-reference/credit-grants/create-a-credit-grant#apireference\",\"headline\":\"Create a credit grant\",\"name\":\"Create a credit grant\",\"description\":\"Creates a new credit grant for a customer with specified amount, type, and optional billing configuration.\",\"url\":\"https://docs.stigg.io/api-reference/credit-grants/create-a-credit-grant\",\"mainEntityOfPage\":{\"@id\":\"https://docs.stigg.io/api-reference/credit-grants/create-a-credit-grant#webpage\"},\"dateModified\":\"2026-11-02T14:26:13.240Z\",\"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","description":"Retrieves a paginated list of credit grants for a customer.","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","description":"Voids an existing credit grant, preventing further consumption of the remaining credits.","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/grants/{id}/void","href":"/api-reference/credit-grants/void-credit-grant"}]},{"group":"Credit consumption","pages":[{"title":"Consume credits","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/consumption","href":"/api-reference/credit-consumption/consume-credits"},{"title":"Consume credits asynchronously","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/consumption/async","href":"/api-reference/credit-consumption/consume-credits-asynchronously"}]},{"group":"Credit reservations","pages":[{"title":"Release a credit reservation","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/reservations/{reservationId}/release","href":"/api-reference/credit-reservations/release-a-credit-reservation"}]},{"group":"Credit usage","pages":[{"title":"Get credit usage","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/credits/usage","href":"/api-reference/credit-usage/get-credit-usage"}]},{"group":"Auto recharge","pages":[{"title":"Get automatic recharge configuration","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/credits/auto-recharge","href":"/api-reference/auto-recharge/get-automatic-recharge-configuration"}]},{"group":"Custom currencies","pages":[{"title":"Get a list of custom currencys","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/credits/custom-currencies","href":"/api-reference/custom-currencies/get-a-list-of-custom-currencys"},{"title":"Create custom currency","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/custom-currencies","href":"/api-reference/custom-currencies/create-custom-currency"},{"title":"Update custom currency","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/credits/custom-currencies/{currencyId}","href":"/api-reference/custom-currencies/update-custom-currency"},{"title":"Archive custom currency","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/custom-currencies/{currencyId}/archive","href":"/api-reference/custom-currencies/archive-custom-currency"},{"title":"Unarchive custom currency","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/credits/custom-currencies/{currencyId}/unarchive","href":"/api-reference/custom-currencies/unarchive-custom-currency"},{"title":"List custom currency associated entities","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/credits/custom-currencies/{currencyId}/associated-entities","href":"/api-reference/custom-currencies/list-custom-currency-associated-entities"}]},{"group":"Credit ledger","pages":[{"title":"Get a list of credit ledger events","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/credits/ledger","href":"/api-reference/credit-ledger/get-a-list-of-credit-ledger-events"}]},{"group":"Contracts","pages":[{"title":"Get a list of contracts","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts","href":"/api-reference/contracts/get-a-list-of-contracts"},{"title":"Create contract","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts","href":"/api-reference/contracts/create-contract"},{"title":"List pricing models","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts/pricing-models","href":"/api-reference/contracts/list-pricing-models"},{"title":"List legal entities","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts/legal-entities","href":"/api-reference/contracts/list-legal-entities"},{"title":"Get a single contract by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts/{id}","href":"/api-reference/contracts/get-a-single-contract-by-id"},{"title":"Update a contract","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/contracts/{id}","href":"/api-reference/contracts/update-a-contract"},{"title":"Delete contract","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/archive","href":"/api-reference/contracts/delete-contract"},{"title":"Add contract line items","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/billing/items","href":"/api-reference/contracts/add-contract-line-items"},{"title":"Delete contract line item","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/contracts/{id}/billing/items/{itemRef}","href":"/api-reference/contracts/delete-contract-line-item"},{"title":"Update contract line item rows","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/contracts/{id}/billing/items/{itemRef}","href":"/api-reference/contracts/update-contract-line-item-rows"},{"title":"Delete contract line item row","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/contracts/{id}/billing/items/{itemRef}/rows/{rowIndex}","href":"/api-reference/contracts/delete-contract-line-item-row"},{"title":"Set contract billing terms","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/contracts/{id}/billing/terms","href":"/api-reference/contracts/set-contract-billing-terms"},{"title":"Set contract billing settings","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml patch /api/v1/contracts/{id}/billing/settings","href":"/api-reference/contracts/set-contract-billing-settings"},{"title":"List contract credit notes","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts/{id}/billing/credit-notes","href":"/api-reference/contracts/list-contract-credit-notes"},{"title":"Get contract invoice schedule","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts/{id}/billing/invoice-schedule","href":"/api-reference/contracts/get-contract-invoice-schedule"},{"title":"Get contract billing summary","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/contracts/{id}/billing/summary","href":"/api-reference/contracts/get-contract-billing-summary"},{"title":"Publish contract billing","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/billing/publish","href":"/api-reference/contracts/publish-contract-billing"},{"title":"Edit contract billing in place","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/billing/edit-active","href":"/api-reference/contracts/edit-contract-billing-in-place"},{"title":"Attach subscriptions to contract","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/subscriptions","href":"/api-reference/contracts/attach-subscriptions-to-contract"},{"title":"Detach subscription from contract","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml delete /api/v1/contracts/{id}/subscriptions/{subscriptionId}","href":"/api-reference/contracts/detach-subscription-from-contract"},{"title":"Refresh contract usage","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/contracts/{id}/usage/refresh","href":"/api-reference/contracts/refresh-contract-usage"},{"title":"List customer contracts","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/contracts","href":"/api-reference/contracts/list-customer-contracts"}]},{"group":"Invoices","pages":[{"title":"Get a list of invoices","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/invoices","href":"/api-reference/invoices/get-a-list-of-invoices"},{"title":"Get a single invoice by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/invoices/{invoiceRef}","href":"/api-reference/invoices/get-a-single-invoice-by-id"},{"title":"Generate invoice PDF","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/{id}/invoices/{invoiceRef}/pdf/generate","href":"/api-reference/invoices/generate-invoice-pdf"},{"title":"Get invoice PDF status","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/invoices/{invoiceRef}/pdf/status","href":"/api-reference/invoices/get-invoice-pdf-status"},{"title":"Download invoice PDF","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/invoices/{invoiceRef}/pdf","href":"/api-reference/invoices/download-invoice-pdf"},{"title":"Mark invoice as paid","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/{id}/invoices/{invoiceRef}/paid","href":"/api-reference/invoices/mark-invoice-as-paid"},{"title":"Issue credit note","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/{id}/invoices/{invoiceRef}/credit-note","href":"/api-reference/invoices/issue-credit-note"}]},{"group":"Governance Entity Types","pages":[{"title":"Get a list of entity types","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/entity-types","href":"/api-reference/governance-entity-types/get-a-list-of-entity-types"},{"title":"Upsert entity types","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1/entity-types","href":"/api-reference/governance-entity-types/upsert-entity-types"},{"title":"Archive entity types","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/entity-types/archive","href":"/api-reference/governance-entity-types/archive-entity-types"},{"title":"Check whether an entity type has active entities","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/entity-types/{id}/has-active-entities","href":"/api-reference/governance-entity-types/check-whether-an-entity-type-has-active-entities"}]},{"group":"Governance Entity Types (v1-beta)","pages":[{"title":"Get a list of entity types","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/entity-types","href":"/api-reference/governance-entity-types-v1-beta/get-a-list-of-entity-types"},{"title":"Upsert entity types","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1-beta/entity-types","href":"/api-reference/governance-entity-types-v1-beta/upsert-entity-types"},{"title":"Archive entity types","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1-beta/entity-types/archive","href":"/api-reference/governance-entity-types-v1-beta/archive-entity-types"},{"title":"Check whether an entity type has active entities","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/entity-types/{id}/has-active-entities","href":"/api-reference/governance-entity-types-v1-beta/check-whether-an-entity-type-has-active-entities"}]},{"group":"Governance Entities","pages":[{"title":"Get a list of entities","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/entities","href":"/api-reference/governance-entities/get-a-list-of-entities"},{"title":"Upsert entities","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1/customers/{id}/entities","href":"/api-reference/governance-entities/upsert-entities"},{"title":"Get a single entity by ID","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/entities/{entityId}","href":"/api-reference/governance-entities/get-a-single-entity-by-id"},{"title":"Archive entities","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1/customers/{id}/entities/archive","href":"/api-reference/governance-entities/archive-entities"}]},{"group":"Governance Entities (v1-beta)","pages":[{"title":"Get a list of entitys","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/entities","href":"/api-reference/governance-entities-v1-beta/get-a-list-of-entitys"},{"title":"Upsert entities","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1-beta/customers/{id}/entities","href":"/api-reference/governance-entities-v1-beta/upsert-entities"},{"title":"Get a single entity by ID","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/entities/{entityId}","href":"/api-reference/governance-entities-v1-beta/get-a-single-entity-by-id"},{"title":"Archive entities","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1-beta/customers/{id}/entities/archive","href":"/api-reference/governance-entities-v1-beta/archive-entities"},{"title":"Unarchive entities","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml post /api/v1-beta/customers/{id}/entities/unarchive","href":"/api-reference/governance-entities-v1-beta/unarchive-entities"}]},{"group":"Governance Entity Entitlements","pages":[{"title":"Get a list of entity entitlements","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1/customers/{id}/entities/entitlements","href":"/api-reference/governance-entity-entitlements/get-a-list-of-entity-entitlements"},{"title":"Upsert entity entitlements","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1/customers/{id}/entities/entitlements","href":"/api-reference/governance-entity-entitlements/upsert-entity-entitlements"}]},{"group":"Governance Assignments (v1-beta)","pages":[{"title":"Get a list of assignments","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/assignments","href":"/api-reference/governance-assignments-v1-beta/get-a-list-of-assignments"},{"title":"Upsert assignments","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml put /api/v1-beta/customers/{id}/assignments","href":"/api-reference/governance-assignments-v1-beta/upsert-assignments"}]},{"group":"Governance Hierarchy","pages":[{"title":"Get a list of governance nodes","deprecated":null,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/governance","href":"/api-reference/governance-hierarchy/get-a-list-of-governance-nodes"}]},{"group":"Governance Entitlements Check (v1-beta)","pages":[{"title":"Check entitlement (beta)","deprecated":true,"version":null,"openapi":"/openapi/stigg-api.documented.yml get /api/v1-beta/customers/{id}/entitlements/check","href":"/api-reference/governance-entitlements-check-v1-beta/check-entitlement-beta"}]}]},{"dropdown":"GraphQL","icon":"diagram-project","groups":[{"group":"Get started","pages":[{"title":"Introduction","href":"/api-and-sdks/api-reference/graphql/introduction"}]},{"group":"Essentials","pages":[{"title":"Authentication","href":"/api-and-sdks/api-reference/graphql/authentication"},{"title":"Rate Limits","href":"/api-and-sdks/integration/graphql/rate-limits"},{"title":"Access enforcement at scale","href":"/api-and-sdks/api-reference/graphql/using-at-scale"}]},{"group":"SDK reference","pages":[{"group":"Backend","pages":[{"title":"Node.js SDK","href":"/api-and-sdks/references/sdk/backend/graphql/node"},{"title":"Python SDK","href":"/api-and-sdks/references/sdk/backend/graphql/python"},{"title":"Go SDK","href":"/api-and-sdks/references/sdk/backend/graphql/go"},{"title":"Java SDK","href":"/api-and-sdks/references/sdk/backend/graphql/java"},{"title":"Ruby SDK","href":"/api-and-sdks/references/sdk/backend/graphql/ruby"},{"title":".NET SDK","href":"/api-and-sdks/references/sdk/backend/graphql/dotnet"},{"title":"Sidecar SDK","href":"/api-and-sdks/references/sdk/backend/graphql/sidecar"}]},{"title":"Agent SDK","href":"/api-and-sdks/references/sdk/backend/graphql/agent-sdk"},{"group":"Frontend","pages":[{"title":"JavaScript SDK","href":"/api-and-sdks/references/sdk/frontend/javascript"},{"title":"React SDK","href":"/api-and-sdks/references/sdk/frontend/react"},{"title":"Vue.js SDK","href":"/api-and-sdks/references/sdk/frontend/vue"},{"title":"Embed SDK","href":"/api-and-sdks/references/sdk/frontend/embed"}]}]},{"group":"SDK documentation","pages":[{"group":"Backend","pages":[{"title":"Backend","href":"/api-and-sdks/integration/backend"},{"title":"Customer management","href":"/api-and-sdks/integration/backend/customers"},{"title":"Subscription management","href":"/api-and-sdks/integration/backend/subscriptions"},{"title":"Entitlement checks","href":"/api-and-sdks/integration/backend/entitlements"},{"title":"Usage, billing \u0026 credits","href":"/api-and-sdks/integration/backend/usage-and-billing"},{"title":"Sidecar","href":"/api-and-sdks/integration/backend/sidecar"}]},{"group":"Frontend","pages":[{"title":"JavaScript","href":"/api-and-sdks/integration/frontend/javascript"},{"title":"React","href":"/api-and-sdks/integration/frontend/react"},{"title":"Vue.js","href":"/api-and-sdks/integration/frontend/vuejs"},{"title":"Next.js","href":"/api-and-sdks/integration/frontend/nextjs"},{"title":"Webflow, Wordpress and plain HTML SDK","href":"/api-and-sdks/integration/frontend/html"},{"title":"Hardening client-side access","href":"/api-and-sdks/integration/frontend/hardening-client-side-access"}]}]},{"group":"API reference","pages":[{"title":"Apollo Studio","href":"/api-and-sdks/api-reference/graphql/reference"}]}]},{"dropdown":"Webhooks","icon":"webhook","groups":[{"group":"Get started","pages":[{"title":"Webhook Events","href":"/api-and-sdks/api-reference/webhooks/events"}]},{"group":"Products","pages":[{"title":"Product created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook product.created","href":"/api-reference/products/product-created"},{"title":"Product updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook product.updated","href":"/api-reference/products/product-updated"},{"title":"Product deleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook product.deleted","href":"/api-reference/products/product-deleted"}]},{"group":"Plans","pages":[{"title":"Plan created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook plan.created","href":"/api-reference/plans/plan-created"},{"title":"Plan updated new version published","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook plan.updated","href":"/api-reference/plans/plan-updated-new-version-published"},{"title":"Plan deleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook plan.deleted","href":"/api-reference/plans/plan-deleted"}]},{"group":"Add-ons","pages":[{"title":"Add on created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook addon.created","href":"/api-reference/add-ons/add-on-created"},{"title":"Add on updated new version published","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook addon.updated","href":"/api-reference/add-ons/add-on-updated-new-version-published"},{"title":"Add on deleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook addon.deleted","href":"/api-reference/add-ons/add-on-deleted"}]},{"group":"Features","pages":[{"title":"Feature created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature.created","href":"/api-reference/features/feature-created"},{"title":"Feature updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature.updated","href":"/api-reference/features/feature-updated"},{"title":"Feature deleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature.deleted","href":"/api-reference/features/feature-deleted"}]},{"group":"Feature Groups","pages":[{"title":"Feature group created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature_group.created","href":"/api-reference/feature-groups/feature-group-created"},{"title":"Feature group updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature_group.updated","href":"/api-reference/feature-groups/feature-group-updated"},{"title":"Feature group archived","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature_group.archived","href":"/api-reference/feature-groups/feature-group-archived"},{"title":"Feature group unarchived","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook feature_group.un_archived","href":"/api-reference/feature-groups/feature-group-unarchived"}]},{"group":"Coupons","pages":[{"title":"Coupon created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook coupon.created","href":"/api-reference/coupons/coupon-created"},{"title":"Coupon updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook coupon.updated","href":"/api-reference/coupons/coupon-updated"},{"title":"Coupon archived","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook coupon.archived","href":"/api-reference/coupons/coupon-archived"}]},{"group":"Customers","pages":[{"title":"Customer created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook customer.created","href":"/api-reference/customers/customer-created"},{"title":"Customer updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook customer.updated","href":"/api-reference/customers/customer-updated"},{"title":"Customer payment failed","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook customer.payment_failed","href":"/api-reference/customers/customer-payment-failed"},{"title":"Customer deleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook customer.deleted","href":"/api-reference/customers/customer-deleted"}]},{"group":"Subscriptions","pages":[{"title":"Subscription created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.created","href":"/api-reference/subscriptions/subscription-created"},{"title":"Subscription updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.updated","href":"/api-reference/subscriptions/subscription-updated"},{"title":"Subscription canceled","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.canceled","href":"/api-reference/subscriptions/subscription-canceled"},{"title":"Subscription expired non recurring","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.expired","href":"/api-reference/subscriptions/subscription-expired-non-recurring"},{"title":"Billing month ends soon","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.billing_month.ends_soon","href":"/api-reference/subscriptions/billing-month-ends-soon"},{"title":"Spend limit exceeded","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.spend_limit.exceeded","href":"/api-reference/subscriptions/spend-limit-exceeded"},{"title":"Subscription creation failed","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.create_failed","href":"/api-reference/subscriptions/subscription-creation-failed"}]},{"group":"Trials","pages":[{"title":"Trial started","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.trial_started","href":"/api-reference/trials/trial-started"},{"title":"Trial ends soon","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.trial.ends_soon","href":"/api-reference/trials/trial-ends-soon"},{"title":"Trial converted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.trial_converted","href":"/api-reference/trials/trial-converted"},{"title":"Trial expired","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook subscription.trial_expired","href":"/api-reference/trials/trial-expired"}]},{"group":"Credit grants","pages":[{"title":"Credit grant created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_grant.created","href":"/api-reference/credit-grants/credit-grant-created"},{"title":"Credit grant updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_grant.updated","href":"/api-reference/credit-grants/credit-grant-updated"},{"title":"Credit grant balance low","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_grant.balance.low","href":"/api-reference/credit-grants/credit-grant-balance-low"},{"title":"Credit grant depleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_grant.depleted","href":"/api-reference/credit-grants/credit-grant-depleted"},{"title":"Credit grant expired","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_grant.expired","href":"/api-reference/credit-grants/credit-grant-expired"}]},{"group":"Credit balance","pages":[{"title":"Credit balance low","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_balance.low","href":"/api-reference/credit-balance/credit-balance-low"},{"title":"Credit balance depleted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credit_balance.depleted","href":"/api-reference/credit-balance/credit-balance-depleted"}]},{"group":"Credit auto recharge","pages":[{"title":"Automatic recharge operation attempted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook automatic_recharge.operation.attempted","href":"/api-reference/credit-auto-recharge/automatic-recharge-operation-attempted"},{"title":"Automatic recharge spend limit threshold reached","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook credits.automatic_recharge_limit_exceeded","href":"/api-reference/credit-auto-recharge/automatic-recharge-spend-limit-threshold-reached"},{"title":"Automatic recharge configuration changed","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook automatic_recharge.configuration.changed","href":"/api-reference/credit-auto-recharge/automatic-recharge-configuration-changed"}]},{"group":"Entitlements","pages":[{"title":"Entitlements updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entitlements.updated","href":"/api-reference/entitlements/entitlements-updated"},{"title":"Entitlement usage exceeded","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entitlement.usage_exceeded","href":"/api-reference/entitlements/entitlement-usage-exceeded"}]},{"group":"Promotional entitlements","pages":[{"title":"Promotional entitlement granted","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook promotionalEntitlement.granted","href":"/api-reference/promotional-entitlements/promotional-entitlement-granted"},{"title":"Promotional entitlement updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook promotionalEntitlement.updated","href":"/api-reference/promotional-entitlements/promotional-entitlement-updated"},{"title":"Promotional entitlement revoked","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook promotionalEntitlement.revoked","href":"/api-reference/promotional-entitlements/promotional-entitlement-revoked"},{"title":"Promotional entitlement ends soon","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook promotionalEntitlement.ends_soon","href":"/api-reference/promotional-entitlements/promotional-entitlement-ends-soon"},{"title":"Promotional entitlement expired","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook promotionalEntitlement.expired","href":"/api-reference/promotional-entitlements/promotional-entitlement-expired"}]},{"group":"Third-party sync","pages":[{"title":"Third party sync failed","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook sync.failed","href":"/api-reference/third-party-sync/third-party-sync-failed"},{"title":"Data export sync failed","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook data_export.sync_failed","href":"/api-reference/third-party-sync/data-export-sync-failed"}]},{"group":"Entity types","pages":[{"title":"Entity type created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity_type.created","href":"/api-reference/entity-types/entity-type-created"},{"title":"Entity type updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity_type.updated","href":"/api-reference/entity-types/entity-type-updated"}]},{"group":"Entities","pages":[{"title":"Entity created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity.created","href":"/api-reference/entities/entity-created"},{"title":"Entity updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity.updated","href":"/api-reference/entities/entity-updated"}]},{"group":"Entity entitlements","pages":[{"title":"Entity entitlement created","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity.entitlement.created","href":"/api-reference/entity-entitlements/entity-entitlement-created"},{"title":"Entity entitlement updated","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity.entitlement.updated","href":"/api-reference/entity-entitlements/entity-entitlement-updated"},{"title":"Entity entitlement usage exceeded","version":null,"deprecated":null,"openapi":"/openapi/stigg-webhooks.yaml webhook entity.entitlement.usage_exceeded","href":"/api-reference/entity-entitlements/entity-entitlement-usage-exceeded"}]}]}]},{"tab":"Integrations","icon":"puzzle-piece","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":"Create a credit grant - Stigg","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}