null means there is no limit on number of invoices generated. If specified, then subscription will be revoked automatically after billing limit is reached.
null means there is no limit on number of deliveries completed. If specified, then subscription will be revoked automatically after shipping limit is reached.
Refers to a pricing structure where customers are charged based on their usage, but the cost per unit of usage decreases or changes as they move into higher usage levels.
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Commerce Engine Docs","description":"Official documentation for Commerce Engine - The modern headless commerce platform for building scalable e-commerce solutions.","colors":{"primary":"#00BF6F","light":"#00BF6F","dark":"#029558"},"logo":{"light":"https://mintcdn.com/tarkai/hIY7_H2biaAvOGu7/logo/CE_Developers_black.svg?fit=max\u0026auto=format\u0026n=hIY7_H2biaAvOGu7\u0026q=85\u0026s=d93f21564dfd373c7f2efc88c9d4301e","dark":"https://mintcdn.com/tarkai/hIY7_H2biaAvOGu7/logo/CE_Developers_white.svg?fit=max\u0026auto=format\u0026n=hIY7_H2biaAvOGu7\u0026q=85\u0026s=def973fb06c07f5eae14319cc3303339","href":"/"},"favicon":"https://mintcdn.com/tarkai/QX_fwpRYnT2rH-8q/favicon.png?fit=max\u0026auto=format\u0026n=QX_fwpRYnT2rH-8q\u0026q=85\u0026s=ebc190f98abe52e0e4220c74cea20fa6","api":{"openapi":{"source":"https://openapi.commercengine.io/ce-storefront.json","directory":"api-reference"},"playground":{"display":"interactive","proxy":false}},"appearance":{"default":"system"},"background":{"decoration":"windows","color":{"light":"#ffffff","dark":"#0d1816"}},"navbar":{"primary":{"type":"button","label":"Return to main site","href":"https://www.commercengine.io"}},"footer":{"socials":{"github":"https://github.com/tark-ai","twitter":"https://x.com/CommerceEngine","linkedin":"https://www.linkedin.com/company/commercengine"}},"search":{"prompt":"Search docs..."},"seo":{"metatags":{"canonical":"https://www.commercengine.io/docs","og:site_name":"Commerce Engine Developer Portal","og:locale":"en_US","og:logo":"/logo/CE_logo_whitebg.svg","twitter:site":"@CommerceEngine","og:image:width":"1200","og:image:height":"630","robots":"index, follow"},"indexing":"navigable"},"fonts":{"heading":{"family":"Satoshi","weight":700,"source":"https://images.tarkai.com/Commerce_Engine/Fonts/Satoshi-Variable.woff2","format":"woff2"},"body":{"family":"Satoshi","weight":450,"source":"https://images.tarkai.com/Commerce_Engine/Fonts/Satoshi-Variable.woff2","format":"woff2"}},"styling":{"eyebrows":"section","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"integrations":{"ga4":{"measurementId":"G-6SVW3L2E90"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tarkai","hasAudioNarration":false,"actualSubdomain":"tarkai","customDomains":["www.commercengine.io"],"gitSource":{"type":"github","owner":"tark-ai","repo":"ce-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac704a61b8ac4e93523f794","collectionId":"8aace8e7-4d9c-4eea-a3e1-018179b08a56","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac704a61b8ac4e93523f794"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ac704a61b8ac4e93523f794","clientVersion":"0.0.4076","searchFilterCounts":[{"language":"default","tag":"API Reference","count":694},{"language":"default","tag":"Admin API","count":372},{"language":"default","tag":"Admin","count":372},{"language":"default","tag":"Webhooks","count":132},{"language":"default","tag":"Storefront API","count":128},{"language":"default","tag":"Events","count":117},{"language":"default","tag":"Customers","count":102},{"language":"default","tag":"Catalog","count":101},{"language":"default","tag":"Store","count":77},{"language":"default","tag":"POS API","count":76}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* cyrillic-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2JL7SUc.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa0ZL7SUc.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* greek-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2ZL7SUc.woff2) format('woff2');\n unicode-range: U+1F00-1FFF;\n}\n/* greek */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1pL7SUc.woff2) format('woff2');\n unicode-range: U+0370-0377, U+037A-037F, U+0384-038A, U+038C, U+038E-03A1, U+03A3-03FF;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa2pL7SUc.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa25L7SUc.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Inter';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/inter/v20/UcC73FwrK3iLTeHuS_nVMrMxCp50SjIa1ZL7.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n.font-medium{font-weight:525}#content-area.max-w-3xl{max-width:60rem!important}:root{--ce-white: #fff;--ce-black: #0e0e0f;--ce-green: #00bf6f;--ce-chart-green: #009354;--ce-goldenrod: #f6ffdb;--ce-bg-light-green: #e6faf2;--ce-shades-100: #f6f6f6;--ce-shades-300: #ececec;--ce-shades-800: #262626;--ce-shades-950: #e0dede;--ce-grid-line: #8f8f8f14;--ce-grid-fill: #3e3e3e06;--ce-skill-panel: #16191c;--ce-skill-inset: #101315;--ce-skill-border: #ffffff1a;--ce-skill-fg: #f3f5f6;--ce-skill-dim: #98a0a8;--ce-skill-mark: #2fd18c;--ce-code-block-bg: #1a1a1a;--ce-terminal-bg: #061636;--ce-terminal-body: #0c1f45;--ce-chrome-red: #ff5f56;--ce-chrome-amber: #ffbd2e;--ce-chrome-green: #27c93f;--ce-font-primary: \"Satoshi\", \"Satoshi Static\", system-ui, sans-serif;--ce-font-secondary: \"Inter\", system-ui, sans-serif;--ce-font-mono: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;--ce-text-2xs: 0.75rem;--ce-text-xs: 0.875rem;--ce-text-sm: 1rem;--ce-text-base: 1.125rem;--ce-text-xl: 1.375rem;--ce-text-4xl: 1.75rem;--ce-text-5xl: 2rem;--ce-text-7xl: 3.25rem;--ce-leading-sm: 1.15;--ce-leading-md: 1.3;--ce-leading-lg: 1.5;--ce-tracking-heading: -0.02em;--ce-tracking-eyebrow: 0.18em;--ce-tracking-label: 0.14em;--ce-container-lg: 67.5rem;--ce-container-xl: 75rem;--ce-container-2xl: 79.375rem;--ce-container-3xl: 90rem;--ce-header-shadow: #2416230a;--ce-radius-sm: 0.25rem;--ce-radius-md: 0.5rem;--ce-radius-lg: 0.75rem;--ce-radius-xl: 1rem;--ce-radius-2xl: 1.5rem;--ce-radius-full: 9999px;--ce-shadow-button: 0 2px 4px rgba(0, 0, 0, 0.1);--ce-shadow-tile-hover: 0 10px 24px rgba(0, 0, 0, 0.08);--ce-duration-hover: 300ms}[data-theme=\"dark\"],html.dark,body.dark{--ce-white: #0d1816;--ce-black: #fff;--ce-goldenrod: #002e27;--ce-bg-light-green: #03312e;--ce-shades-100: #142321;--ce-shades-300: #323232;--ce-shades-800: #e3e2e2;--ce-shades-950: #525252;--ce-chart-green: #00ad64;--ce-grid-line: #ffffff12;--ce-grid-fill: #ffffff08;--ce-header-shadow: #42424230}html[data-page-mode=\"custom\"] #navbar>div:nth-child(1),html[data-page-mode=\"custom\"] #navbar>div:nth-child(2){opacity:0;transition:opacity var(--ce-duration-hover) ease-out}html[data-page-mode=\"custom\"] #navbar>*:last-child{border:1px solid transparent;border-radius:var(--ce-radius-sm);background:transparent;box-shadow:0 0 0 0 transparent;margin-inline:auto;transition:all var(--ce-duration-hover) ease-out}html[data-page-mode=\"custom\"][data-scrolled=\"true\"] #navbar>*:last-child{width:calc(100% - 2rem);max-width:var(--ce-container-3xl);transform:translateY(12px);border-color:var(--ce-shades-300);background:var(--ce-white);box-shadow:4px 4px 4px 0 var(--ce-header-shadow)}@media (max-width: 992px){html[data-page-mode=\"custom\"][data-scrolled=\"true\"] #navbar>*:last-child{width:calc(100% - 1rem);transform:translateY(8px)}}@media (prefers-reduced-motion: reduce){html[data-page-mode=\"custom\"] #navbar>*:last-child,html[data-page-mode=\"custom\"] #navbar>div:nth-child(1),html[data-page-mode=\"custom\"] #navbar>div:nth-child(2){transition-duration:0.01ms}}.ce-home{background:var(--ce-white);color:var(--ce-black);font-family:var(--ce-font-primary)}.ce-home a{text-decoration:none}.ce-section{margin:0 auto;max-width:1100px;padding:72px 32px 0}.ce-section--last{padding-bottom:96px}.ce-section--wide{max-width:var(--ce-container-2xl)}.ce-page-title{margin:0;font-size:var(--ce-text-7xl);font-weight:700;line-height:var(--ce-leading-sm);letter-spacing:var(--ce-tracking-heading)}.ce-page-lede{margin:16px 0 0;max-width:46rem;font-size:var(--ce-text-base);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}@media (max-width: 992px){.ce-page-title{font-size:2.5rem}}.ce-h2{margin:0;font-size:var(--ce-text-5xl);font-weight:700;line-height:var(--ce-leading-md);letter-spacing:var(--ce-tracking-heading)}.ce-home table{width:100%;margin:20px 0 0;border-collapse:collapse;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg)}.ce-home thead th{border-bottom:1px solid var(--ce-shades-300);padding:10px 14px;text-align:left;font-weight:700;color:var(--ce-black)}.ce-home tbody td{border-bottom:1px solid var(--ce-shades-300);padding:10px 14px;color:var(--ce-shades-800);vertical-align:top}.ce-home tbody tr:hover{background:var(--ce-shades-100)}.ce-home table a{color:var(--ce-black);font-weight:500;text-decoration:underline;text-decoration-color:var(--ce-shades-300);text-underline-offset:3px}.ce-home table a:hover{color:var(--ce-green);text-decoration-color:var(--ce-green)}.ce-home table code,.ce-home p code,.ce-home li code{border-radius:var(--ce-radius-sm);background:var(--ce-shades-100);padding:2px 6px;font-family:var(--ce-font-mono);font-size:0.9em}.ce-home .ce-cmd code,.ce-home .ce-term-pre code,.ce-home .ce-agent-prompt code,.ce-home .ce-frame-url code{background:none;padding:0;border-radius:0;font-size:inherit}.ce-home .ce-section>*+*{margin-top:20px}.ce-home .ce-section>.ce-h2{margin-top:56px}.ce-home .ce-section>.ce-h2:first-child{margin-top:0}.ce-lede{margin:12px 0 0;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-hero{position:relative;overflow:hidden;border-bottom:1px solid var(--ce-shades-300)}.ce-hero-inner{position:relative;z-index:10;margin:0 auto;max-width:1100px;padding:80px 32px 72px;display:grid;grid-template-columns:1.05fr 0.95fr;gap:56px;align-items:center}.ce-hero-copy{display:grid;gap:24px;justify-items:start}.ce-hero-title{margin:0;font-size:var(--ce-text-7xl);font-weight:700;line-height:var(--ce-leading-sm);letter-spacing:var(--ce-tracking-heading)}.ce-hero-title em{font-style:normal;color:var(--ce-green)}.ce-hero-body{margin:0;max-width:34rem;font-size:var(--ce-text-base);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-hero-actions{display:flex;gap:16px;flex-wrap:wrap}.ce-hero-media{display:grid;gap:16px}.ce-hero-grid{position:absolute;inset:0;z-index:0;background-color:var(--ce-goldenrod);background-image:repeating-linear-gradient(to right, var(--ce-grid-line) 0 1px, transparent 1px 102px),\n repeating-linear-gradient(to bottom, var(--ce-grid-line) 0 1px, transparent 1px 102px)}.ce-hero-grid::before,.ce-hero-grid::after{content:\"\";position:absolute;width:102px;height:102px;background:var(--ce-grid-fill)}.ce-hero-grid::before{left:0;top:0}.ce-hero-grid::after{left:816px;top:102px}.ce-eyebrow{display:inline-flex;align-items:center;gap:8px;margin:0;border-radius:var(--ce-radius-full);border:1px solid var(--ce-shades-300);background:var(--ce-white);padding:6px 12px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-2xs);font-weight:500;text-transform:uppercase;letter-spacing:var(--ce-tracking-eyebrow);color:var(--ce-shades-800)}.ce-eyebrow::before{content:\"\";width:6px;height:6px;flex-shrink:0;border-radius:var(--ce-radius-full);background:var(--ce-green)}.ce-eyebrow--dark{border:0;background:none;padding:0;color:var(--ce-skill-dim);letter-spacing:var(--ce-tracking-eyebrow)}.ce-eyebrow--dark::before{background:var(--ce-skill-mark)}.ce-btn{position:relative;overflow:hidden;display:inline-flex;align-items:center;justify-content:center;gap:10px;border:0;border-radius:var(--ce-radius-full);padding:10px 20px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);font-weight:500;white-space:nowrap;box-shadow:var(--ce-shadow-button);transition:all var(--ce-duration-hover);cursor:pointer}.ce-btn:hover{transform:translateY(-3px) scale(1.02)}.ce-btn:active{transform:translateY(0) scale(1);transition-duration:75ms}.ce-btn:focus-visible{outline:2px solid var(--ce-black);outline-offset:2px}.ce-btn--primary{background:var(--ce-green);color:#fff}.ce-btn--primary:hover{box-shadow:0 6px 15px rgba(0, 0, 0, 0.15),\n 0 10px 30px -8px color-mix(in srgb, var(--ce-green) 60%, transparent)}.ce-btn--secondary{border:1px solid var(--ce-shades-950);background:var(--ce-white);color:var(--ce-black)}.ce-btn--secondary:hover{border-color:var(--ce-shades-800);box-shadow:0 6px 15px rgba(0, 0, 0, 0.12)}.ce-cards{margin-top:32px;display:grid;grid-template-columns:repeat(3, 1fr);gap:20px}.ce-card{display:grid;gap:10px;align-content:start;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-xl);background:var(--ce-white);padding:24px;color:var(--ce-black);transition:transform var(--ce-duration-hover),\n box-shadow var(--ce-duration-hover),\n border-color var(--ce-duration-hover)}.ce-card:hover{transform:translateY(-4px);box-shadow:var(--ce-shadow-tile-hover);border-color:var(--ce-green)}.ce-card-step{font-family:var(--ce-font-mono);font-size:var(--ce-text-2xs);color:var(--ce-chart-green)}.ce-card h3{margin:0;font-size:var(--ce-text-xl);font-weight:700;line-height:var(--ce-leading-md)}.ce-card p{margin:0;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-skills{overflow:hidden;border-radius:var(--ce-radius-2xl);background:var(--ce-skill-panel);color:var(--ce-skill-fg);display:grid;grid-template-columns:1fr 1fr;gap:48px;padding:40px}.ce-skills-copy{display:grid;gap:20px;align-content:start}.ce-skills-copy h2{margin:0;font-size:var(--ce-text-5xl);font-weight:700;line-height:var(--ce-leading-md);letter-spacing:var(--ce-tracking-heading);color:var(--ce-skill-fg)}.ce-skills-copy p.ce-skills-body{margin:0;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-skill-dim)}.ce-agents{display:flex;align-items:center;gap:12px}.ce-agent{display:flex;width:40px;height:40px;align-items:center;justify-content:center;border-radius:var(--ce-radius-lg);background:#fff}.ce-agent img{width:22px;height:22px;object-fit:contain}.ce-skills-links{display:flex;gap:24px;flex-wrap:wrap;padding-top:4px}.ce-skills-links a{font-size:var(--ce-text-sm);color:var(--ce-skill-mark)}.ce-skills-links a:hover{text-decoration:underline}.ce-skills-demo{display:grid;align-content:center}.ce-skills-demo pre{margin:0;border-radius:var(--ce-radius-lg);background:var(--ce-skill-inset);border:1px solid var(--ce-skill-border);padding:16px 18px;font-family:var(--ce-font-mono);font-size:12px;line-height:1.9;color:var(--ce-skill-fg);white-space:pre-wrap;overflow-x:auto}.ce-skills-demo .ce-dim{color:var(--ce-skill-dim)}.ce-skills-demo .ce-mark{color:var(--ce-skill-mark)}.ce-guides{margin-top:28px;display:grid;grid-template-columns:1fr 1fr;gap:0 40px}.ce-guide{display:grid;grid-template-columns:1fr auto;align-items:center;gap:16px;border-top:1px solid var(--ce-shades-300);padding:20px 16px;color:var(--ce-black);transition:background var(--ce-duration-hover)}.ce-guide:hover{background:var(--ce-shades-100)}.ce-guide-title{display:block;font-size:var(--ce-text-base);font-weight:700}.ce-guide-sub{display:block;margin-top:4px;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-guide-arrow{color:var(--ce-green)}.ce-starters{border-radius:var(--ce-radius-2xl);border:1px solid var(--ce-shades-300);background:var(--ce-shades-100);padding:32px}.ce-starters-head{display:grid;grid-template-columns:1fr auto;gap:32px;align-items:center}.ce-starters-head h2{margin:0;font-size:var(--ce-text-4xl);font-weight:700;line-height:var(--ce-leading-md);letter-spacing:var(--ce-tracking-heading)}.ce-starters-head p{margin:10px 0 0;max-width:38rem;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-chips{margin-top:24px;display:grid;grid-template-columns:repeat(6, 1fr);gap:12px}.ce-chip{display:flex;align-items:center;gap:10px;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-lg);background:var(--ce-white);padding:12px;color:var(--ce-black);font-size:var(--ce-text-xs);font-weight:500;transition:transform var(--ce-duration-hover),\n border-color var(--ce-duration-hover)}.ce-chip:hover{transform:translateY(-2px);border-color:var(--ce-green)}.ce-chip-mark{display:flex;width:32px;height:32px;flex-shrink:0;align-items:center;justify-content:center;border-radius:var(--ce-radius-md);background:#fff;box-shadow:0 0 0 1px rgba(0, 0, 0, 0.05)}.ce-chip-mark img{width:18px;height:18px;object-fit:contain}.ce-trio{display:grid;grid-template-columns:repeat(3, 1fr);gap:20px}.ce-trio-item{border-top:2px solid var(--ce-shades-300);padding-top:16px;color:var(--ce-black)}.ce-trio-item--active{border-top-color:var(--ce-green)}a.ce-trio-item{transition:border-color var(--ce-duration-hover),\n transform var(--ce-duration-hover)}a.ce-trio-item:hover{border-top-color:var(--ce-green);transform:translateY(-2px)}a.ce-trio-item:hover h3{color:var(--ce-green)}a.ce-trio-item:focus-visible{outline:2px solid var(--ce-black);outline-offset:4px}.ce-trio-item h3{margin:0;font-size:var(--ce-text-base);font-weight:700}.ce-trio-item p{margin:6px 0 0;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-cmd{overflow:hidden;border-radius:var(--ce-radius-lg);background:var(--ce-code-block-bg)}.ce-cmd-label{margin:0;border-bottom:1px solid rgba(255, 255, 255, 0.1);padding:10px 16px;font-family:var(--ce-font-secondary);font-size:11px;font-weight:700;text-transform:uppercase;letter-spacing:var(--ce-tracking-label);color:rgba(255, 255, 255, 0.75)}.ce-cmd ul{list-style:none;margin:0;padding:0}.ce-cmd li{display:flex;align-items:center;gap:12px;padding:10px 16px;border-top:1px solid rgba(255, 255, 255, 0.05)}.ce-cmd li:first-child{border-top:0}.ce-cmd code{min-width:0;flex:1;overflow-x:auto;white-space:pre;font-family:var(--ce-font-mono);font-size:11px;line-height:var(--ce-leading-lg);color:#fff;background:none;border:0;padding:0;scrollbar-width:none}.ce-cmd code::-webkit-scrollbar{display:none}.ce-cmd code[data-wrap=\"true\"]{white-space:pre-wrap;overflow-x:visible}.ce-cmd-prefix{user-select:none;color:var(--ce-green)}.ce-cmd-copy{display:flex;width:28px;height:28px;flex-shrink:0;cursor:pointer;align-items:center;justify-content:center;border:0;border-radius:var(--ce-radius-md);background:none;color:rgba(255, 255, 255, 0.5);font-size:12px;transition:color 0.2s,\n background 0.2s}.ce-cmd-copy:hover{background:rgba(255, 255, 255, 0.1);color:#fff}.ce-cmd-copy[data-copied=\"true\"]{color:var(--ce-green)}div:has(>[role=\"menu\"] a[href$=\"/sdk/installation\"]),div:has(>[role=\"menu\"] a[href$=\"/storefront/quickstart\"]){position:fixed!important;top:calc(var(--banner-height, 0px) + 52px)!important;left:50%!important;transform:translateX(-50%)!important}[role=\"menu\"]:has(.nav-dropdown-item){width:fit-content!important;max-width:calc(100vw - 64px)!important;max-height:none!important;display:grid!important;grid-auto-flow:column;grid-auto-columns:minmax(220px, 300px);align-content:start;gap:6px 24px;padding:24px!important;border-radius:var(--ce-radius-2xl)!important;box-shadow:0 12px 36px rgba(0, 0, 0, 0.09)!important}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]),[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]){width:1000px!important;grid-auto-flow:row;grid-template-columns:repeat(3, minmax(0, 1fr));gap:6px 32px;padding:32px!important}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(1){grid-area:1 / 1}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(2){grid-area:2 / 1}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(3){grid-area:1 / 2}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(4){grid-area:2 / 2}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(5){grid-area:1 / 3}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(6){grid-area:2 / 3}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(7){grid-area:3 / 3}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(1){grid-area:1 / 1}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(2){grid-area:2 / 1}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(3){grid-area:3 / 1}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(4){grid-area:1 / 2}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(5){grid-area:2 / 2}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(6){grid-area:1 / 3}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(7){grid-area:2 / 3}.nav-dropdown-item{display:grid!important;grid-template-columns:auto minmax(0, 1fr);gap:12px;align-items:start!important;border-radius:var(--ce-radius-md)!important;padding:10px 12px!important;color:var(--ce-black)!important;transition:background var(--ce-duration-hover)}.nav-dropdown-item:hover{background:var(--ce-shades-100)!important}.nav-dropdown-item>svg{width:18px;height:18px;margin-top:2px;color:var(--ce-chart-green)}.nav-dropdown-item>div>span:first-child{font-family:var(--ce-font-mono);font-size:var(--ce-text-sm);font-weight:500;color:var(--ce-black)}.nav-dropdown-item>div>span:last-child{margin-top:3px;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)!important}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(1),[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(3),[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(5),[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(1),[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(4),[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(6){position:relative;margin-top:26px}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(1)::before{content:\"Storefront\"}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(3)::before{content:\"Checkout \u0026 POS\"}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(5)::before{content:\"Growth \u0026 AI\"}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(1)::before{content:\"Get started\"}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(4)::before{content:\"Build\"}[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(6)::before{content:\"SEO \u0026 AI\"}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(1)::before,[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(3)::before,[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(5)::before,[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(1)::before,[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(4)::before,[role=\"menu\"]:has(a[href$=\"/storefront/quickstart\"]) .nav-dropdown-item:nth-child(6)::before{position:absolute;top:-22px;left:12px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-2xs);font-weight:500;text-transform:uppercase;letter-spacing:var(--ce-tracking-eyebrow);color:var(--ce-shades-600)}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8){grid-area:4 / 1 / auto / -1;margin-top:20px;border-top:1px solid var(--ce-shades-300);padding-top:20px!important;grid-template-columns:repeat(3, auto);justify-content:center;align-items:center!important;gap:10px}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8)>svg{margin-top:0}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8)>div{display:block}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8)>div>span:first-child{font-family:var(--ce-font-secondary);font-size:var(--ce-text-xs);text-transform:uppercase;letter-spacing:var(--ce-tracking-eyebrow)}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8)>div>span:last-child{display:none}[role=\"menu\"]:has(a[href$=\"/sdk/installation\"]) .nav-dropdown-item:nth-child(8):hover>div>span:first-child{color:var(--ce-green)}@media (max-width: 1100px){[role=\"menu\"]:has(.nav-dropdown-item){width:auto!important;grid-template-columns:1fr}.nav-dropdown-item:nth-child(n){grid-area:auto!important}}.ce-portal{margin:20px 0;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-xl);background:var(--ce-shades-100);padding:20px}.ce-portal-label{display:block;margin-bottom:10px;font-family:var(--ce-font-secondary);font-size:11px;font-weight:700;text-transform:uppercase;letter-spacing:var(--ce-tracking-label);color:var(--ce-shades-800)}.ce-portal-row{display:flex;flex-wrap:wrap;align-items:center;gap:12px}.ce-portal-field{display:flex;min-width:0;flex:1 1 320px;align-items:center;overflow:hidden;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-full);background:var(--ce-white);transition:border-color var(--ce-duration-hover)}.ce-portal-field:focus-within{border-color:var(--ce-green)}.ce-portal-field input{min-width:0;flex:1;border:0;background:none;padding:11px 16px;font-family:var(--ce-font-mono);font-size:var(--ce-text-xs);color:var(--ce-black);outline:none}.ce-portal-field select{flex-shrink:0;border:0;border-left:1px solid var(--ce-shades-300);background:none;padding:11px 14px;font-family:var(--ce-font-mono);font-size:var(--ce-text-xs);color:var(--ce-shades-800);cursor:pointer;outline:none}.ce-portal .ce-btn[data-disabled=\"true\"]{pointer-events:none;opacity:0.45}.ce-portal-url{margin:12px 0 0;font-size:var(--ce-text-2xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-portal-url code{font-family:var(--ce-font-mono);word-break:break-all}@media (max-width: 550px){.ce-portal-row{flex-direction:column;align-items:stretch}}.ce-footer{margin-top:96px;border-top:1px solid var(--ce-shades-300);background:var(--ce-shades-100)}.ce-footer-inner{margin:0 auto;max-width:var(--ce-container-2xl);padding:56px 32px 40px;display:grid;grid-template-columns:minmax(0, 1fr) minmax(0, 2.2fr);gap:48px}.ce-footer-brand img{height:28px;width:auto}.ce-footer-logo-dark{display:none}[data-theme=\"dark\"] .ce-footer-logo-light,html.dark .ce-footer-logo-light{display:none}[data-theme=\"dark\"] .ce-footer-logo-dark,html.dark .ce-footer-logo-dark{display:block}.ce-footer-brand p{margin:14px 0 0;max-width:22rem;font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-footer-socials{margin-top:20px;display:flex;gap:10px}.ce-footer-socials a{display:flex;width:34px;height:34px;align-items:center;justify-content:center;border-radius:var(--ce-radius-full);border:1px solid var(--ce-shades-300);background:var(--ce-white);color:var(--ce-shades-800);transition:color var(--ce-duration-hover),\n border-color var(--ce-duration-hover),\n transform var(--ce-duration-hover)}.ce-footer-socials a:hover{color:var(--ce-green);border-color:var(--ce-green);transform:translateY(-2px)}.ce-footer-cols{display:grid;grid-template-columns:repeat(4, minmax(0, 1fr));gap:32px}.ce-footer-heading{margin:0 0 12px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-2xs);font-weight:500;text-transform:uppercase;letter-spacing:var(--ce-tracking-eyebrow);color:var(--ce-shades-600, #6e6e6f)}.ce-footer-col ul{margin:0;padding:0;list-style:none;display:grid;gap:9px}.ce-footer-col li{margin:0}.ce-footer-col a{font-size:var(--ce-text-xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800);transition:color var(--ce-duration-hover)}.ce-footer-col a:hover{color:var(--ce-green)}.ce-footer-bar{border-top:1px solid var(--ce-shades-300)}.ce-footer-bar{margin:0 auto;max-width:var(--ce-container-2xl);padding:20px 32px 32px;display:flex;flex-wrap:wrap;justify-content:space-between;gap:12px;font-size:var(--ce-text-2xs);color:var(--ce-shades-600, #6e6e6f)}@media (max-width: 992px){.ce-footer-inner{grid-template-columns:1fr;gap:36px;padding:40px 24px 32px}.ce-footer-cols{grid-template-columns:repeat(2, minmax(0, 1fr))}.ce-footer-bar{padding:20px 24px 28px}}.ce-starters{display:grid;gap:24px;margin:28px 0}.ce-starter-card{display:grid;grid-template-columns:1.4fr 1fr;overflow:hidden;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-2xl);background:var(--ce-white);transition:all var(--ce-duration-hover)}.ce-starter-card:hover{transform:translateY(-4px);border-color:var(--ce-green);box-shadow:0 18px 44px rgba(0, 0, 0, 0.12)}.ce-starter-preview{display:flex;min-width:0;align-items:center;background:var(--ce-shades-100);padding:24px}.ce-frame{width:100%;overflow:hidden;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-xl);background:var(--ce-white);box-shadow:0 10px 30px rgba(0, 0, 0, 0.1);transition:transform 500ms var(--ce-ease-out, ease-out)}.ce-starter-card:hover .ce-frame{transform:scale(1.02)}.ce-frame-bar{display:flex;align-items:center;gap:8px;border-bottom:1px solid var(--ce-shades-300);background:var(--ce-shades-100);padding:10px 12px}.ce-frame-bar span:not(.ce-frame-url){width:10px;height:10px;flex-shrink:0;border-radius:var(--ce-radius-full)}.ce-frame-url{margin-left:8px;min-width:0;flex:1;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;border-radius:var(--ce-radius-full);background:var(--ce-white);padding:4px 12px;font-size:var(--ce-text-2xs);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-frame-viewport{position:relative;overflow:hidden;aspect-ratio:16 / 10}.ce-frame-viewport img{width:100%;height:100%;object-fit:cover;object-position:top center;display:block}.ce-starter-body{display:flex;min-width:0;flex-direction:column;padding:28px}.ce-starter-category{align-self:start;border-radius:var(--ce-radius-full);border:1px solid var(--ce-shades-300);background:var(--ce-shades-100);padding:4px 10px;font-family:var(--ce-font-secondary);font-size:var(--ce-text-2xs);font-weight:500;color:var(--ce-shades-800)}.ce-starter-name{margin:12px 0 0;font-size:var(--ce-text-5xl);font-weight:700;line-height:var(--ce-leading-md);letter-spacing:var(--ce-tracking-heading);color:var(--ce-black)}.ce-starter-desc{margin:10px 0 0;font-size:var(--ce-text-sm);line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-starter-features{margin:20px 0 0;padding:0;list-style:none;display:flex;flex-wrap:wrap;gap:6px}.ce-starter-features li{margin:0;border-radius:var(--ce-radius-md);border:1px solid var(--ce-shades-300);background:var(--ce-shades-100);padding:4px 8px;font-family:var(--ce-font-secondary);font-size:11px;line-height:var(--ce-leading-lg);color:var(--ce-shades-800)}.ce-starter-foot{margin-top:auto;padding-top:24px}.ce-fw{min-width:0;margin:0;padding:0;border:0}.ce-fw legend{margin-bottom:10px;padding:0;font-family:var(--ce-font-secondary);font-size:11px;font-weight:500;text-transform:uppercase;letter-spacing:0.12em;color:var(--ce-shades-800)}.ce-fw-grid{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));gap:6px}.ce-fw-option{display:flex;min-height:40px;cursor:pointer;align-items:center;gap:6px;border-radius:var(--ce-radius-lg);border:1px solid var(--ce-shades-300);background:var(--ce-white);padding:0 8px;color:var(--ce-shades-800);transition:border-color 200ms, background 200ms}.ce-fw-option:hover{border-color:var(--ce-green)}.ce-fw-option[data-active=\"true\"]{border-color:var(--ce-green);background:var(--ce-bg-light-green);color:var(--ce-black)}.ce-fw-option:has(input:focus-visible){outline:2px solid var(--ce-green);outline-offset:2px}.ce-fw-option input{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0, 0, 0, 0);white-space:nowrap;border:0}.ce-fw-mark{display:flex;width:18px;height:18px;flex-shrink:0;align-items:center;justify-content:center;border-radius:var(--ce-radius-full);background:#fff;box-shadow:0 0 0 1px rgba(0, 0, 0, 0.05)}.ce-fw-mark img{width:12px;height:12px;object-fit:contain}.ce-fw-name{min-width:0;flex:1;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-family:var(--ce-font-secondary);font-size:11px;font-weight:500}.ce-fw-option svg{flex-shrink:0;color:var(--ce-green)}.ce-fw-spacer{width:12px;flex-shrink:0}.ce-starter-hero-cmd{margin:28px 0 0;display:flex;flex-wrap:wrap;align-items:baseline;gap:8px 14px;border:1px solid var(--ce-shades-300);border-radius:var(--ce-radius-xl);background:var(--ce-shades-100);padding:18px 20px}.ce-starter-hero-label{font-family:var(--ce-font-secondary);font-size:11px;font-weight:700;text-transform:uppercase;letter-spacing:var(--ce-tracking-label);color:var(--ce-shades-800)}.ce-starter-hero-cmd code{border-radius:var(--ce-radius-md);background:var(--ce-code-block-bg);padding:8px 14px;font-family:var(--ce-font-mono);font-size:var(--ce-text-xs);color:#fff}.ce-starter-hero-note{font-size:var(--ce-text-2xs);color:var(--ce-shades-800)}.ce-starter-cmd{margin-top:18px;display:flex;align-items:center;gap:8px;overflow:hidden;border-radius:var(--ce-radius-md);background:var(--ce-code-block-bg);padding:8px 8px 8px 12px}.ce-starter-cmd code{min-width:0;flex:1;overflow-x:auto;white-space:pre;border:0;background:none;padding:0;font-family:var(--ce-font-mono);font-size:11px;line-height:var(--ce-leading-lg);color:#fff;scrollbar-width:none}.ce-starter-cmd code::-webkit-scrollbar{display:none}.ce-starter-actions{margin-top:16px;display:flex;flex-wrap:wrap;align-items:center;gap:12px}@media (max-width: 992px){.ce-starter-card{grid-template-columns:1fr}.ce-starter-preview{padding:16px}.ce-starter-body{padding:20px}.ce-starter-name{font-size:var(--ce-text-4xl)}}@media (max-width: 550px){.ce-fw-grid{grid-template-columns:repeat(2, minmax(0, 1fr))}.ce-starter-actions{flex-direction:column;align-items:stretch}}.ce-agent-setup{display:grid;gap:0}.ce-agent-step{margin:0;font-family:var(--ce-font-secondary);font-size:11px;font-weight:700;text-transform:uppercase;letter-spacing:var(--ce-tracking-label);color:var(--ce-shades-800)}.ce-agent-choices{margin-top:12px;display:flex;flex-wrap:wrap;gap:7px}.ce-agent-choice{display:flex;min-height:44px;cursor:pointer;align-items:center;gap:8px;border-radius:var(--ce-radius-full);border:1px solid var(--ce-shades-300);background:var(--ce-white);padding:8px 12px;color:var(--ce-black);font-family:var(--ce-font-secondary);font-size:var(--ce-text-xs);font-weight:500;line-height:var(--ce-leading-lg);transition:all 200ms}.ce-agent-choice:hover{border-color:var(--ce-green)}.ce-agent-choice[data-active=\"true\"]{border-color:var(--ce-green);background:var(--ce-bg-light-green)}.ce-agent-choice:focus-visible{outline:2px solid var(--ce-green);outline-offset:2px}.ce-agent-choice-mark{display:flex;width:18px;height:18px;flex-shrink:0;align-items:center;justify-content:center;border-radius:var(--ce-radius-full);background:#fff;box-shadow:0 0 0 1px rgba(0, 0, 0, 0.05)}.ce-agent-choice-mark img{width:12px;height:12px;object-fit:contain}.ce-agent-block{margin-top:20px}.ce-agent-prompt{display:flex;align-items:flex-start;gap:12px;padding:12px 16px}.ce-agent-prompt p{min-width:0;flex:1;margin:0;font-family:var(--ce-font-mono);font-size:11px;line-height:1.7;color:rgba(255, 255, 255, 0.9)}.ce-term{display:flex;min-height:280px;width:100%;flex-direction:column;overflow:hidden;border-radius:var(--ce-radius-lg);border:1px solid rgba(255, 255, 255, 0.1);background:var(--ce-terminal-bg)}.ce-term-bar{display:flex;gap:8px;border-bottom:1px solid rgba(255, 255, 255, 0.1);padding:16px}.ce-term-bar span{width:12px;height:12px;border-radius:var(--ce-radius-full)}.ce-term-dot-red{background:var(--ce-chrome-red)}.ce-term-dot-amber{background:var(--ce-chrome-amber)}.ce-term-dot-green{background:var(--ce-chrome-green)}.ce-term-pre{flex:1;overflow-x:auto;margin:0;background:var(--ce-terminal-body);padding:16px;font-family:var(--ce-font-mono);font-size:var(--ce-text-sm);line-height:1.5;color:#fff;scrollbar-width:none}.ce-term-pre::-webkit-scrollbar{display:none}.ce-term-pre code{white-space:pre;background:none;border:0;padding:0;color:inherit}.ce-term-cursor{animation:ce-blink 1s step-end infinite;color:var(--ce-chrome-green)}@keyframes ce-blink{0%,50%{opacity:1}51%,100%{opacity:0}}@media (max-width: 1200px){.ce-hero-title{font-size:2.5rem}}@media (max-width: 992px){.ce-hero-inner,.ce-skills{grid-template-columns:1fr}.ce-hero-inner{gap:40px;padding:56px 24px 56px}.ce-skills{gap:32px;padding:32px 24px}.ce-section{padding:56px 24px 0}.ce-cards,.ce-trio{grid-template-columns:1fr}.ce-guides{grid-template-columns:1fr;gap:0}.ce-chips{grid-template-columns:repeat(3, 1fr)}.ce-starters-head{grid-template-columns:1fr;gap:20px}}@media (max-width: 550px){.ce-hero-title{font-size:2rem}.ce-h2,.ce-skills-copy h2{font-size:1.625rem}.ce-chips{grid-template-columns:repeat(2, 1fr)}}@media (prefers-reduced-motion: reduce){.ce-home *,.ce-home *::before,.ce-home *::after{animation-duration:0.01ms!important;animation-iteration-count:1!important;transition-duration:0.01ms!important}}"}],"page":{"pagePath":"api-reference/subscriptions/update-a-specific-subscription","slug":"/api-reference/subscriptions/update-a-specific-subscription","pageMetadata":{"openapi":"put /subscriptions/{id}","title":"Update a specific subscription","description":"Update a specific subscription","href":"/api-reference/subscriptions/update-a-specific-subscription"},"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: \"Update a specific subscription\"\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":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"openapi":"put /subscriptions/{id}","title":"Update a specific subscription","description":"Update a specific subscription","href":"/api-reference/subscriptions/update-a-specific-subscription"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/tarkai/83faf160ccb5c4ff/header-float.js"],"openApiReferenceData":{"operation":{"tags":["Subscriptions"],"operationId":"update-subscription","summary":"Update a specific subscription","description":"Update a specific subscription","externalDocs":{"url":"https://llm-docs.commercengine.io/storefront/operations/update-subscription","description":"API reference for the update-subscription operation"},"requestBody":"1a2fa12c-c532-46d7-b1ac-7bb86190db88","responses":{"200":"7fa21189-5a6f-4f01-9642-ab8d10c0b099","400":"e6d28e63-0956-4465-9600-b46604895f90","401":"b32a48a9-8f17-418c-9ffb-92cc2b36ff3b","404":"16cdda2e-1cd7-4083-b413-8c49e72ec9df"},"x-speakeasy-group":"subscriptions","x-speakeasy-ignore":true,"x-speakeasy-name-override":"updateSubscription","method":"put","type":"path","servers":["e5367614-55b7-4002-bc7f-1a071c7782a0","eda6531b-14b9-4366-9c9b-a4c621a2c670"],"security":[],"path":"/subscriptions/{id}","baseUrlOptions":["https://staging.api.commercengine.io/api/v1/{store_id}/storefront","https://prod.api.commercengine.io/api/v1/{store_id}/storefront"],"title":"Update a specific subscription","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"74f26023-34d5-452f-84b0-267cf11a9690":{"name":"id","in":"path","description":"subscription id","required":true,"schema":{"type":"string","isRequired":true,"description":"subscription id","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"UpdatePhysicalProductSubscription","required":["command"],"x-tags":["Subscriptions"],"properties":{"command":{"type":"string","const":"update","isRequired":true,"uniqueKey":"oneOf.0.command","typeLabel":"string"},"billing_frequency":{"enum":["monthly"],"type":"string","uniqueKey":"oneOf.0.billing_frequency","typeLabel":"enum\u003cstring>"},"billing_interval":{"type":"integer","default":1,"uniqueKey":"oneOf.0.billing_interval","typeLabel":"integer"},"billing_limit":{"oneOf":[{"description":"null means there is no limit on number of invoices generated. If specified, then subscription will be revoked automatically after billing limit is reached.","type":"integer","uniqueKey":"oneOf.0.billing_limit.oneOf.0","typeLabel":"integer"},{"description":"null means there is no limit on number of invoices generated. If specified, then subscription will be revoked automatically after billing limit is reached.","type":"null","uniqueKey":"oneOf.0.billing_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.billing_limit","typeLabel":"integer | null"},"shipping_frequency":{"enum":["monthly"],"type":"string","uniqueKey":"oneOf.0.shipping_frequency","typeLabel":"enum\u003cstring>"},"shipping_interval":{"type":"integer","default":1,"uniqueKey":"oneOf.0.shipping_interval","typeLabel":"integer"},"shipping_limit":{"oneOf":[{"description":"null means there is no limit on number of deliveries completed. If specified, then subscription will be revoked automatically after shipping limit is reached.","type":"integer","uniqueKey":"oneOf.0.shipping_limit.oneOf.0","typeLabel":"integer"},{"description":"null means there is no limit on number of deliveries completed. If specified, then subscription will be revoked automatically after shipping limit is reached.","type":"null","uniqueKey":"oneOf.0.shipping_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.shipping_limit","typeLabel":"integer | null"},"is_prepaid":{"description":"Refers to a pricing model where customers are charged based on their actual usage of a service. Usage based billing works for digital products.","type":"boolean","default":false,"uniqueKey":"oneOf.0.is_prepaid","typeLabel":"boolean"},"usage_based_billing":{"description":"Refers to a pricing model where customers are charged based on their actual usage of a service. Usage based billing works for digital products.","type":"boolean","default":false,"uniqueKey":"oneOf.0.usage_based_billing","typeLabel":"boolean"},"usage_based_tiers":{"description":"Refers to a pricing structure where customers are charged based on their usage, but the cost per unit of usage decreases or changes as they move into higher usage levels.","type":"array","items":{"type":"object","properties":{"up_to":{"type":"integer","uniqueKey":"oneOf.0.usage_based_tiers.items.[INDEX].up_to","typeLabel":"integer"},"price_per_unit":{"type":"number","format":"double","uniqueKey":"oneOf.0.usage_based_tiers.items.[INDEX].price_per_unit","typeLabel":"number\u003cdouble>"}},"uniqueKey":"oneOf.0.usage_based_tiers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.usage_based_tiers","typeLabel":"object[]"},"grace_period_days":{"description":"The number of days after a failed payment to retry before canceling.","type":"integer","default":0,"uniqueKey":"oneOf.0.grace_period_days","typeLabel":"integer"},"is_cancellation_allowed":{"description":"Indcates whether the next billing cancellation is allowed or not.","type":"boolean","default":true,"uniqueKey":"oneOf.0.is_cancellation_allowed","typeLabel":"boolean"},"days_until_cancellation_allowed":{"description":"Specifies the number of days the customer has to cancel before the next billing.","type":"integer","default":3,"uniqueKey":"oneOf.0.days_until_cancellation_allowed","typeLabel":"integer"},"invoice_items":{"type":"array","items":{"title":"SubscriptionInvoiceItem","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/storefront/schemas/SubscriptionInvoiceItem","description":"API reference for the SubscriptionInvoiceItem schema"},"required":["product_id","variant_id","product_name","variant_name","product_image_url","sku","quantity","listing_price","selling_price","tax_type","tax_rate","price_including_tax","selling_price_excluding_tax"],"properties":{"product_id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.invoice_items.items.[INDEX].product_id","typeLabel":"string"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.invoice_items.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.invoice_items.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.invoice_items.items.[INDEX].variant_id","typeLabel":"string | null"},"quantity":{"type":"integer","isRequired":true,"uniqueKey":"oneOf.0.invoice_items.items.[INDEX].quantity","typeLabel":"integer"}},"x-tags":["Subscriptions"],"uniqueKey":"oneOf.0.invoice_items.items.[INDEX]","typeLabel":"SubscriptionInvoiceItem · object"},"uniqueKey":"oneOf.0.invoice_items","typeLabel":"SubscriptionInvoiceItem · object[]"}},"uniqueKey":"oneOf.0","typeLabel":"UpdatePhysicalProductSubscription · object"},{"type":"object","title":"UpdateDigitalProductSubscription","required":["command"],"x-tags":["Subscriptions"],"properties":{"command":{"type":"string","const":"update","isRequired":true,"uniqueKey":"oneOf.1.command","typeLabel":"string"},"billing_frequency":{"enum":["monthly"],"type":"string","uniqueKey":"oneOf.1.billing_frequency","typeLabel":"enum\u003cstring>"},"billing_interval":{"type":"integer","default":1,"uniqueKey":"oneOf.1.billing_interval","typeLabel":"integer"},"billing_limit":{"oneOf":[{"description":"null means there is no limit on number of invoices generated. If specified, then subscription will be revoked automatically after billing limit is reached.","type":"integer","uniqueKey":"oneOf.1.billing_limit.oneOf.0","typeLabel":"integer"},{"description":"null means there is no limit on number of invoices generated. If specified, then subscription will be revoked automatically after billing limit is reached.","type":"null","uniqueKey":"oneOf.1.billing_limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.billing_limit","typeLabel":"integer | null"},"is_prepaid":{"description":"Refers to a pricing model where customers are charged based on their actual usage of a service. Usage based billing works for digital products.","type":"boolean","default":false,"uniqueKey":"oneOf.1.is_prepaid","typeLabel":"boolean"},"usage_based_billing":{"description":"Refers to a pricing model where customers are charged based on their actual usage of a service. Usage based billing works for digital products.","type":"boolean","default":false,"uniqueKey":"oneOf.1.usage_based_billing","typeLabel":"boolean"},"usage_based_tiers":{"description":"Refers to a pricing structure where customers are charged based on their usage, but the cost per unit of usage decreases or changes as they move into higher usage levels.","type":"array","items":{"type":"object","properties":{"up_to":{"type":"integer","uniqueKey":"oneOf.1.usage_based_tiers.items.[INDEX].up_to","typeLabel":"integer"},"price_per_unit":{"type":"number","format":"double","uniqueKey":"oneOf.1.usage_based_tiers.items.[INDEX].price_per_unit","typeLabel":"number\u003cdouble>"}},"uniqueKey":"oneOf.1.usage_based_tiers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.usage_based_tiers","typeLabel":"object[]"},"grace_period_days":{"description":"The number of days after a failed payment to retry before canceling.","type":"integer","default":0,"uniqueKey":"oneOf.1.grace_period_days","typeLabel":"integer"},"is_cancellation_allowed":{"description":"Indcates whether the next billing cancellation is allowed or not.","type":"boolean","default":true,"uniqueKey":"oneOf.1.is_cancellation_allowed","typeLabel":"boolean"},"days_until_cancellation_allowed":{"description":"Specifies the number of days the customer has to cancel before the next billing.","type":"integer","default":3,"uniqueKey":"oneOf.1.days_until_cancellation_allowed","typeLabel":"integer"},"invoice_items":{"type":"array","items":{"title":"SubscriptionInvoiceItem","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/storefront/schemas/SubscriptionInvoiceItem","description":"API reference for the SubscriptionInvoiceItem schema"},"required":["product_id","variant_id","product_name","variant_name","product_image_url","sku","quantity","listing_price","selling_price","tax_type","tax_rate","price_including_tax","selling_price_excluding_tax"],"properties":{"product_id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.invoice_items.items.[INDEX].product_id","typeLabel":"string"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.invoice_items.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.invoice_items.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.invoice_items.items.[INDEX].variant_id","typeLabel":"string | null"},"quantity":{"type":"integer","isRequired":true,"uniqueKey":"oneOf.1.invoice_items.items.[INDEX].quantity","typeLabel":"integer"}},"x-tags":["Subscriptions"],"uniqueKey":"oneOf.1.invoice_items.items.[INDEX]","typeLabel":"SubscriptionInvoiceItem · object"},"uniqueKey":"oneOf.1.invoice_items","typeLabel":"SubscriptionInvoiceItem · object[]"}},"uniqueKey":"oneOf.1","typeLabel":"UpdateDigitalProductSubscription · object"},{"type":"object","title":"PauseSubscription","required":["command"],"x-tags":["Subscriptions"],"properties":{"command":{"description":"To pause an active subscription.","type":"string","const":"pause","isRequired":true,"uniqueKey":"oneOf.2.command","typeLabel":"string"},"pause_start_date":{"description":"optional. if specified, subscription will be paused from this date \u0026 time. If not specified, subscription will be paused immediately. datetime value should be greater than current time.","type":"string","format":"date-time","uniqueKey":"oneOf.2.pause_start_date","typeLabel":"string\u003cdate-time>"},"pause_end_date":{"description":"optional. if specified, subscription will be activated automatically from this date \u0026 time. If not specified, subscription will remain paused. datetime value should be greater than current time.","type":"string","format":"date-time","uniqueKey":"oneOf.2.pause_end_date","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.2","typeLabel":"PauseSubscription · object"},{"type":"object","title":"RevokeSubscription","required":["command","reason"],"x-tags":["Subscriptions"],"properties":{"command":{"description":"To revoke a subscription.","type":"string","const":"revoke","isRequired":true,"uniqueKey":"oneOf.3.command","typeLabel":"string"},"reason":{"description":"Provide reason for revoking subscription.","type":"string","isRequired":true,"uniqueKey":"oneOf.3.reason","typeLabel":"string"}},"uniqueKey":"oneOf.3","typeLabel":"RevokeSubscription · object"}],"uniqueKey":"","typeLabel":"UpdatePhysicalProductSubscription · object | UpdateDigitalProductSubscription · object | PauseSubscription · object | RevokeSubscription · object"},"examples":{"Example":{"title":"Example","value":{"command":"update","billing_frequency":"monthly","billing_interval":1,"billing_limit":123,"shipping_frequency":"monthly","shipping_interval":1,"shipping_limit":123,"is_prepaid":false,"usage_based_billing":false,"usage_based_tiers":[{"up_to":123,"price_per_unit":123}],"grace_period_days":0,"is_cancellation_allowed":true,"days_until_cancellation_allowed":3,"invoice_items":[{"product_id":"\u003cstring>","variant_id":"\u003cstring>","quantity":123}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"7fa21189-5a6f-4f01-9642-ab8d10c0b099":{"description":"OK","content":{"application/json":{"schema":{"type":"object","required":["message","success","content"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"content":{"properties":{"subscription":{"type":"object","title":"SubscriptionDetail","required":["id","plan_id","plan_name","price","status","start_date","end_date","trial_days","trial_start_date","trial_end_date","next_billing_date","last_payment_date","pause_start_date","pause_end_date","billing_frequency","billing_interval","billing_limit","shipping_frequency","shipping_interval","shipping_limit","coupon_id","coupon_code","coupon_discount_percent","coupon_discount_amount","coupon_redemption_limit","is_prepaid","usage_based_billing","usage_based_tiers","grace_period_days","is_cancellation_allowed","days_until_cancellation_allowed","currency","metadata","created_at","modified_at"],"x-tags":["Subscriptions"],"properties":{"id":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.id","typeLabel":"string"},"plan_id":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.plan_id","typeLabel":"string"},"plan_name":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.plan_name","typeLabel":"string"},"price":{"description":"The subscription price is the amount a customer is required to pay over a specified period (e.g., monthly, annually). This price may vary based on the plan selected or based on usage of services.","type":"number","format":"double","isRequired":true,"uniqueKey":"content.subscription.price","typeLabel":"number\u003cdouble>"},"status":{"enum":["created","active","paused","revoked"],"readOnly":true,"type":"string","isRequired":true,"uniqueKey":"content.subscription.status","typeLabel":"enum\u003cstring>"},"start_date":{"type":"string","format":"date","isRequired":true,"uniqueKey":"content.subscription.start_date","typeLabel":"string\u003cdate>"},"end_date":{"oneOf":[{"description":"if specified, subscrition will be revoked on this date.","type":"string","format":"date","isRequired":true,"uniqueKey":"content.subscription.end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"description":"if specified, subscrition will be revoked on this date.","type":"null","format":"date","isRequired":true,"uniqueKey":"content.subscription.end_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.end_date","typeLabel":"string\u003cdate> | null"},"trial_days":{"description":"If specified, payment will be charged after trial days completed.","type":"integer","default":0,"isRequired":true,"uniqueKey":"content.subscription.trial_days","typeLabel":"integer"},"trial_start_date":{"oneOf":[{"type":"string","format":"date","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.trial_start_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.trial_start_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.trial_start_date","typeLabel":"string\u003cdate> | null"},"trial_end_date":{"oneOf":[{"type":"string","format":"date","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.trial_end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.trial_end_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.trial_end_date","typeLabel":"string\u003cdate> | null"},"next_billing_date":{"type":"string","format":"date","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.next_billing_date","typeLabel":"string\u003cdate>"},"last_payment_date":{"oneOf":[{"type":"string","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.last_payment_date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.last_payment_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.last_payment_date","typeLabel":"string\u003cdate-time> | null"},"pause_start_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"content.subscription.pause_start_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","isRequired":true,"uniqueKey":"content.subscription.pause_start_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.pause_start_date","typeLabel":"string\u003cdate> | null"},"pause_end_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"content.subscription.pause_end_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","isRequired":true,"uniqueKey":"content.subscription.pause_end_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.pause_end_date","typeLabel":"string\u003cdate> | null"},"billing_frequency":{"enum":["monthly"],"type":"string","isRequired":true,"uniqueKey":"content.subscription.billing_frequency","typeLabel":"enum\u003cstring>"},"billing_interval":{"description":"Frequency unit multiplier. For example, `1` with `monthly` means every month; `3` with `weekly` means in every 3 weeks.","type":"integer","default":1,"isRequired":true,"uniqueKey":"content.subscription.billing_interval","typeLabel":"integer"},"billing_limit":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"content.subscription.billing_limit.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"content.subscription.billing_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.billing_limit","typeLabel":"integer | null"},"shipping_frequency":{"enum":["monthly"],"type":"string","isRequired":true,"uniqueKey":"content.subscription.shipping_frequency","typeLabel":"enum\u003cstring>"},"shipping_interval":{"description":"Frequency unit multiplier. For example, `1` with `monthly` means every month; `3` with `weekly` means in every 3 weeks.","type":"integer","default":1,"isRequired":true,"uniqueKey":"content.subscription.shipping_interval","typeLabel":"integer"},"shipping_limit":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"content.subscription.shipping_limit.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"content.subscription.shipping_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.shipping_limit","typeLabel":"integer | null"},"coupon_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.subscription.coupon_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.subscription.coupon_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.coupon_id","typeLabel":"string | null"},"coupon_code":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.subscription.coupon_code.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.subscription.coupon_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.coupon_code","typeLabel":"string | null"},"coupon_discount_percent":{"type":"number","default":0,"isRequired":true,"uniqueKey":"content.subscription.coupon_discount_percent","typeLabel":"number"},"coupon_discount_amount":{"type":"number","default":0,"isRequired":true,"uniqueKey":"content.subscription.coupon_discount_amount","typeLabel":"number"},"coupon_redemption_limit":{"oneOf":[{"description":"Indicates how many times a coupon can be redeemed within the subscription.","type":"integer","default":0,"isRequired":true,"uniqueKey":"content.subscription.coupon_redemption_limit.oneOf.0","typeLabel":"integer"},{"description":"Indicates how many times a coupon can be redeemed within the subscription.","type":"null","default":0,"isRequired":true,"uniqueKey":"content.subscription.coupon_redemption_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.coupon_redemption_limit","typeLabel":"integer | null"},"is_prepaid":{"description":"Indicates whether the subscription is paid in advance. When set to true, the subscription requires the customer to pay for the entire billing period upfront. When set to false, the subscription may operate on a pay-as-you-go or post-paid model, where charges are billed after the service is provided.","type":"boolean","default":false,"isRequired":true,"uniqueKey":"content.subscription.is_prepaid","typeLabel":"boolean"},"usage_based_billing":{"description":"Refers to a pricing model where customers are charged based on their actual usage of a service. Usage based billing works for digital products.","type":"boolean","isRequired":true,"uniqueKey":"content.subscription.usage_based_billing","typeLabel":"boolean"},"usage_based_tiers":{"description":"Refers to a pricing structure where customers are charged based on their usage, but the cost per unit of usage decreases or changes as they move into higher usage levels.","type":"array","items":{"type":"object","required":["up_to","price_per_unit"],"properties":{"up_to":{"type":"integer","isRequired":true,"uniqueKey":"content.subscription.usage_based_tiers.items.[INDEX].up_to","typeLabel":"integer"},"price_per_unit":{"type":"number","format":"double","isRequired":true,"uniqueKey":"content.subscription.usage_based_tiers.items.[INDEX].price_per_unit","typeLabel":"number\u003cdouble>"}},"uniqueKey":"content.subscription.usage_based_tiers.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"content.subscription.usage_based_tiers","typeLabel":"object[]"},"grace_period_days":{"description":"The number of days after a failed payment to retry before canceling.","type":"integer","default":0,"isRequired":true,"uniqueKey":"content.subscription.grace_period_days","typeLabel":"integer"},"is_cancellation_allowed":{"description":"Indcates whether the next billing cancellation is allowed or not.","type":"boolean","default":true,"isRequired":true,"uniqueKey":"content.subscription.is_cancellation_allowed","typeLabel":"boolean"},"days_until_cancellation_allowed":{"description":"Specifies the number of days the customer has to cancel before the next billing.","type":"integer","default":3,"isRequired":true,"uniqueKey":"content.subscription.days_until_cancellation_allowed","typeLabel":"integer"},"currency":{"type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/storefront/schemas/Currency","description":"API reference for the Currency schema"},"required":["name","code","symbol"],"properties":{"name":{"type":"string","examples":["Indian Rupee"],"isRequired":true,"uniqueKey":"content.subscription.currency.name","typeLabel":"string"},"code":{"type":"string","examples":["INR"],"maxLength":3,"minLength":3,"isRequired":true,"uniqueKey":"content.subscription.currency.code","typeLabel":"string"},"symbol":{"type":"string","examples":["₹"],"isRequired":true,"uniqueKey":"content.subscription.currency.symbol","typeLabel":"string"}},"description":"Details about the currency being used, including `name`, `code`, and `symbol`.","isRequired":true,"uniqueKey":"content.subscription.currency","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"content.subscription.metadata.additionalProperties","typeLabel":"string"},"isRequired":true,"uniqueKey":"content.subscription.metadata","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.subscription.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"content.subscription.modified_at","typeLabel":"string\u003cdate-time>"},"invoice_items":{"type":"array","items":{"title":"SubscriptionInvoiceItem","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/storefront/schemas/SubscriptionInvoiceItem","description":"API reference for the SubscriptionInvoiceItem schema"},"required":["product_id","variant_id","product_name","variant_name","product_image_url","sku","quantity","listing_price","selling_price","tax_type","tax_rate","price_including_tax","selling_price_excluding_tax"],"properties":{"product_id":{"type":"string","isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].product_id","typeLabel":"string"},"variant_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].variant_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].variant_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].variant_id","typeLabel":"string | null"},"product_name":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].product_name","typeLabel":"string"},"variant_name":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].variant_name","typeLabel":"string"},"product_image_url":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].product_image_url","typeLabel":"string"},"sku":{"type":"string","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].sku","typeLabel":"string"},"quantity":{"type":"integer","isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].quantity","typeLabel":"integer"},"listing_price":{"type":"number","format":"double","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].listing_price","typeLabel":"number\u003cdouble>"},"selling_price":{"type":"number","format":"double","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].selling_price","typeLabel":"number\u003cdouble>"},"tax_type":{"type":"string","const":"GST","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].tax_type","typeLabel":"string"},"tax_rate":{"type":"number","format":"double","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].tax_rate","typeLabel":"number\u003cdouble>"},"price_including_tax":{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].price_including_tax","typeLabel":"boolean"},"selling_price_excluding_tax":{"type":"number","format":"double","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.invoice_items.items.[INDEX].selling_price_excluding_tax","typeLabel":"number\u003cdouble>"}},"x-tags":["Subscriptions"],"uniqueKey":"content.subscription.invoice_items.items.[INDEX]","typeLabel":"SubscriptionInvoiceItem · object"},"uniqueKey":"content.subscription.invoice_items","typeLabel":"SubscriptionInvoiceItem · object[]"},"billing_address":{"oneOf":[{"title":"CustomerAddress","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/storefront/schemas/CustomerAddress","description":"API reference for the CustomerAddress schema"},"required":["first_name","last_name","country_code","phone","email","address_line1","address_line2","landmark","pincode","city","state","country","tax_identification_number","business_name","is_phone_verified","is_email_verified"],"properties":{"first_name":{"type":"string","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.first_name","typeLabel":"string"},"last_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.last_name","typeLabel":"string | null"},"country_code":{"description":"Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.\r\n","type":"string","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.country_code","typeLabel":"string"},"phone":{"description":"10 digit phone number without country code.","type":"string","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.phone","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.email","typeLabel":"string"},"address_line1":{"type":"string","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.address_line1","typeLabel":"string"},"address_line2":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.address_line2.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.address_line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.address_line2","typeLabel":"string | null"},"landmark":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.landmark.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.landmark.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.landmark","typeLabel":"string | null"},"pincode":{"type":"string","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.pincode","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.state","typeLabel":"string"},"country":{"type":"string","const":"India","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.country","typeLabel":"string"},"tax_identification_number":{"oneOf":[{"description":"Tax Identification Number specific to the country of operation.","type":"string","examples":[],"isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.tax_identification_number.oneOf.0","typeLabel":"string"},{"description":"Tax Identification Number specific to the country of operation.","type":"null","examples":[],"isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.tax_identification_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.tax_identification_number","typeLabel":"string | null"},"business_name":{"oneOf":[{"description":"Use in billing \u0026 shipping details only.","type":"string","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.business_name.oneOf.0","typeLabel":"string"},{"description":"Use in billing \u0026 shipping details only.","type":"null","isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.business_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.business_name","typeLabel":"string | null"},"is_phone_verified":{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.is_phone_verified","typeLabel":"boolean"},"is_email_verified":{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.is_email_verified","typeLabel":"boolean"},"id":{"oneOf":[{"type":"string","pattern":"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$","readOnly":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$","readOnly":true,"uniqueKey":"content.subscription.billing_address.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.subscription.billing_address.oneOf.0.id","typeLabel":"string | null"},"is_default_billing":{"description":"Indicates if the address is the default billing address for the customer.","type":"boolean","uniqueKey":"content.subscription.billing_address.oneOf.0.is_default_billing","typeLabel":"boolean"},"is_default_shipping":{"description":"Indicates if the address is the default shipping address for the customer.","type":"boolean","uniqueKey":"content.subscription.billing_address.oneOf.0.is_default_shipping","typeLabel":"boolean"},"nickname":{"oneOf":[{"description":"Nickname for the address.","type":"string","default":null,"uniqueKey":"content.subscription.billing_address.oneOf.0.nickname.oneOf.0","typeLabel":"string"},{"description":"Nickname for the address.","type":"null","default":null,"uniqueKey":"content.subscription.billing_address.oneOf.0.nickname.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.subscription.billing_address.oneOf.0.nickname","typeLabel":"string | null"}},"examples":[],"uniqueKey":"content.subscription.billing_address.oneOf.0","typeLabel":"CustomerAddress · object"},{"title":"CustomerAddress","type":"null","externalDocs":{"url":"https://llm-docs.commercengine.io/storefront/schemas/CustomerAddress","description":"API reference for the CustomerAddress schema"},"required":["first_name","last_name","country_code","phone","email","address_line1","address_line2","landmark","pincode","city","state","country","tax_identification_number","business_name","is_phone_verified","is_email_verified"],"properties":{"id":{"oneOf":[{"type":"string","pattern":"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$","readOnly":true},{"type":"null","pattern":"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$","readOnly":true}]},"first_name":{"type":"string"},"last_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"country_code":{"description":"Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.\r\n","type":"string"},"phone":{"description":"10 digit phone number without country code.","type":"string"},"email":{"type":"string"},"address_line1":{"type":"string"},"address_line2":{"oneOf":[{"type":"string"},{"type":"null"}]},"landmark":{"oneOf":[{"type":"string"},{"type":"null"}]},"pincode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string","const":"India"},"tax_identification_number":{"oneOf":[{"description":"Tax Identification Number specific to the country of operation.","type":"string","examples":[]},{"description":"Tax Identification Number specific to the country of operation.","type":"null","examples":[]}]},"business_name":{"oneOf":[{"description":"Use in billing \u0026 shipping details only.","type":"string"},{"description":"Use in billing \u0026 shipping details only.","type":"null"}]},"is_default_billing":{"description":"Indicates if the address is the default billing address for the customer.","type":"boolean"},"is_default_shipping":{"description":"Indicates if the address is the default shipping address for the customer.","type":"boolean"},"is_phone_verified":{"type":"boolean","readOnly":true},"is_email_verified":{"type":"boolean","readOnly":true},"nickname":{"oneOf":[{"description":"Nickname for the address.","type":"string","default":null},{"description":"Nickname for the address.","type":"null","default":null}]}},"examples":[],"uniqueKey":"content.subscription.billing_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.subscription.billing_address","typeLabel":"CustomerAddress · object | null"},"shipping_address":{"oneOf":[{"title":"CustomerAddress","type":"object","externalDocs":{"url":"https://llm-docs.commercengine.io/storefront/schemas/CustomerAddress","description":"API reference for the CustomerAddress schema"},"required":["first_name","last_name","country_code","phone","email","address_line1","address_line2","landmark","pincode","city","state","country","tax_identification_number","business_name","is_phone_verified","is_email_verified"],"properties":{"first_name":{"type":"string","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.first_name","typeLabel":"string"},"last_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.last_name","typeLabel":"string | null"},"country_code":{"description":"Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.\r\n","type":"string","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.country_code","typeLabel":"string"},"phone":{"description":"10 digit phone number without country code.","type":"string","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.phone","typeLabel":"string"},"email":{"type":"string","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.email","typeLabel":"string"},"address_line1":{"type":"string","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.address_line1","typeLabel":"string"},"address_line2":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.address_line2.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.address_line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.address_line2","typeLabel":"string | null"},"landmark":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.landmark.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.landmark.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.landmark","typeLabel":"string | null"},"pincode":{"type":"string","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.pincode","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.state","typeLabel":"string"},"country":{"type":"string","const":"India","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.country","typeLabel":"string"},"tax_identification_number":{"oneOf":[{"description":"Tax Identification Number specific to the country of operation.","type":"string","examples":[],"isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.tax_identification_number.oneOf.0","typeLabel":"string"},{"description":"Tax Identification Number specific to the country of operation.","type":"null","examples":[],"isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.tax_identification_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.tax_identification_number","typeLabel":"string | null"},"business_name":{"oneOf":[{"description":"Use in billing \u0026 shipping details only.","type":"string","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.business_name.oneOf.0","typeLabel":"string"},{"description":"Use in billing \u0026 shipping details only.","type":"null","isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.business_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.business_name","typeLabel":"string | null"},"is_phone_verified":{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.is_phone_verified","typeLabel":"boolean"},"is_email_verified":{"type":"boolean","readOnly":true,"isRequired":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.is_email_verified","typeLabel":"boolean"},"id":{"oneOf":[{"type":"string","pattern":"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$","readOnly":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$","readOnly":true,"uniqueKey":"content.subscription.shipping_address.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.subscription.shipping_address.oneOf.0.id","typeLabel":"string | null"},"is_default_billing":{"description":"Indicates if the address is the default billing address for the customer.","type":"boolean","uniqueKey":"content.subscription.shipping_address.oneOf.0.is_default_billing","typeLabel":"boolean"},"is_default_shipping":{"description":"Indicates if the address is the default shipping address for the customer.","type":"boolean","uniqueKey":"content.subscription.shipping_address.oneOf.0.is_default_shipping","typeLabel":"boolean"},"nickname":{"oneOf":[{"description":"Nickname for the address.","type":"string","default":null,"uniqueKey":"content.subscription.shipping_address.oneOf.0.nickname.oneOf.0","typeLabel":"string"},{"description":"Nickname for the address.","type":"null","default":null,"uniqueKey":"content.subscription.shipping_address.oneOf.0.nickname.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.subscription.shipping_address.oneOf.0.nickname","typeLabel":"string | null"}},"examples":[],"uniqueKey":"content.subscription.shipping_address.oneOf.0","typeLabel":"CustomerAddress · object"},{"title":"CustomerAddress","type":"null","externalDocs":{"url":"https://llm-docs.commercengine.io/storefront/schemas/CustomerAddress","description":"API reference for the CustomerAddress schema"},"required":["first_name","last_name","country_code","phone","email","address_line1","address_line2","landmark","pincode","city","state","country","tax_identification_number","business_name","is_phone_verified","is_email_verified"],"properties":{"id":{"oneOf":[{"type":"string","pattern":"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$","readOnly":true},{"type":"null","pattern":"^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$","readOnly":true}]},"first_name":{"type":"string"},"last_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"country_code":{"description":"Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.\r\n","type":"string"},"phone":{"description":"10 digit phone number without country code.","type":"string"},"email":{"type":"string"},"address_line1":{"type":"string"},"address_line2":{"oneOf":[{"type":"string"},{"type":"null"}]},"landmark":{"oneOf":[{"type":"string"},{"type":"null"}]},"pincode":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string","const":"India"},"tax_identification_number":{"oneOf":[{"description":"Tax Identification Number specific to the country of operation.","type":"string","examples":[]},{"description":"Tax Identification Number specific to the country of operation.","type":"null","examples":[]}]},"business_name":{"oneOf":[{"description":"Use in billing \u0026 shipping details only.","type":"string"},{"description":"Use in billing \u0026 shipping details only.","type":"null"}]},"is_default_billing":{"description":"Indicates if the address is the default billing address for the customer.","type":"boolean"},"is_default_shipping":{"description":"Indicates if the address is the default shipping address for the customer.","type":"boolean"},"is_phone_verified":{"type":"boolean","readOnly":true},"is_email_verified":{"type":"boolean","readOnly":true},"nickname":{"oneOf":[{"description":"Nickname for the address.","type":"string","default":null},{"description":"Nickname for the address.","type":"null","default":null}]}},"examples":[],"uniqueKey":"content.subscription.shipping_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"content.subscription.shipping_address","typeLabel":"CustomerAddress · object | null"}},"isRequired":true,"uniqueKey":"content.subscription","typeLabel":"SubscriptionDetail · object"}},"required":["subscription"],"type":"object","isRequired":true,"uniqueKey":"content","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":true,"content":{"subscription":{"id":"\u003cstring>","plan_id":"\u003cstring>","plan_name":"\u003cstring>","price":123,"status":"created","start_date":"2023-12-25","end_date":"2023-12-25","trial_days":0,"trial_start_date":"2023-12-25","trial_end_date":"2023-12-25","next_billing_date":"2023-12-25","last_payment_date":"2023-11-07T05:31:56Z","pause_start_date":"2023-12-25","pause_end_date":"2023-12-25","billing_frequency":"monthly","billing_interval":1,"billing_limit":123,"shipping_frequency":"monthly","shipping_interval":1,"shipping_limit":123,"coupon_id":"\u003cstring>","coupon_code":"\u003cstring>","coupon_discount_percent":0,"coupon_discount_amount":0,"coupon_redemption_limit":0,"is_prepaid":false,"usage_based_billing":true,"usage_based_tiers":[{"up_to":123,"price_per_unit":123}],"grace_period_days":0,"is_cancellation_allowed":true,"days_until_cancellation_allowed":3,"currency":{"name":"Indian Rupee","code":"INR","symbol":"₹"},"metadata":{},"created_at":"2023-11-07T05:31:56Z","modified_at":"2023-11-07T05:31:56Z","invoice_items":[{"product_id":"\u003cstring>","variant_id":"\u003cstring>","product_name":"\u003cstring>","variant_name":"\u003cstring>","product_image_url":"\u003cstring>","sku":"\u003cstring>","quantity":123,"listing_price":123,"selling_price":123,"tax_type":"GST","tax_rate":123,"price_including_tax":true,"selling_price_excluding_tax":123}],"billing_address":{"first_name":"\u003cstring>","last_name":"\u003cstring>","country_code":"\u003cstring>","phone":"\u003cstring>","email":"\u003cstring>","address_line1":"\u003cstring>","address_line2":"\u003cstring>","landmark":"\u003cstring>","pincode":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","country":"India","tax_identification_number":"\u003cstring>","business_name":"\u003cstring>","is_phone_verified":true,"is_email_verified":true,"id":"\u003cstring>","is_default_billing":true,"is_default_shipping":true,"nickname":null},"shipping_address":{"first_name":"\u003cstring>","last_name":"\u003cstring>","country_code":"\u003cstring>","phone":"\u003cstring>","email":"\u003cstring>","address_line1":"\u003cstring>","address_line2":"\u003cstring>","landmark":"\u003cstring>","pincode":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","country":"India","tax_identification_number":"\u003cstring>","business_name":"\u003cstring>","is_phone_verified":true,"is_email_verified":true,"id":"\u003cstring>","is_default_billing":true,"is_default_shipping":true,"nickname":null}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"e6d28e63-0956-4465-9600-b46604895f90":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["message","success","code"],"properties":{"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"errors":{"type":"object","uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":true,"code":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"b32a48a9-8f17-418c-9ffb-92cc2b36ff3b":{"description":"Not authorized for given operation on the Resource","content":{"application/json":{"schema":{"type":"object","required":["message","success","code"],"properties":{"message":{"type":"string","examples":["Not authorized for given operation on the Resource."],"x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","examples":["unauthorized"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Not authorized for given operation on the Resource.","success":false,"code":"unauthorized"}}},"exampleType":"generated"}},"exampleType":"generated"},"16cdda2e-1cd7-4083-b413-8c49e72ec9df":{"description":"Requested resource not found","content":{"application/json":{"schema":{"type":"object","required":["message","success","code"],"properties":{"message":{"type":"string","x-speakeasy-error-message":true,"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"success":{"type":"boolean","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","success":true,"code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"e5367614-55b7-4002-bc7f-1a071c7782a0":{"url":"https://staging.api.commercengine.io/api/v1/{store_id}/storefront","description":"Staging Server","variables":{"store_id":{"description":"Store ID","default":"store_id"}},"x-speakeasy-server-id":"staging"},"eda6531b-14b9-4366-9c9b-a4c621a2c670":{"url":"https://prod.api.commercengine.io/api/v1/{store_id}/storefront","description":"Prod Server","variables":{"store_id":{"description":"Store ID","default":"store_id"}},"x-speakeasy-server-id":"prod"}}},"originalFileLocation":"https://openapi.commercengine.io/ce-storefront.json"},"subdomain":"tarkai","siteName":"Commerce Engine Docs","title":"Update a specific subscription - Commerce Engine Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-15T05:03:52.432Z","originalFileLocation":"api-reference/subscriptions/update-a-specific-subscription.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=\"system\"}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=\"Update a specific subscription\">\u003cmeta data-mint-head name=\"application-name\" content=\"Commerce Engine Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/tarkai/OqQIjYq8Q24cGlMx/_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=\"/docs/mintlify-assets/_mintlify/favicons/tarkai/OqQIjYq8Q24cGlMx/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/tarkai/OqQIjYq8Q24cGlMx/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/tarkai/OqQIjYq8Q24cGlMx/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/tarkai/OqQIjYq8Q24cGlMx/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/tarkai/OqQIjYq8Q24cGlMx/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/tarkai/OqQIjYq8Q24cGlMx/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/tarkai/OqQIjYq8Q24cGlMx/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/tarkai/OqQIjYq8Q24cGlMx/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a specific subscription - Commerce Engine Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update a specific subscription\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Commerce Engine Developer Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.commercengine.io/docs/api-reference/subscriptions/update-a-specific-subscription\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tarkai.mintlify.site/docs/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Update+a+specific+subscription\u0026amp;description=Update+a+specific+subscription\u0026amp;theme=7db58efe0b2f8f135bbc1ad9\u0026amp;signature=146d65b6d45c67cce88ede85354d13b1bdfb660a116cfcea9d309089c139cf90\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Update a specific subscription - Commerce Engine Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update a specific subscription\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tarkai.mintlify.site/docs/_mintlify/api/og/v2?division=Subscriptions\u0026amp;title=Update+a+specific+subscription\u0026amp;description=Update+a+specific+subscription\u0026amp;theme=7db58efe0b2f8f135bbc1ad9\u0026amp;signature=146d65b6d45c67cce88ede85354d13b1bdfb660a116cfcea9d309089c139cf90\">\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=\"/docs/mintlify-assets/_mintlify/favicons/tarkai/OqQIjYq8Q24cGlMx/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Commerce Engine Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00BF6F\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"og:logo\" content=\"/logo/CE_logo_whitebg.svg\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.commercengine.io/docs/api-reference/subscriptions/update-a-specific-subscription\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/subscriptions/update-a-specific-subscription.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.commercengine.io/#organization\",\"name\":\"Commerce Engine Docs\",\"url\":\"https://www.commercengine.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/tarkai/hIY7_H2biaAvOGu7/logo/CE_Developers_black.svg?fit=max\u0026auto=format\u0026n=hIY7_H2biaAvOGu7\u0026q=85\u0026s=d93f21564dfd373c7f2efc88c9d4301e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.commercengine.io/docs#website\",\"name\":\"Commerce Engine Docs\",\"url\":\"https://www.commercengine.io/docs\",\"publisher\":{\"@id\":\"https://www.commercengine.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.commercengine.io/docs/api-reference/subscriptions/update-a-specific-subscription#webpage\",\"url\":\"https://www.commercengine.io/docs/api-reference/subscriptions/update-a-specific-subscription\",\"name\":\"Update a specific subscription\",\"description\":\"Update a specific subscription\",\"dateModified\":\"2025-08-15T05:03:52.432Z\",\"isPartOf\":{\"@id\":\"https://www.commercengine.io/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.commercengine.io/docs/api-reference/subscriptions/update-a-specific-subscription#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.commercengine.io/docs/api-reference/subscriptions/update-a-specific-subscription#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"🛍️ Commerce\",\"item\":\"https://www.commercengine.io/docs/api-reference/catalog/list-all-products\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Subscriptions\",\"item\":\"https://www.commercengine.io/docs/api-reference/subscriptions/list-all-subscriptions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a specific subscription\",\"item\":\"https://www.commercengine.io/docs/api-reference/subscriptions/update-a-specific-subscription\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.commercengine.io/docs/api-reference/subscriptions/update-a-specific-subscription#apireference\",\"headline\":\"Update a specific subscription\",\"name\":\"Update a specific subscription\",\"description\":\"Update a specific subscription\",\"url\":\"https://www.commercengine.io/docs/api-reference/subscriptions/update-a-specific-subscription\",\"mainEntityOfPage\":{\"@id\":\"https://www.commercengine.io/docs/api-reference/subscriptions/update-a-specific-subscription#webpage\"},\"dateModified\":\"2025-08-15T05:03:52.432Z\",\"publisher\":{\"@id\":\"https://www.commercengine.io/#organization\"},\"isPartOf\":{\"@id\":\"https://www.commercengine.io/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Commerce Engine Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Commerce Engine Docs","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open-cover","menu":[{"item":"Quickstart","icon":"rocket","description":"Get your keys, then make your first API call in under 15 minutes.","pages":[{"title":"Quickstart","href":"/storefront/quickstart"}]},{"item":"Starters","icon":"rocket","description":"Three production storefronts, each cloned across five frameworks.","pages":[{"title":"Starters","href":"/starters/overview"}]},{"item":"AI-assisted development","icon":"wand-magic-sparkles","description":"Skills, prompts and starters for coding agents.","pages":[{"title":"AI-assisted development","href":"/ai/overview"}]},{"item":"Storefront","icon":"store","description":"Auth, catalog, cart, checkout, account and subscriptions.","pages":[{"title":"Storefront","href":"/storefront/authentication"}]},{"item":"Hosted checkout","icon":"bag-shopping","description":"Drop-in embeddable cart and checkout for any stack.","pages":[{"title":"Hosted checkout","href":"/hosted-checkout/overview"}]},{"item":"SEO \u0026 AEO","icon":"magnifying-glass","description":"Structured data, canonical metadata, sitemaps and llms.txt.","pages":[{"title":"SEO \u0026 AEO","href":"/seo-ai/overview"}]},{"item":"Agent tools","icon":"robot","description":"WebMCP tools that let browser agents shop your store.","pages":[{"title":"Agent tools","href":"/seo-ai/ai"}]}],"pages":[{"title":"Guides","href":"/storefront/quickstart"}]},{"tab":"Hosted Checkout","icon":"bag-shopping","pages":[{"title":"Hosted Checkout","href":"/hosted-checkout/overview"}]},{"tab":"Packages","icon":"cube","menu":[{"item":"storefront","icon":"box","description":"Framework wrappers for React, Next.js, SvelteKit and Astro.","pages":[{"title":"storefront","href":"/sdk/installation"}]},{"item":"ssr-utils","icon":"server","description":"Framework-agnostic cookie-backed SSR session utilities.","pages":[{"title":"ssr-utils","href":"/sdk/ssr-utils"}]},{"item":"checkout","icon":"bag-shopping","description":"Universal checkout SDK — hosted, embedded or headless.","pages":[{"title":"checkout","href":"/hosted-checkout/overview"}]},{"item":"pos","icon":"cash-register","description":"TypeScript SDK for the POS API, for in-store selling.","pages":[{"title":"pos","href":"/pos/overview"}]},{"item":"analytics","icon":"chart-line","description":"Zero-dependency mappers for canonical commerce events.","pages":[{"title":"analytics","href":"/hosted-checkout/analytics"}]},{"item":"seo","icon":"magnifying-glass","description":"Opinionated SEO, AEO, structured data and Markdown output.","pages":[{"title":"seo","href":"/seo-ai/overview"}]},{"item":"ai","icon":"wand-magic-sparkles","description":"Browser-native agent tools (WebMCP) for storefronts.","pages":[{"title":"ai","href":"/seo-ai/ai"}]},{"item":"Browse all packages","icon":"grid-2","description":"Every published Commerce Engine package on npm.","href":"https://www.npmjs.com/org/commercengine"}],"pages":[{"title":"Packages","href":"/sdk/installation"}]},{"tab":"API Reference","icon":"code","menu":[{"item":"Storefront API","icon":"store","description":"Everything a storefront calls — catalog, cart, checkout, auth, orders.","groups":[{"group":"Introduction","pages":[{"title":"Getting Started","icon":"rocket","href":"/api-reference/getting-started"}]},{"group":"🛍️ Commerce","pages":[{"group":"Catalog","icon":"store","pages":[{"openapi":"get /catalog/products","title":"List all products","href":"/api-reference/catalog/list-all-products"},{"openapi":"get /catalog/skus","title":"List all SKUs","href":"/api-reference/catalog/list-all-skus"},{"openapi":"get /catalog/products/{product_id}","title":"Retrieve a product detail","href":"/api-reference/catalog/retrieve-a-product-detail"},{"openapi":"get /catalog/products/{product_id}/variants","title":"Retrieve product variants","href":"/api-reference/catalog/retrieve-product-variants"},{"openapi":"get /catalog/products/{product_id}/variants/{variant_id}","title":"Retrieve variant detail","href":"/api-reference/catalog/retrieve-variant-detail"},{"openapi":"get /catalog/categories","title":"List all categories","href":"/api-reference/catalog/list-all-categories"},{"openapi":"get /catalog/products/{product_id}/reviews","title":"List product reviews","href":"/api-reference/catalog/list-all-product-reviews"},{"openapi":"post /catalog/products/{product_id}/reviews","title":null,"href":"/api-reference/catalog/create-product-review"},{"openapi":"get /catalog/products/similar","title":"Retrieve similar products","href":"/api-reference/catalog/retrieve-similar-products"},{"openapi":"get /catalog/products/up-sell","title":"Retrieve up-sell products","href":"/api-reference/catalog/retrieve-up-sell-products"},{"openapi":"get /catalog/products/cross-sell","title":"Retrieve cross-sell products","href":"/api-reference/catalog/retrieve-cross-sell-products"},{"openapi":"post /catalog/products/search","title":"Search products","href":"/api-reference/catalog/search-products"}]},{"group":"Carts","icon":"cart-shopping","pages":[{"openapi":"post /carts","title":"Create cart","href":"/api-reference/carts/create-cart"},{"openapi":"get /carts/{id}","title":"Retrieve cart detail","href":"/api-reference/carts/retrieve-cart-detail"},{"openapi":"delete /carts/{id}","title":"Delete cart","href":"/api-reference/carts/delete-cart"},{"openapi":"get /carts/users/{user_id}","title":"Retrieve cart by user ID","href":"/api-reference/carts/retrieve-cart-using-user-id"},{"openapi":"delete /carts/users/{user_id}","title":"Delete cart using user id","href":"/api-reference/carts/delete-cart-using-user-id"},{"openapi":"post /carts/{id}/items","title":"Add, update, or remove a cart item","href":"/api-reference/carts/adddelete-cart-item"},{"openapi":"post /carts/{id}/address","title":"Set cart address","href":"/api-reference/carts/update-cart-address"},{"openapi":"post /carts/{id}/coupon","title":"Apply coupon","href":"/api-reference/carts/apply-coupon"},{"openapi":"delete /carts/{id}/coupon","title":"Remove coupon","href":"/api-reference/carts/remove-coupon"},{"openapi":"post /carts/{id}/loyalty-points","title":"Redeem loyalty points","href":"/api-reference/carts/redeem-loyalty-points"},{"openapi":"delete /carts/{id}/loyalty-points","title":"Remove loyalty points","href":"/api-reference/carts/remove-loyalty-points"},{"openapi":"post /carts/{id}/credit-balance","title":"Use credit balance","href":"/api-reference/carts/use-credit-balance"},{"openapi":"delete /carts/{id}/credit-balance","title":"Remove credit balance","href":"/api-reference/carts/remove-credit-balance"},{"openapi":"post /fulfillment/serviceability","title":"Check fulfillment","href":"/api-reference/carts/check-fulfillment"},{"openapi":"post /carts/{id}/fulfillment-preference","title":"Update fulfillment preference","href":"/api-reference/carts/update-fulfillment-preference"},{"openapi":"post /carts/fulfillment-options","title":"Retrieve fulfillment options","href":"/api-reference/carts/retrieve-fulfillment-options"},{"openapi":"get /wishlist/{user_id}","title":"Retrieve wishlist","href":"/api-reference/carts/retrieve-wishlist"},{"openapi":"post /wishlist/{user_id}","title":"Add product to wishlist","href":"/api-reference/carts/add-product-to-wishlist"},{"openapi":"delete /wishlist/{user_id}","title":"Delete product from wishlist","href":"/api-reference/carts/delete-product-from-wishlist"}]},{"group":"Coupons \u0026 Promotions","icon":"percent","pages":[{"openapi":"get /carts/available-coupons","title":"Retrieve all coupons","href":"/api-reference/carts/retrieve-all-coupons"},{"openapi":"get /carts/available-promotions","title":"Retrieve all promotions","href":"/api-reference/carts/retrieve-all-promotions"},{"openapi":"get /carts/{id}/evaluate-coupons","title":"Evaluate coupons","href":"/api-reference/carts/evaluate-coupons"},{"openapi":"get /carts/{id}/evaluate-promotions","title":"Evaluate promotions","href":"/api-reference/carts/evaluate-promotions"}]},{"group":"Orders","icon":"receipt","pages":[{"openapi":"get /orders","title":"List all orders","href":"/api-reference/orders/retrieve-all-orders"},{"openapi":"post /orders","title":null,"href":"/api-reference/orders/create-order"},{"openapi":"get /orders/{order_number}","title":"Retrieve order details","href":"/api-reference/orders/retrieve-order-detail"},{"openapi":"get /orders/{order_number}/payment-status","title":"Retrieve payment status","href":"/api-reference/orders/retrieve-payment-status"},{"openapi":"get /orders/{order_number}/shipments","title":"Retrieve order shipments","href":"/api-reference/orders/retrieve-order-shipments"},{"openapi":"get /orders/{order_number}/refunds","title":"Retrieve order refunds","href":"/api-reference/orders/retrieve-order-refunds"},{"openapi":"get /orders/{order_number}/payments","title":"Retrieve order payments","href":"/api-reference/orders/retrieve-order-payments"},{"openapi":"post /orders/{order_number}/return","title":null,"href":"/api-reference/orders/create-order-return"},{"openapi":"get /orders/{order_number}/return/{return_id}","title":null,"href":"/api-reference/orders/retrieve-order-return-detail"},{"openapi":"post /orders/{order_number}/cancel","title":"Cancel an order","href":"/api-reference/orders/cancel-order"},{"openapi":"post /orders/{order_number}/cancel-payment-request","title":"Cancel payment request","href":"/api-reference/orders/cancel-payment-request"},{"openapi":"post /orders/{order_number}/retry-payment","title":"Retry payment","href":"/api-reference/orders/retry-payment"},{"openapi":"get /orders/returns","title":null,"href":"/api-reference/orders/retrieve-all-order-returns"}]},{"group":"Payments","icon":"credit-card","pages":[{"openapi":"get /payments/payment-methods","title":"List all payment methods","href":"/api-reference/payments/list-all-payment-methods"},{"openapi":"get /payments/verify-vpa","title":"Verify VPA","href":"/api-reference/payments/verify-vpa"},{"openapi":"post /payments/authenticate-direct-otp","title":"Authenticate direct OTP","href":"/api-reference/payments/authenticate-direct-otp"},{"openapi":"post /payments/resend-direct-otp","title":"Resend direct OTP","href":"/api-reference/payments/resend-direct-otp"},{"openapi":"get /payments/card-info","title":"Get card information","href":"/api-reference/payments/get-card-information"},{"group":"PayU (Integration)","pages":[{"openapi":"post /payments/generate-hash","title":"Generate hash","href":"/api-reference/payu/generate-hash"}]},{"group":"Juspay (Integration)","pages":[{"openapi":"post /payments/juspay/create-order","title":"Create order in juspay","href":"/api-reference/juspay/create-order-in-juspay"},{"openapi":"post /payments/juspay/customers","title":"Create customer in juspay","href":"/api-reference/juspay/create-customer-in-juspay"},{"openapi":"get /payments/juspay/customers/{user-id}","title":null,"href":"/api-reference/juspay/retrieve-customer-from-juspay"}]}]},{"group":"Subscriptions","icon":"calendar-days","pages":[{"openapi":"get /subscriptions","title":"List all subscriptions","href":"/api-reference/subscriptions/list-all-subscriptions"},{"openapi":"post /subscriptions","title":"Create subscription","href":"/api-reference/subscriptions/create-subscription"},{"openapi":"get /subscriptions/{id}","title":"Retrieve subscription details","description":"Retrieve subscription details","href":"/api-reference/subscriptions/retrieve-subscription-details"},{"openapi":"put /subscriptions/{id}","title":"Update a specific subscription","href":"/api-reference/subscriptions/update-a-specific-subscription"}]}]},{"group":"🙋 Customers","pages":[{"group":"Auth","icon":"lock","pages":[{"openapi":"post /auth/anonymous","title":"Create anonymous session","description":"Creates an anonymous user session with a persistent `user_id` for analytics and cart tracking. Returns an `AnonymousUser` object with `access_token` and `refresh_token`. Call this before any other authenticated endpoint for guest users.","href":"/api-reference/auth/create-anonymous-session"},{"openapi":"post /auth/login/phone","title":"Login with phone","href":"/api-reference/auth/login-with-phone"},{"openapi":"post /auth/login/email","title":"Login with email","href":"/api-reference/auth/login-with-email"},{"openapi":"post /auth/login/whatsapp","title":"Login with WhatsApp","href":"/api-reference/auth/login-with-whatsapp"},{"openapi":"post /auth/login/password","title":"Login with password","href":"/api-reference/auth/login-with-password"},{"openapi":"post /auth/verify-otp","title":"Verify OTP","href":"/api-reference/auth/verify-otp"},{"openapi":"post /auth/register/phone","title":"Register with phone","href":"/api-reference/auth/register-with-phone"},{"openapi":"post /auth/register/email","title":"Register with email","href":"/api-reference/auth/register-with-email"},{"openapi":"post /auth/register/whatsapp","title":"Register with WhatsApp","href":"/api-reference/auth/register-with-whatsapp"},{"openapi":"post /auth/register/password","title":"Register with password","href":"/api-reference/auth/register-with-password"},{"openapi":"get /auth/user/{id}","title":"Retrieve a user","href":"/api-reference/auth/retrieve-a-user"},{"openapi":"put /auth/user/{id}","title":"Update a user","href":"/api-reference/auth/update-a-user"},{"openapi":"delete /auth/user/{id}","title":"Delete a user","href":"/api-reference/auth/delete-a-user"},{"openapi":"get /auth/user/{id}/profile-image","title":"Retrieve a profile image","href":"/api-reference/auth/retrieve-a-profile-image"},{"openapi":"put /auth/user/{id}/profile-image","title":"Update profile image","href":"/api-reference/auth/update-profile-image"},{"openapi":"post /auth/user/{id}/profile-image","title":"Add profile image","href":"/api-reference/auth/add-profile-image"},{"openapi":"delete /auth/user/{id}/profile-image","title":"Delete profile image","href":"/api-reference/auth/delete-profile-image"},{"openapi":"put /auth/user/{id}/deactivate","title":"Deactivate account","href":"/api-reference/auth/deactivate-account"},{"openapi":"post /auth/refresh-token","title":"Refresh access token","href":"/api-reference/auth/refresh-access-token"},{"openapi":"post /auth/change-password","title":"Change password","href":"/api-reference/auth/change-password"},{"openapi":"post /auth/forgot-password","title":"Forgot password","href":"/api-reference/auth/forgot-password"},{"openapi":"post /auth/reset-password","title":"Reset password","href":"/api-reference/auth/reset-password"},{"openapi":"get /auth/user/{id}/notification-preferences","title":null,"href":"/api-reference/auth/retrieve-user-notification-preferences"},{"openapi":"put /auth/user/{id}/notification-preferences","title":null,"href":"/api-reference/auth/update-user-notification-preferences"},{"openapi":"post /auth/user/{id}/notification-preferences","title":null,"href":"/api-reference/auth/create-user-notification-preferences"},{"openapi":"post /auth/generate-otp","title":"Generate OTP","href":"/api-reference/auth/generate-otp"},{"openapi":"post /auth/logout","title":"Logout user","href":"/api-reference/auth/logout-user"},{"openapi":"post /auth/verified-email-phone","title":"Check email/phone verification status","href":"/api-reference/auth/check-emailphone-verification-status"}]},{"group":"Customers","icon":"user","pages":[{"openapi":"get /customers/{customer_id}/cards","title":"List all saved cards","href":"/api-reference/customers/list-all-saved-cards"},{"openapi":"get /customers/{customer_id}/payment-methods","title":"List all saved payment methods","href":"/api-reference/customers/list-all-saved-payment-methods"},{"openapi":"get /customers/{user_id}/addresses","title":null,"href":"/api-reference/customers/retrieve-all-addresses"},{"openapi":"post /customers/{user_id}/addresses","title":null,"href":"/api-reference/customers/create-address"},{"openapi":"get /customers/{user_id}/addresses/{address_id}","title":null,"href":"/api-reference/customers/retrieve-particular-address"},{"openapi":"put /customers/{user_id}/addresses/{address_id}","title":null,"href":"/api-reference/customers/update-particular-address"},{"openapi":"delete /customers/{user_id}/addresses/{address_id}","title":null,"href":"/api-reference/customers/remove-particular-address"},{"openapi":"get /customers/{user_id}/loyalty","title":null,"href":"/api-reference/customers/retrieve-loyalty-details"},{"openapi":"get /customers/{user_id}/loyalty-points-activity","title":null,"href":"/api-reference/customers/list-all-loyalty-points-activity"},{"openapi":"get /customers/{user_id}/reviews","title":null,"href":"/api-reference/customers/retrieve-all-reviews"}]},{"group":"KYC","icon":"id-card","pages":[{"openapi":"get /store/kyc-document","title":"List all kyc documents","href":"/api-reference/kyc/list-all-kyc-documents"},{"openapi":"get /customers/{id}/documents","title":"List all documents","href":"/api-reference/kyc/list-all-documents"},{"openapi":"post /customers/{id}/documents","title":"Create document","href":"/api-reference/kyc/create-document"},{"openapi":"get /customers/{id}/documents/{document_id}","title":"Retrieve document detail","href":"/api-reference/kyc/retrieve-document-detail"},{"openapi":"put /customers/{id}/documents/{document_id}","title":"Update document detail","href":"/api-reference/kyc/update-document-detail"},{"openapi":"delete /customers/{id}/documents/{document_id}","title":"Delete document","href":"/api-reference/kyc/delete-document"},{"openapi":"post /customers/{id}/documents/verify","title":null,"href":"/api-reference/kyc/verify-document"}]}]},{"group":"🎟️ Engagement \u0026 Retention","pages":[{"group":"Campaigns","icon":"envelope","pages":[{"openapi":"post /campaigns/newsletter-subscribe","title":"Subscribe to newsletter","href":"/api-reference/campaigns/subscribe-to-newsletter"}]},{"group":"Analytics","icon":"chart-line","pages":[{"openapi":"post /analytics/track","title":"Track event","href":"/api-reference/analytics/track-event"}]}]},{"group":"🧰 Utilities","pages":[{"group":"Common","icon":"circle-info","pages":[{"openapi":"get /common/countries","title":"Retrieve all countries","href":"/api-reference/common/retrieve-all-countries"},{"openapi":"get /common/countries/{country_iso_code}/states","title":"Retrieve country wise states","href":"/api-reference/common/retrieve-country-wise-states"},{"openapi":"get /common/countries/{country_iso_code}/pincodes","title":"Retrieve pincodes","href":"/api-reference/common/retrieve-pincodes"}]}]},{"group":"Store Config","icon":"store","pages":[{"openapi":"get /store/check","title":"Check store existence","href":"/api-reference/store/check-store-existence"},{"openapi":"get /store/config","title":"Retrieve store config","href":"/api-reference/store/retrieve-store-config"}]},{"group":"Marketplace","icon":"store","pages":[{"group":"Catalog","icon":"store","pages":[{"openapi":"get /catalog/marketplace/products","title":"List all products","href":"/api-reference/marketplace/list-all-products"},{"openapi":"get /catalog/marketplace/skus","title":"List all SKUs","href":"/api-reference/marketplace/list-all-skus"},{"openapi":"get /catalog/marketplace/products/{product_id_or_slug}","title":null,"href":"/api-reference/marketplace/retrieve-a-product-detail"},{"openapi":"get /catalog/marketplace/products/{product_id}/variants","title":"Retrieve product variants","href":"/api-reference/marketplace/retrieve-product-variants"},{"openapi":"get /catalog/marketplace/products/{product_id}/variants/{variant_id}","title":"Retrieve variant detail","href":"/api-reference/marketplace/retrieve-variant-detail"},{"openapi":"get /catalog/marketplace/categories","title":"List all categories","href":"/api-reference/marketplace/list-all-categories"},{"openapi":"get /catalog/marketplace/products/{product_id}/reviews","title":"List product reviews","href":"/api-reference/marketplace/list-all-product-reviews"},{"openapi":"post /catalog/marketplace/products/{product_id}/reviews","title":null,"href":"/api-reference/marketplace/create-product-review"},{"openapi":"get /catalog/marketplace/products/similar","title":"Retrieve similar products","href":"/api-reference/marketplace/retrieve-similar-products"},{"openapi":"get /catalog/marketplace/products/up-sell","title":"Retrieve up-sell products","href":"/api-reference/marketplace/retrieve-up-sell-products"},{"openapi":"get /catalog/marketplace/products/cross-sell","title":"Retrieve cross-sell products","href":"/api-reference/marketplace/retrieve-cross-sell-products"},{"openapi":"post /catalog/marketplace/products/search","title":"Search products","href":"/api-reference/marketplace/search-products"}]},{"group":"Seller Management","icon":"user","pages":[{"openapi":"get /store/sellers/{id}","title":"Retrieve seller detail","href":"/api-reference/store/retrieve-seller-detail"},{"openapi":"get /store/sellers/{id}/reviews","title":"List seller reviews","href":"/api-reference/store/list-seller-reviews"}]}]}]},{"item":"POS API","icon":"cash-register","description":"Point of sale — staff login, device pairing, carts, catalog and order capture on the storefront base URL.","pages":[{"title":"POS API","href":"/api-reference/pos/overview"}]},{"item":"Webhooks","icon":"webhook","description":"Events Commerce Engine delivers to your endpoints — orders, payments, shipments, catalog, customers, store and marketplace.","pages":[{"title":"Webhooks","href":"/api-reference/webhooks/overview"}]},{"item":"Admin API","icon":"gear","description":"Back-office operations — catalog management, customers, fulfilment, store settings.","pages":[{"title":"Admin API","href":"/admin/api-reference/analytics/retrieve-analytics-chart-data"}]}]}]},"basePath":"","title":"Update a specific subscription - Commerce Engine Docs","buildId":"dpl_ATnXPMW25DMPUr9VBw6kL6MfBt6T","deploymentId":"dpl_ATnXPMW25DMPUr9VBw6kL6MfBt6T","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CNqlzjVB.js","utils-BqFiXZ79.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CnR4QBe6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BY2ZM1OO.js","snippetPresets-x-8ACO8V.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CTxrMSpo.js","ApiExamples-Ch-SJE05.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CqqG_0NE.js","shallow-BXrZ2b0C.js","getApiPlaygroundDisplay-n7J_wkjq.js","CodeSnippet-CQsp4vyQ.js","CodeSnippets-BfuHqvZx.js","getPastedJson-BjrGIK1i.js","icon-7iLZnVOC.js","MethodPill-TBS1m84e.js","DuplicateIcon-BNMrV4Vs.js","createIcon-C5kCqeU2.js","DynamicMarkdown-Bq09mRwR.js","SectionHeading-G4Bflf5Q.js","axios-vUo_bRtp.js","Markdown-BTUds0aX.js","clsx-6wHzaN2_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BPypQKlo.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-o6bee4ro.js"]}