{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Spree Commerce documentation","description":"Spree Commerce is an open-source headless commerce platform. The backend runs as a Docker image (ghcr.io/spree/spree) and exposes REST Store and Admin APIs with OpenAPI specs, TypeScript SDKs (@spree/sdk, @spree/admin-sdk), webhooks and an MCP server with read and write tools, plus a React admin dashboard, a Next.js storefront, B2B and wholesale (companies, customer-specific catalogs and price lists) and a built-in multi-vendor marketplace. Start with `npx create-spree-app@latest my-store`: you need only Node.js, Git and Docker.","colors":{"primary":"#0077ff","light":"#4d9fff","dark":"#0060ce"},"logo":{"light":"https://mintcdn.com/spreecommerce/LxcAXa2TB_svesfi/logo/logo_light.png?fit=max\u0026auto=format\u0026n=LxcAXa2TB_svesfi\u0026q=85\u0026s=fccc5873d5c7a3eeb4e644f96d694ba9","dark":"https://mintcdn.com/spreecommerce/LxcAXa2TB_svesfi/logo/logo_dark.png?fit=max\u0026auto=format\u0026n=LxcAXa2TB_svesfi\u0026q=85\u0026s=3aeefb84d53af450ad04b7283e4d661b"},"favicon":"https://mintcdn.com/spreecommerce/OgdQHBPQ0RbaKyDN/favicon.png?fit=max\u0026auto=format\u0026n=OgdQHBPQ0RbaKyDN\u0026q=85\u0026s=dc14ac5e60560349252428b1dde69c74","api":{"openapi":["api-reference/store.yaml","api-reference/storefront.yaml","api-reference/platform.yaml"],"examples":{"languages":["javascript","curl"]},"mdx":{"server":["http://localhost:3000"]}},"navbar":{"links":[{"icon":{"name":"github","library":"lucide"},"href":"https://github.com/spree/spree","label":"16k"},{"icon":{"name":"discord","library":"lucide"},"href":"https://discord.spreecommerce.org","label":"Join Discord"}],"primary":{"type":"button","label":"Try Sandbox","href":"https://spree.sh"}},"footer":{"socials":{"github":"https://github.com/spree/spree","x":"https://x.com/spreecommerce"}},"seo":{"metatags":{"og:locale":"en_US","twitter:site":"@spreecommerce"}},"fonts":{"heading":{"family":"Geist"},"body":{"family":"Geist"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":"night-owl"},"latex":true},"integrations":{"ga4":{"measurementId":"G-NCVLCVHL5Y"}},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spreecommerce","hasAudioNarration":false,"actualSubdomain":"spreecommerce","customDomains":["spreecommerce.org"],"gitSource":{"type":"github","owner":"spree","repo":"spree","deployBranch":"main","contentDirectory":"docs","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afca703626ed629eb0957a0","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API Reference","count":1139},{"language":"default","tag":"Endpoints","count":804},{"language":"default","tag":"Admin API","count":560},{"language":"default","tag":"Legacy API v2","count":313},{"language":"default","tag":"Platform API","count":231},{"language":"default","tag":"Documentation","count":175},{"language":"default","tag":"Develop","count":175},{"language":"default","tag":"User Guide","count":155},{"language":"default","tag":"Seller API","count":141},{"language":"default","tag":"Store API","count":130}]},"assistantConfig":{"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"deflection":{"enabled":true,"type":"link","email":"hello@spreecommerce.org","url":"https://github.com/spree/spree/issues/new/choose","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--spree-accent: #0077ff;--spree-accent-strong: #0060ce;--spree-sand-50: #fcfaf7;--spree-sand-100: #f7f5f2;--spree-sand-150: #e9e5dd;--spree-sand-200: #e2dfd8;--spree-dark-sand-500: #32302e;--spree-dark-sand-600: #272626;--spree-dark-sand-700: #1e1c1b;--spree-dark-sand-800: #191818;--spree-neutral-100: #eaeaea;--spree-neutral-200: #d5d5d5;--spree-neutral-400: #999999;--spree-neutral-600: #666666;--spree-neutral-700: #4d4d4d;--spree-neutral-900: #1a1a1a;--spree-ink: #1a1a1a;--spree-heading: #061932;--spree-ink-muted: #666666;--spree-border: #e2dfd8;--spree-sidebar-hover: rgb(0 0 0 / 0.04);--spree-sidebar-active: rgb(0 0 0 / 0.06);--spree-sidebar-radius: 0.625rem;--spree-guide: #d8d4cb}.dark{--spree-sidebar-hover: rgb(255 255 255 / 0.06);--spree-sidebar-active: rgb(255 255 255 / 0.10);--spree-border: #3f3e3c;--spree-guide: #3f3e3c}html:not(.dark) body{background:var(--spree-sand-50)}html.dark body{background:var(--spree-dark-sand-800)}html:not(.dark) h1,html:not(.dark) h2,html:not(.dark) h3,html:not(.dark) h4{color:var(--spree-heading)}.nav-logo{height:32px}#sidebar-content .sidebar-group-header{display:none}#sidebar-content a,#sidebar-content button:not([class*=\"group/search\"]){border-radius:var(--spree-sidebar-radius)!important;padding-top:0.3125rem!important;padding-bottom:0.3125rem!important}#sidebar-content ul.sidebar-group>li>button,#sidebar-content ul.sidebar-group>li>a{font-weight:500;padding-top:0.5rem!important;padding-bottom:0.5rem!important}#sidebar-content ul.sidebar-group>li+li{margin-top:0.25rem}#sidebar-content li[data-group-tag]>ul{margin-top:0.125rem;margin-bottom:0.375rem}#sidebar-content a:hover,#sidebar-content button:not([class*=\"group/search\"]):hover{background-color:var(--spree-sidebar-hover)!important}#sidebar-content li[data-group-tag][data-active=\"true\"]>button,#sidebar-content li[data-group-tag][data-active=\"true\"]>a{background-color:var(--spree-sidebar-active)!important;color:var(--spree-neutral-900)!important;font-weight:600!important}.dark #sidebar-content li[data-group-tag][data-active=\"true\"]>button,.dark #sidebar-content li[data-group-tag][data-active=\"true\"]>a{color:#ffffff!important}#sidebar-content a[class*=\"bg-primary/10\"],#sidebar-content a[class*=\"bg-primary-light/10\"]{background-color:transparent!important;color:var(--spree-neutral-900)!important;font-weight:600!important;text-shadow:none!important}.dark #sidebar-content a[class*=\"bg-primary/10\"],.dark #sidebar-content a[class*=\"bg-primary-light/10\"]{color:#ffffff!important}#sidebar-content a[class*=\"bg-primary/10\"]:hover,#sidebar-content a[class*=\"bg-primary-light/10\"]:hover{background-color:var(--spree-sidebar-hover)!important}#sidebar-content ul:not(.sidebar-group)>li>a,#sidebar-content ul:not(.sidebar-group)>li>button{padding-left:0.5rem!important;margin-left:2.25rem;margin-right:0.25rem;width:calc(100% - 2.5rem)!important}#sidebar-content ul:not(.sidebar-group) ul:not(.sidebar-group)>li>a,#sidebar-content ul:not(.sidebar-group) ul:not(.sidebar-group)>li>button{padding-left:0.5rem!important;margin-left:3.75rem;width:calc(100% - 4rem)!important}#sidebar-content li[data-group-tag]>ul{position:relative}#sidebar-content li[data-group-tag]>ul::before{content:\"\";position:absolute;left:1.75rem;top:0;bottom:0;width:1px;background-color:var(--spree-guide)}#sidebar-content li[data-group-tag] li[data-group-tag]>ul::before{left:3.25rem}#sidebar-content button svg[class*=\"bg-gray-\"],#sidebar-content a svg[class*=\"bg-gray-\"]{background-color:currentColor!important;opacity:0.6}#sidebar-content button:hover svg[class*=\"bg-gray-\"],#sidebar-content a:hover svg[class*=\"bg-gray-\"],#sidebar-content li[data-group-tag][data-active=\"true\"]>button svg[class*=\"bg-gray-\"]{opacity:1}#content-container{border-color:var(--spree-border)!important}.dark #content-container{border-color:#3f3e3c!important}@media (min-width: 1024px){#content-container{padding-left:3rem!important;padding-right:3rem!important}#content-container>.flex.flex-row-reverse{padding-left:0!important;column-gap:2.5rem!important}}#content-container #content-area{flex:1 1 0%;max-width:60rem}#content-container #content-area:has(.home-page){max-width:none}#almond-background-color{background-color:transparent!important}#navbar{background-color:var(--spree-sand-50)}.dark #navbar{background-color:var(--spree-dark-sand-800)}#navbar.is-custom{border-bottom:1px solid var(--spree-border)}.dark #navbar.is-custom{border-bottom-color:#3f3e3c}#navbar>.absolute.inset-0{display:none}.home-band{background:#ffffff}.dark .home-band{background:var(--spree-dark-sand-700)}.home-band-end{border-bottom:1px solid rgb(233 229 221 / 0.8)}.dark .home-band-end{border-bottom-color:#3f3e3c}#content-container .link{border-bottom:0!important;color:var(--spree-accent)!important;text-decoration:none!important}#content-container .link:hover{color:var(--spree-accent-strong)!important}#content-container [data-callout-type] .link{font-weight:500;text-decoration:underline!important;text-decoration-thickness:1px!important;text-underline-offset:3px!important}.dark #content-container .link{color:#4d9fff!important}.dark #content-container .link:hover{color:#7fb8ff!important}#content-area:has(.home-page)>#header{display:none}#content-container .home-plain.link,.dark #content-container .home-plain.link{color:inherit!important}:has(>.changelog-header){max-width:56rem;margin:0 auto;padding:4rem 1.25rem 6rem}.changelog-header h1{font-size:2.25rem;font-weight:600;letter-spacing:-0.02em;margin-bottom:0.75rem}.changelog-header>p,.changelog-header>[data-as=\"p\"]{color:var(--spree-ink-muted);font-size:1.0625rem;margin-bottom:1.25rem}.changelog-header .changelog-rss{display:inline-flex;align-items:center;gap:0.5rem;margin-bottom:3.5rem;padding:0.375rem 0.875rem;border:1px solid var(--spree-border);border-radius:9999px;font-size:0.875rem;font-weight:500;text-decoration:none}.changelog-header .changelog-rss:hover{border-color:var(--spree-accent)}:has(>.changelog-header) p,:has(>.changelog-header) [data-as=\"p\"]{display:block!important;margin:0 0 1rem;line-height:1.7}:has(>.changelog-header) ul{list-style:disc;padding-left:1.25rem;margin:0 0 1rem}:has(>.changelog-header) li{margin:0.25rem 0;line-height:1.65}:has(>.changelog-header) li::marker{color:var(--spree-neutral-400)}:has(>.changelog-header) a{color:var(--spree-accent)}:has(>.changelog-header) a:hover{color:var(--spree-accent-strong)}.dark :has(>.changelog-header) a{color:#4d9fff}table{border:1px solid #d0d7de!important;border-radius:0.5rem!important;border-collapse:separate!important;border-spacing:0!important;overflow:hidden!important;width:100%}table thead{background-color:#f3f4f6!important}table th{font-weight:500!important;text-align:left;color:#4b5563!important;padding:0.625rem 0.875rem!important;border-bottom:1px solid #d0d7de!important}table th+th,table td+td{border-left:1px solid #e8ebee!important}table td{padding:0.75rem 0.875rem!important;border-bottom:1px solid #e8ebee!important;vertical-align:middle}table tbody tr:last-child td{border-bottom:0!important}.dark table{border-color:#3d444d!important}.dark table thead{background-color:#21262d!important}.dark table th{color:#9198a1!important;border-bottom-color:#3d444d!important}.dark table th+th,.dark table td+td{border-left-color:#2a3038!important}.dark table td{border-bottom-color:#2a3038!important}"}],"page":{"pagePath":"api-reference/store-api/customers/get-payment-setup-session","slug":"/api-reference/store-api/customers/get-payment-setup-session","pageMetadata":{"title":"Get payment setup session","description":"Returns a payment setup session with its current status and provider data.","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/payment_setup_sessions/{id}","href":"/api-reference/store-api/customers/get-payment-setup-session","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns a payment setup session with its current status and provider data.\"\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":"night-owl"},"config":{},"pageMetadata":{"title":"Get payment setup session","description":"Returns a payment setup session with its current status and provider data.","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/payment_setup_sessions/{id}","href":"/api-reference/store-api/customers/get-payment-setup-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get payment setup session","tags":["Customers"],"security":["90369223-90db-4401-acae-de14ab870f2e"],"description":"Returns a payment setup session with its current status and provider data.","x-codeSamples":[{"lang":"javascript","label":"Spree SDK","source":"import { createClient } from '@spree/sdk'\n\nconst client = createClient({\n baseUrl: 'https://your-store.com',\n publishableKey: '\u003capi-key>',\n})\n\nconst session = await client.customer.paymentSetupSessions.get('pss_abc123', {\n token: '\u003ctoken>',\n})"}],"responses":{"200":"f16117b9-e8a5-48c2-90c7-aa4f3f2f2e2d","404":"7e411723-964e-49ab-ae9a-aab8e84b3222"},"method":"get","type":"path","servers":["96b14e68-da15-4b24-afb5-1e9670143805"],"path":"/api/v3/store/customers/me/payment_setup_sessions/{id}","baseUrlOptions":["http://{defaultHost}"],"title":"Get payment setup session","codeSamples":[{"label":"Spree SDK","lang":"javascript","source":"import { createClient } from '@spree/sdk'\n\nconst client = createClient({\n baseUrl: 'https://your-store.com',\n publishableKey: '\u003capi-key>',\n})\n\nconst session = await client.customer.paymentSetupSessions.get('pss_abc123', {\n token: '\u003ctoken>',\n})"}],"requestExampleLanguages":["javascript","bash"],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"6dfe1828-176c-4d7b-ad60-cc3b452b089f":{"name":"x-spree-api-key","in":"header","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"f29575d7-9a11-44b7-8d8b-343316e83cbd":{"name":"Authorization","in":"header","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"6d41cdb6-8e4f-40d3-8e8b-a9da457847e1":{"name":"id","in":"path","required":true,"description":"Payment setup session ID","schema":{"type":"string","isRequired":true,"description":"Payment setup session ID","uniqueKey":"","typeLabel":"string"}}},"responses":{"f16117b9-e8a5-48c2-90c7-aa4f3f2f2e2d":{"description":"payment setup session found","content":{"application/json":{"example":{"id":"pss_UkLWZg9DAJ","status":"pending","external_id":"seti_test_469ea499603a54b5a5f4b192","external_client_secret":"seti_secret_ee50fe0dfcb78f21eabebb03","external_data":{"client_secret":"secret_123"},"payment_method_id":"pm_UkLWZg9DAJ","payment_source_id":null,"payment_source_type":null,"customer_id":"cust_UkLWZg9DAJ","payment_method":{"id":"pm_UkLWZg9DAJ","name":"Credit Card 244","description":null,"type":"bogus","session_required":true,"source_required":true}},"schema":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"status":{"oneOf":[{"type":"string","description":"The values listed are the built-in ones; extensions may add more.","enum":["pending","processing","completed","failed","canceled","expired"],"isRequired":true,"uniqueKey":"status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"string","description":"The values listed are the built-in ones; extensions may add more.","isRequired":true,"uniqueKey":"status.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring> | string"},"external_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"external_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"external_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"external_id","typeLabel":"string | null"},"external_client_secret":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"external_client_secret.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"external_client_secret.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"external_client_secret","typeLabel":"string | null"},"external_data":{"type":"object","isRequired":true,"uniqueKey":"external_data","typeLabel":"object"},"payment_method_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payment_method_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payment_method_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment_method_id","typeLabel":"string | null"},"payment_source_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payment_source_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payment_source_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment_source_id","typeLabel":"string | null"},"payment_source_type":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payment_source_type.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payment_source_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment_source_type","typeLabel":"string | null"},"customer_id":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"customer_id.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"customer_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"customer_id","typeLabel":"string | null"},"payment_method":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"payment_method.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"payment_method.name","typeLabel":"string"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"payment_method.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"payment_method.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"payment_method.description","typeLabel":"string | null"},"type":{"type":"string","description":"Payment method type. Built-in: check, store_credit, custom_payment_source_method, bogus (test only); payment provider gems register their own, for example stripe.","isRequired":true,"uniqueKey":"payment_method.type","typeLabel":"string"},"session_required":{"type":"boolean","isRequired":true,"uniqueKey":"payment_method.session_required","typeLabel":"boolean"},"source_required":{"type":"boolean","isRequired":true,"uniqueKey":"payment_method.source_required","typeLabel":"boolean"},"custom_fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"payment_method.custom_fields.items.[INDEX].id","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"payment_method.custom_fields.items.[INDEX].label","typeLabel":"string"},"field_type":{"type":"string","enum":["short_text","long_text","rich_text","number","boolean","json"],"isRequired":true,"uniqueKey":"payment_method.custom_fields.items.[INDEX].field_type","typeLabel":"enum\u003cstring>"},"key":{"type":"string","isRequired":true,"uniqueKey":"payment_method.custom_fields.items.[INDEX].key","typeLabel":"string"},"value":{"oneOf":[{"isRequired":true}],"isRequired":true,"uniqueKey":"payment_method.custom_fields.items.[INDEX].value","typeLabel":"any"}},"required":["id","label","field_type","key","value"],"x-typelizer":true,"uniqueKey":"payment_method.custom_fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"payment_method.custom_fields","typeLabel":"object[]"}},"required":["id","name","description","type","session_required","source_required"],"x-typelizer":true,"isRequired":true,"uniqueKey":"payment_method","typeLabel":"object"}},"required":["id","status","external_id","external_client_secret","external_data","payment_method_id","payment_source_id","payment_source_type","customer_id","payment_method"],"x-typelizer":true,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"pss_UkLWZg9DAJ","status":"pending","external_id":"seti_test_469ea499603a54b5a5f4b192","external_client_secret":"seti_secret_ee50fe0dfcb78f21eabebb03","external_data":{"client_secret":"secret_123"},"payment_method_id":"pm_UkLWZg9DAJ","payment_source_id":null,"payment_source_type":null,"customer_id":"cust_UkLWZg9DAJ","payment_method":{"id":"pm_UkLWZg9DAJ","name":"Credit Card 244","description":null,"type":"bogus","session_required":true,"source_required":true}}}},"exampleType":"examples"}},"exampleType":"examples"},"7e411723-964e-49ab-ae9a-aab8e84b3222":{"description":"payment setup session not found","content":{"application/json":{"example":{"error":{"code":"record_not_found","message":"Payment setup session not found"}},"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"record_not_found","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","example":"Record not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"object","description":"Field-specific validation errors","example":{"name":["is too short","is required"],"email":["is invalid"]},"uniqueKey":"error.details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Field-specific validation errors","example":{"name":["is too short","is required"],"email":["is invalid"]},"uniqueKey":"error.details.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.details","typeLabel":"object | null"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"example":{"error":{"code":"validation_error","message":"Validation failed","details":{"name":["is too short"],"email":["is invalid"]}}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"record_not_found","message":"Payment setup session not found"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"90369223-90db-4401-acae-de14ab870f2e":{"api_key":{"type":"apiKey","name":"x-spree-api-key","in":"header","description":"Publishable API key for store access","scopes":[],"schemeName":"api_key"},"bearer_auth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token for authenticated customers","scopes":[],"schemeName":"bearer_auth"}}},"servers":{"96b14e68-da15-4b24-afb5-1e9670143805":{"url":"http://{defaultHost}","variables":{"defaultHost":{"default":"localhost:3000"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-spree-api-key","in":"header","description":"Publishable API key for store access","scopes":[],"schemeName":"api_key"},"schema":{"title":"x-spree-api-key","type":"string","description":"Publishable API key for store access","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_key","name":"x-spree-api-key"},{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"JWT token for authenticated customers","scopes":[],"schemeName":"bearer_auth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"JWT token for authenticated customers","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer_auth","name":"Authorization"}],"title":"api_key \u0026 bearer_auth"}]},"originalFileLocation":"api-reference/store.yaml"},"subdomain":"spreecommerce","siteName":"Spree Commerce documentation","title":"Get payment setup session - Spree Commerce documentation","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{"v6.x":{"href":"/api-reference/store-api/customers/get-payment-setup-session","matchLevel":0},"v5.x":{"href":"/api-reference/store-api/customers/get-payment-setup-session","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T11:08:57.181Z","originalFileLocation":"api-reference/store-api/customers/get-payment-setup-session.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=\"Returns a payment setup session with its current status and provider data.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Spree Commerce documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_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/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/spreecommerce/jEa7SqO24dLQoV2O/_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/spreecommerce/jEa7SqO24dLQoV2O/_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/spreecommerce/jEa7SqO24dLQoV2O/_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/spreecommerce/jEa7SqO24dLQoV2O/_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/spreecommerce/jEa7SqO24dLQoV2O/_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/spreecommerce/jEa7SqO24dLQoV2O/_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/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get payment setup session - Spree Commerce documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a payment setup session with its current status and provider data.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spree Commerce documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://spreecommerce.org/docs/api-reference/store-api/customers/get-payment-setup-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spreecommerce.mintlify.site/docs/_mintlify/api/og/v2?division=Customers\u0026amp;title=Get+payment+setup+session\u0026amp;description=Returns+a+payment+setup+session+with+its+current+status+and+provider+data.\u0026amp;theme=8c24de7a8ebea5707d8d356e\u0026amp;signature=c7e53eed43d1199a330dd7f4d21f3303e5895986aef05580fd0038bf41269ed7\">\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=\"Get payment setup session - Spree Commerce documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a payment setup session with its current status and provider data.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spreecommerce.mintlify.site/docs/_mintlify/api/og/v2?division=Customers\u0026amp;title=Get+payment+setup+session\u0026amp;description=Returns+a+payment+setup+session+with+its+current+status+and+provider+data.\u0026amp;theme=8c24de7a8ebea5707d8d356e\u0026amp;signature=c7e53eed43d1199a330dd7f4d21f3303e5895986aef05580fd0038bf41269ed7\">\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/spreecommerce/jEa7SqO24dLQoV2O/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Spree Commerce documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0077ff\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003clink data-mint-head rel=\"canonical\" href=\"https://spreecommerce.org/docs/api-reference/store-api/customers/get-payment-setup-session\">\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/store-api/customers/get-payment-setup-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://spreecommerce.org/#organization\",\"name\":\"Spree Commerce documentation\",\"url\":\"https://spreecommerce.org\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spreecommerce/LxcAXa2TB_svesfi/logo/logo_light.png?fit=max\u0026auto=format\u0026n=LxcAXa2TB_svesfi\u0026q=85\u0026s=fccc5873d5c7a3eeb4e644f96d694ba9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://spreecommerce.org/docs#website\",\"name\":\"Spree Commerce documentation\",\"url\":\"https://spreecommerce.org/docs\",\"publisher\":{\"@id\":\"https://spreecommerce.org/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://spreecommerce.org/docs/api-reference/store-api/customers/get-payment-setup-session#webpage\",\"url\":\"https://spreecommerce.org/docs/api-reference/store-api/customers/get-payment-setup-session\",\"name\":\"Get payment setup session\",\"description\":\"Returns a payment setup session with its current status and provider data.\",\"dateModified\":\"2026-11-17T11:08:57.181Z\",\"isPartOf\":{\"@id\":\"https://spreecommerce.org/docs#website\"},\"breadcrumb\":{\"@id\":\"https://spreecommerce.org/docs/api-reference/store-api/customers/get-payment-setup-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://spreecommerce.org/docs/api-reference/store-api/customers/get-payment-setup-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://spreecommerce.org/docs/api-reference/store-api/authentication/login\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customers\",\"item\":\"https://spreecommerce.org/docs/api-reference/store-api/customers/list-customer-addresses\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get payment setup session\",\"item\":\"https://spreecommerce.org/docs/api-reference/store-api/customers/get-payment-setup-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://spreecommerce.org/docs/api-reference/store-api/customers/get-payment-setup-session#apireference\",\"headline\":\"Get payment setup session\",\"name\":\"Get payment setup session\",\"description\":\"Returns a payment setup session with its current status and provider data.\",\"url\":\"https://spreecommerce.org/docs/api-reference/store-api/customers/get-payment-setup-session\",\"mainEntityOfPage\":{\"@id\":\"https://spreecommerce.org/docs/api-reference/store-api/customers/get-payment-setup-session#webpage\"},\"dateModified\":\"2026-11-17T11:08:57.181Z\",\"publisher\":{\"@id\":\"https://spreecommerce.org/#organization\"},\"isPartOf\":{\"@id\":\"https://spreecommerce.org/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Spree Commerce documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Spree Commerce documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/store-api/customers/get-payment-setup-session.md","siteName":"Spree Commerce documentation","nav":{"global":null,"versions":[{"version":"v6.x","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API Reference","menu":[{"item":"Store API","icon":"store","description":"REST API for storefronts and custom integrations","groups":[{"group":"API basics","pages":[{"title":"Store API","sidebarTitle":"Introduction","href":"/api-reference/store-api/introduction"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/api-reference/store-api/authentication"},{"title":"Errors","href":"/api-reference/store-api/errors"},{"title":"Idempotency","sidebarTitle":"Idempotency","href":"/api-reference/store-api/idempotency"},{"title":"Rate Limiting","sidebarTitle":"Rate Limiting","href":"/api-reference/store-api/rate-limitting"},{"title":"Querying","sidebarTitle":"Querying","href":"/api-reference/store-api/querying"},{"title":"Relations","sidebarTitle":"Relations","href":"/api-reference/store-api/relations"},{"title":"Metadata","sidebarTitle":"Metadata","href":"/api-reference/store-api/metadata"},{"title":"Localization","sidebarTitle":"Localization","href":"/api-reference/store-api/localization"},{"title":"Monetary Amounts","sidebarTitle":"Monetary Amounts","href":"/api-reference/store-api/monetary-amounts"},{"title":"Migrating from Storefront API v2","sidebarTitle":"Migrating from v2","href":"/api-reference/store-api/migrating-from-storefront-api-v2"}]},{"group":"Endpoints","pages":[{"group":"Authentication","pages":[{"title":"Login","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/auth/login","href":"/api-reference/store-api/authentication/login"},{"title":"Refresh token","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/auth/refresh","href":"/api-reference/store-api/authentication/refresh-token"},{"title":"Logout","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/auth/logout","href":"/api-reference/store-api/authentication/logout"},{"title":"Request a password reset","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/password_resets","href":"/api-reference/store-api/authentication/request-a-password-reset"},{"title":"Reset password with token","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/password_resets/{token}","href":"/api-reference/store-api/authentication/reset-password-with-token"}]},{"group":"Carts","pages":[{"title":"List addresses this cart may use","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/carts/{cart_id}/addresses","href":"/api-reference/store-api/carts/list-addresses-this-cart-may-use"},{"title":"Upload a purchase order document","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/po_document","href":"/api-reference/store-api/carts/upload-a-purchase-order-document"},{"title":"Set the cart tax identifier","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{cart_id}/tax_identifier","href":"/api-reference/store-api/carts/set-the-cart-tax-identifier"},{"title":"List active carts","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/carts","href":"/api-reference/store-api/carts/list-active-carts"},{"title":"Create a new cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts","href":"/api-reference/store-api/carts/create-a-new-cart"},{"title":"Get a cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/carts/{id}","href":"/api-reference/store-api/carts/get-a-cart"},{"title":"Delete a cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/carts/{id}","href":"/api-reference/store-api/carts/delete-a-cart"},{"title":"Update a cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{id}","href":"/api-reference/store-api/carts/update-a-cart"},{"title":"Associate guest cart with authenticated user","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{id}/associate","href":"/api-reference/store-api/carts/associate-guest-cart-with-authenticated-user"},{"title":"Complete cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{id}/complete","href":"/api-reference/store-api/carts/complete-cart"},{"title":"Apply discount code","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/discount_codes","href":"/api-reference/store-api/carts/apply-discount-code"},{"title":"Remove discount code","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/carts/{cart_id}/discount_codes/{id}","href":"/api-reference/store-api/carts/remove-discount-code"},{"title":"Select delivery rate for fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{cart_id}/fulfillments/{id}","href":"/api-reference/store-api/carts/select-delivery-rate-for-fulfillment"},{"title":"Apply gift card","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/gift_cards","href":"/api-reference/store-api/carts/apply-gift-card"},{"title":"Remove gift card","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/carts/{cart_id}/gift_cards/{id}","href":"/api-reference/store-api/carts/remove-gift-card"},{"title":"Add item to cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/items","href":"/api-reference/store-api/carts/add-item-to-cart"},{"title":"Remove line item from cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/carts/{cart_id}/items/{id}","href":"/api-reference/store-api/carts/remove-line-item-from-cart"},{"title":"Update line item quantity","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{cart_id}/items/{id}","href":"/api-reference/store-api/carts/update-line-item-quantity"},{"title":"Create payment session","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/payment_sessions","href":"/api-reference/store-api/carts/create-payment-session"},{"title":"Get payment session","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/carts/{cart_id}/payment_sessions/{id}","href":"/api-reference/store-api/carts/get-payment-session"},{"title":"Update payment session","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{cart_id}/payment_sessions/{id}","href":"/api-reference/store-api/carts/update-payment-session"},{"title":"Complete payment session","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{cart_id}/payment_sessions/{id}/complete","href":"/api-reference/store-api/carts/complete-payment-session"},{"title":"Create payment","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/payments","href":"/api-reference/store-api/carts/create-payment"},{"title":"Apply store credit","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/store_credits","href":"/api-reference/store-api/carts/apply-store-credit"},{"title":"Remove store credit","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/carts/{cart_id}/store_credits","href":"/api-reference/store-api/carts/remove-store-credit"}]},{"group":"Channel","pages":[{"title":"Get the current channel","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/channel","href":"/api-reference/store-api/channel/get-the-current-channel"}]},{"group":"Companies","pages":[{"title":"List my company memberships","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/account/companies","href":"/api-reference/store-api/companies/list-my-company-memberships"},{"title":"Get a company node","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/companies/{id}","href":"/api-reference/store-api/companies/get-a-company-node"},{"title":"Update a company node","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/companies/{id}","href":"/api-reference/store-api/companies/update-a-company-node"},{"title":"List company members","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/companies/{company_id}/members","href":"/api-reference/store-api/companies/list-company-members"},{"title":"Add a member by email","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/companies/{company_id}/members","href":"/api-reference/store-api/companies/add-a-member-by-email"},{"title":"List pending company invitations","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/companies/{company_id}/invitations","href":"/api-reference/store-api/companies/list-pending-company-invitations"},{"title":"List the company address book","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/companies/{company_id}/addresses","href":"/api-reference/store-api/companies/list-the-company-address-book"},{"title":"Add an address book entry","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/companies/{company_id}/addresses","href":"/api-reference/store-api/companies/add-an-address-book-entry"},{"title":"Remove an address book entry","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/companies/{company_id}/addresses/{id}","href":"/api-reference/store-api/companies/remove-an-address-book-entry"},{"title":"Update an address book entry","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/companies/{company_id}/addresses/{id}","href":"/api-reference/store-api/companies/update-an-address-book-entry"},{"title":"Revoke an invitation","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/companies/{company_id}/invitations/{id}","href":"/api-reference/store-api/companies/revoke-an-invitation"},{"title":"List the company purchases","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/companies/{company_id}/orders","href":"/api-reference/store-api/companies/list-the-company-purchases"},{"title":"Look up an invitation","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/company_invitations/{token}","href":"/api-reference/store-api/companies/look-up-an-invitation"},{"title":"Accept an invitation","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/company_invitations/{token}/accept","href":"/api-reference/store-api/companies/accept-an-invitation"}]},{"group":"Customers","pages":[{"title":"List customer addresses","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/addresses","href":"/api-reference/store-api/customers/list-customer-addresses"},{"title":"Create an address","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/customers/me/addresses","href":"/api-reference/store-api/customers/create-an-address"},{"title":"Get an address","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/addresses/{id}","href":"/api-reference/store-api/customers/get-an-address"},{"title":"Delete an address","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/customers/me/addresses/{id}","href":"/api-reference/store-api/customers/delete-an-address"},{"title":"Update an address","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/customers/me/addresses/{id}","href":"/api-reference/store-api/customers/update-an-address"},{"title":"List saved credit cards","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/credit_cards","href":"/api-reference/store-api/customers/list-saved-credit-cards"},{"title":"Get a credit card","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/credit_cards/{id}","href":"/api-reference/store-api/customers/get-a-credit-card"},{"title":"Delete a credit card","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/customers/me/credit_cards/{id}","href":"/api-reference/store-api/customers/delete-a-credit-card"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/orders","href":"/api-reference/store-api/customers/list-orders"},{"title":"Get an order","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/orders/{id}","href":"/api-reference/store-api/customers/get-an-order"},{"title":"Register a new customer","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/customers","href":"/api-reference/store-api/customers/register-a-new-customer"},{"title":"Get current customer profile","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me","href":"/api-reference/store-api/customers/get-current-customer-profile"},{"title":"Update current customer profile","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/customers/me","href":"/api-reference/store-api/customers/update-current-customer-profile"},{"title":"List data requests","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/data_requests","href":"/api-reference/store-api/customers/list-data-requests"},{"title":"Open a data request","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/customers/me/data_requests","href":"/api-reference/store-api/customers/open-a-data-request"},{"title":"Get a data request","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/data_requests/{id}","href":"/api-reference/store-api/customers/get-a-data-request"},{"title":"Get a data request by its confirmation token","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/data_requests/{token}","href":"/api-reference/store-api/customers/get-a-data-request-by-its-confirmation-token"},{"title":"Confirm a data request","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/data_requests/{token}/confirmation","href":"/api-reference/store-api/customers/confirm-a-data-request"},{"title":"List gift cards","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/gift_cards","href":"/api-reference/store-api/customers/list-gift-cards"},{"title":"Get a gift card","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/gift_cards/{id}","href":"/api-reference/store-api/customers/get-a-gift-card"},{"title":"Create payment setup session","description":"Creates a new payment setup session for saving a payment method for future use. Delegates to the payment gateway to initialize a provider-specific setup flow (e.g. Stripe SetupIntent, Adyen zero-auth tokenization).","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/customers/me/payment_setup_sessions","href":"/api-reference/store-api/customers/create-payment-setup-session"},{"title":"Get payment setup session","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/payment_setup_sessions/{id}","href":"/api-reference/store-api/customers/get-payment-setup-session"},{"title":"Complete payment setup session","description":"Completes a payment setup session by confirming the setup with the provider, resulting in a saved payment method.","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/customers/me/payment_setup_sessions/{id}/complete","href":"/api-reference/store-api/customers/complete-payment-setup-session"},{"title":"List store credits","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/store_credits","href":"/api-reference/store-api/customers/list-store-credits"},{"title":"Get a store credit","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/store_credits/{id}","href":"/api-reference/store-api/customers/get-a-store-credit"}]},{"group":"Delivery","pages":[{"title":"List delivery methods","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/delivery_methods","href":"/api-reference/store-api/delivery/list-delivery-methods"},{"title":"List pickup locations","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/delivery_methods/{id}/pickup_locations","href":"/api-reference/store-api/delivery/list-pickup-locations"}]},{"group":"Digital Links","pages":[{"title":"List my digital links","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/digital_links","href":"/api-reference/store-api/digital-links/list-my-digital-links"},{"title":"Download a digital product","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/digital_links/{token}","href":"/api-reference/store-api/digital-links/download-a-digital-product"}]},{"group":"Markets","pages":[{"title":"List countries","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/countries","href":"/api-reference/store-api/markets/list-countries"},{"title":"Get a country","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/countries/{iso}","href":"/api-reference/store-api/markets/get-a-country"},{"title":"List supported currencies","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/currencies","href":"/api-reference/store-api/markets/list-supported-currencies"},{"title":"List supported locales","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/locales","href":"/api-reference/store-api/markets/list-supported-locales"},{"title":"List markets","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/markets","href":"/api-reference/store-api/markets/list-markets"},{"title":"Get a market","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/markets/{id}","href":"/api-reference/store-api/markets/get-a-market"},{"title":"Resolve market by country","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/markets/resolve","href":"/api-reference/store-api/markets/resolve-market-by-country"},{"title":"List countries in a market","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/markets/{market_id}/countries","href":"/api-reference/store-api/markets/list-countries-in-a-market"},{"title":"Get a country in a market","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/markets/{market_id}/countries/{id}","href":"/api-reference/store-api/markets/get-a-country-in-a-market"}]},{"group":"Newsletter Subscribers","pages":[{"title":"Subscribe to the newsletter","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/newsletter_subscribers","href":"/api-reference/store-api/newsletter-subscribers/subscribe-to-the-newsletter"},{"title":"Verify a newsletter subscription","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/newsletter_subscribers/verify","href":"/api-reference/store-api/newsletter-subscribers/verify-a-newsletter-subscription"},{"title":"Unsubscribe from the newsletter","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/newsletter_subscribers/{id}","href":"/api-reference/store-api/newsletter-subscribers/unsubscribe-from-the-newsletter"},{"title":"Request an unsubscribe token","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/newsletter_subscribers/request_unsubscribe","href":"/api-reference/store-api/newsletter-subscribers/request-an-unsubscribe-token"}]},{"group":"Orders","pages":[{"title":"List claims","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/orders/{order_id}/claims","href":"/api-reference/store-api/orders/list-claims"},{"title":"Open a claim","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/orders/{order_id}/claims","href":"/api-reference/store-api/orders/open-a-claim"},{"title":"Get an order","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/orders/{id}","href":"/api-reference/store-api/orders/get-an-order"},{"title":"List returns","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/orders/{order_id}/returns","href":"/api-reference/store-api/orders/list-returns"},{"title":"Open a return","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/orders/{order_id}/returns","href":"/api-reference/store-api/orders/open-a-return"}]},{"group":"Policies","pages":[{"title":"List store policies","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/policies","href":"/api-reference/store-api/policies/list-store-policies"},{"title":"Get a policy","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/policies/{id}","href":"/api-reference/store-api/policies/get-a-policy"}]},{"group":"Product Catalog","pages":[{"title":"List categories","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/categories","href":"/api-reference/store-api/product-catalog/list-categories"},{"title":"Get a category","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/categories/{id}","href":"/api-reference/store-api/product-catalog/get-a-category"},{"title":"List collections","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/collections","href":"/api-reference/store-api/product-catalog/list-collections"},{"title":"Get a collection","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/collections/{id}","href":"/api-reference/store-api/product-catalog/get-a-collection"},{"title":"List collection products","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/collections/{collection_id}/products","href":"/api-reference/store-api/product-catalog/list-collection-products"},{"title":"List products","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/products","href":"/api-reference/store-api/product-catalog/list-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/products/{id}","href":"/api-reference/store-api/product-catalog/get-a-product"},{"title":"Get product filters","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/products/filters","href":"/api-reference/store-api/product-catalog/get-product-filters"}]},{"group":"Sellers","pages":[{"title":"List sellers","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/sellers","href":"/api-reference/store-api/sellers/list-sellers"},{"title":"Get a seller","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/sellers/{id}","href":"/api-reference/store-api/sellers/get-a-seller"}]},{"group":"Store","pages":[{"title":"Get the current store","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/store","href":"/api-reference/store-api/store/get-the-current-store"}]},{"group":"Wishlists","pages":[{"title":"List wishlists","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/wishlists","href":"/api-reference/store-api/wishlists/list-wishlists"},{"title":"Create a wishlist","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/wishlists","href":"/api-reference/store-api/wishlists/create-a-wishlist"},{"title":"Get a wishlist","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/wishlists/{id}","href":"/api-reference/store-api/wishlists/get-a-wishlist"},{"title":"Delete a wishlist","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/wishlists/{id}","href":"/api-reference/store-api/wishlists/delete-a-wishlist"},{"title":"Update a wishlist","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/wishlists/{id}","href":"/api-reference/store-api/wishlists/update-a-wishlist"},{"title":"Add item to wishlist","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/wishlists/{wishlist_id}/items","href":"/api-reference/store-api/wishlists/add-item-to-wishlist"},{"title":"Remove item from wishlist","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/wishlists/{wishlist_id}/items/{id}","href":"/api-reference/store-api/wishlists/remove-item-from-wishlist"},{"title":"Update a wishlist item","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/wishlists/{wishlist_id}/items/{id}","href":"/api-reference/store-api/wishlists/update-a-wishlist-item"}]}]}]},{"item":"Admin API","icon":"shield","description":"REST API for pragmatically managing stores","pages":[{"title":"Admin API","href":"/api-reference/admin-api/introduction"}]},{"item":"Seller API","icon":"handshake","description":"REST API for the marketplace seller panel","pages":[{"title":"Seller API","href":"/api-reference/seller-api/introduction"}]},{"item":"Webhooks","icon":"webhook","description":"Event payloads and delivery reference","pages":[{"title":"Webhooks","href":"/api-reference/webhooks-events"}]}]},{"tab":"User Guide","pages":[{"title":"User Guide","href":"/user/what-is-spree-commerce"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},{"version":"v5.x","tabs":[{"tab":"Guides","menu":[{"item":"Getting Started","icon":"rocket","description":"Quickstart guide and core concepts","pages":[{"title":"Getting Started","href":"/v5/developer/getting-started/quickstart"}]},{"item":"Building a Storefront","icon":"store","description":"Next.js, custom frontend, or Rails engine","pages":[{"title":"Building a Storefront","href":"/v5/developer/storefront/nextjs/quickstart"}]},{"item":"Use Cases","icon":"book-open","description":"Multi-store/multi-tenant, and marketplace setups","pages":[{"title":"Use Cases","href":"/v5/developer/multi-tenant/quickstart"}]}],"pages":[{"title":"Guides","href":"/v5/developer/getting-started/quickstart"}]},{"tab":"Framework","menu":[{"item":"Extending","icon":"puzzle","description":"Customize admin panel, API, and business logic","pages":[{"title":"Extending","href":"/v5/developer/tutorial/introduction"}]},{"item":"How-to Guides","icon":"book-open","description":"Step-by-step guides for common tasks","pages":[{"title":"How-to Guides","href":"/v5/developer/how-to/custom-order-routing"}]},{"item":"Operations","icon":"server","description":"Deploy, upgrade, and maintain your store","pages":[{"title":"Operations","href":"/v5/developer/deployment/quickstart"}]}],"pages":[{"title":"Framework","href":"/v5/developer/tutorial/introduction"}]},{"tab":"SDK \u0026 Tools","menu":[{"item":"Store SDK","icon":"code","description":"TypeScript SDK for the Store API","pages":[{"title":"Store SDK","href":"/v5/developer/sdk/quickstart"}]},{"item":"Admin SDK","icon":"shield-check","description":"TypeScript SDK for the Admin API","pages":[{"title":"Admin SDK","href":"/v5/developer/sdk/admin/quickstart"}]},{"item":"CLI","icon":"square-terminal","description":"Command-line interface for Spree","pages":[{"title":"CLI","href":"/v5/developer/cli/quickstart"}]},{"item":"create-spree-app","icon":"rocket","description":"Scaffold a new Spree project","pages":[{"title":"create-spree-app","href":"/v5/developer/create-spree-app/quickstart"}]},{"item":"Agentic Development","icon":"bot","description":"Build Spree with AI coding agents","pages":[{"title":"Agentic Development","href":"/v5/developer/agentic/overview"}]}],"pages":[{"title":"SDK \u0026 Tools","href":"/v5/developer/sdk/quickstart"}]},{"tab":"API Reference","menu":[{"item":"Store API","icon":"store","description":"REST API for storefronts and custom integrations","groups":[{"group":"API basics","pages":[{"title":"Store API","sidebarTitle":"Introduction","href":"/api-reference/store-api/introduction"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/api-reference/store-api/authentication"},{"title":"Errors","href":"/api-reference/store-api/errors"},{"title":"Idempotency","sidebarTitle":"Idempotency","href":"/api-reference/store-api/idempotency"},{"title":"Rate Limiting","sidebarTitle":"Rate Limiting","href":"/api-reference/store-api/rate-limitting"},{"title":"Querying","sidebarTitle":"Querying","href":"/api-reference/store-api/querying"},{"title":"Relations","sidebarTitle":"Relations","href":"/api-reference/store-api/relations"},{"title":"Metadata","sidebarTitle":"Metadata","href":"/api-reference/store-api/metadata"},{"title":"Localization","sidebarTitle":"Localization","href":"/api-reference/store-api/localization"},{"title":"Monetary Amounts","sidebarTitle":"Monetary Amounts","href":"/api-reference/store-api/monetary-amounts"},{"title":"Migrating from Storefront API v2","sidebarTitle":"Migrating from v2","href":"/api-reference/store-api/migrating-from-storefront-api-v2"}]},{"group":"Endpoints","pages":[{"group":"Authentication","pages":[{"title":"Login","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/auth/login","href":"/api-reference/store-api/authentication/login"},{"title":"Refresh token","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/auth/refresh","href":"/api-reference/store-api/authentication/refresh-token"},{"title":"Logout","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/auth/logout","href":"/api-reference/store-api/authentication/logout"},{"title":"Request a password reset","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/password_resets","href":"/api-reference/store-api/authentication/request-a-password-reset"},{"title":"Reset password with token","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/password_resets/{token}","href":"/api-reference/store-api/authentication/reset-password-with-token"}]},{"group":"Carts","pages":[{"title":"List addresses this cart may use","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/carts/{cart_id}/addresses","href":"/api-reference/store-api/carts/list-addresses-this-cart-may-use"},{"title":"Upload a purchase order document","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/po_document","href":"/api-reference/store-api/carts/upload-a-purchase-order-document"},{"title":"Set the cart tax identifier","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{cart_id}/tax_identifier","href":"/api-reference/store-api/carts/set-the-cart-tax-identifier"},{"title":"List active carts","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/carts","href":"/api-reference/store-api/carts/list-active-carts"},{"title":"Create a new cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts","href":"/api-reference/store-api/carts/create-a-new-cart"},{"title":"Get a cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/carts/{id}","href":"/api-reference/store-api/carts/get-a-cart"},{"title":"Delete a cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/carts/{id}","href":"/api-reference/store-api/carts/delete-a-cart"},{"title":"Update a cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{id}","href":"/api-reference/store-api/carts/update-a-cart"},{"title":"Associate guest cart with authenticated user","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{id}/associate","href":"/api-reference/store-api/carts/associate-guest-cart-with-authenticated-user"},{"title":"Complete cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{id}/complete","href":"/api-reference/store-api/carts/complete-cart"},{"title":"Apply discount code","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/discount_codes","href":"/api-reference/store-api/carts/apply-discount-code"},{"title":"Remove discount code","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/carts/{cart_id}/discount_codes/{id}","href":"/api-reference/store-api/carts/remove-discount-code"},{"title":"Select delivery rate for fulfillment","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{cart_id}/fulfillments/{id}","href":"/api-reference/store-api/carts/select-delivery-rate-for-fulfillment"},{"title":"Apply gift card","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/gift_cards","href":"/api-reference/store-api/carts/apply-gift-card"},{"title":"Remove gift card","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/carts/{cart_id}/gift_cards/{id}","href":"/api-reference/store-api/carts/remove-gift-card"},{"title":"Add item to cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/items","href":"/api-reference/store-api/carts/add-item-to-cart"},{"title":"Remove line item from cart","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/carts/{cart_id}/items/{id}","href":"/api-reference/store-api/carts/remove-line-item-from-cart"},{"title":"Update line item quantity","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{cart_id}/items/{id}","href":"/api-reference/store-api/carts/update-line-item-quantity"},{"title":"Create payment session","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/payment_sessions","href":"/api-reference/store-api/carts/create-payment-session"},{"title":"Get payment session","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/carts/{cart_id}/payment_sessions/{id}","href":"/api-reference/store-api/carts/get-payment-session"},{"title":"Update payment session","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{cart_id}/payment_sessions/{id}","href":"/api-reference/store-api/carts/update-payment-session"},{"title":"Complete payment session","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/carts/{cart_id}/payment_sessions/{id}/complete","href":"/api-reference/store-api/carts/complete-payment-session"},{"title":"Create payment","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/payments","href":"/api-reference/store-api/carts/create-payment"},{"title":"Apply store credit","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/carts/{cart_id}/store_credits","href":"/api-reference/store-api/carts/apply-store-credit"},{"title":"Remove store credit","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/carts/{cart_id}/store_credits","href":"/api-reference/store-api/carts/remove-store-credit"}]},{"group":"Channel","pages":[{"title":"Get the current channel","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/channel","href":"/api-reference/store-api/channel/get-the-current-channel"}]},{"group":"Companies","pages":[{"title":"List my company memberships","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/account/companies","href":"/api-reference/store-api/companies/list-my-company-memberships"},{"title":"Get a company node","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/companies/{id}","href":"/api-reference/store-api/companies/get-a-company-node"},{"title":"Update a company node","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/companies/{id}","href":"/api-reference/store-api/companies/update-a-company-node"},{"title":"List company members","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/companies/{company_id}/members","href":"/api-reference/store-api/companies/list-company-members"},{"title":"Add a member by email","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/companies/{company_id}/members","href":"/api-reference/store-api/companies/add-a-member-by-email"},{"title":"List pending company invitations","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/companies/{company_id}/invitations","href":"/api-reference/store-api/companies/list-pending-company-invitations"},{"title":"List the company address book","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/companies/{company_id}/addresses","href":"/api-reference/store-api/companies/list-the-company-address-book"},{"title":"Add an address book entry","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/companies/{company_id}/addresses","href":"/api-reference/store-api/companies/add-an-address-book-entry"},{"title":"Remove an address book entry","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/companies/{company_id}/addresses/{id}","href":"/api-reference/store-api/companies/remove-an-address-book-entry"},{"title":"Update an address book entry","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/companies/{company_id}/addresses/{id}","href":"/api-reference/store-api/companies/update-an-address-book-entry"},{"title":"Revoke an invitation","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/companies/{company_id}/invitations/{id}","href":"/api-reference/store-api/companies/revoke-an-invitation"},{"title":"List the company purchases","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/companies/{company_id}/orders","href":"/api-reference/store-api/companies/list-the-company-purchases"},{"title":"Look up an invitation","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/company_invitations/{token}","href":"/api-reference/store-api/companies/look-up-an-invitation"},{"title":"Accept an invitation","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/company_invitations/{token}/accept","href":"/api-reference/store-api/companies/accept-an-invitation"}]},{"group":"Customers","pages":[{"title":"List customer addresses","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/addresses","href":"/api-reference/store-api/customers/list-customer-addresses"},{"title":"Create an address","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/customers/me/addresses","href":"/api-reference/store-api/customers/create-an-address"},{"title":"Get an address","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/addresses/{id}","href":"/api-reference/store-api/customers/get-an-address"},{"title":"Delete an address","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/customers/me/addresses/{id}","href":"/api-reference/store-api/customers/delete-an-address"},{"title":"Update an address","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/customers/me/addresses/{id}","href":"/api-reference/store-api/customers/update-an-address"},{"title":"List saved credit cards","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/credit_cards","href":"/api-reference/store-api/customers/list-saved-credit-cards"},{"title":"Get a credit card","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/credit_cards/{id}","href":"/api-reference/store-api/customers/get-a-credit-card"},{"title":"Delete a credit card","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/customers/me/credit_cards/{id}","href":"/api-reference/store-api/customers/delete-a-credit-card"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/orders","href":"/api-reference/store-api/customers/list-orders"},{"title":"Get an order","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/orders/{id}","href":"/api-reference/store-api/customers/get-an-order"},{"title":"Register a new customer","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/customers","href":"/api-reference/store-api/customers/register-a-new-customer"},{"title":"Get current customer profile","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me","href":"/api-reference/store-api/customers/get-current-customer-profile"},{"title":"Update current customer profile","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/customers/me","href":"/api-reference/store-api/customers/update-current-customer-profile"},{"title":"List data requests","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/data_requests","href":"/api-reference/store-api/customers/list-data-requests"},{"title":"Open a data request","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/customers/me/data_requests","href":"/api-reference/store-api/customers/open-a-data-request"},{"title":"Get a data request","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/data_requests/{id}","href":"/api-reference/store-api/customers/get-a-data-request"},{"title":"Get a data request by its confirmation token","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/data_requests/{token}","href":"/api-reference/store-api/customers/get-a-data-request-by-its-confirmation-token"},{"title":"Confirm a data request","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/data_requests/{token}/confirmation","href":"/api-reference/store-api/customers/confirm-a-data-request"},{"title":"List gift cards","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/gift_cards","href":"/api-reference/store-api/customers/list-gift-cards"},{"title":"Get a gift card","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/gift_cards/{id}","href":"/api-reference/store-api/customers/get-a-gift-card"},{"title":"Create payment setup session","description":"Creates a new payment setup session for saving a payment method for future use. Delegates to the payment gateway to initialize a provider-specific setup flow (e.g. Stripe SetupIntent, Adyen zero-auth tokenization).","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/customers/me/payment_setup_sessions","href":"/api-reference/store-api/customers/create-payment-setup-session"},{"title":"Get payment setup session","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/payment_setup_sessions/{id}","href":"/api-reference/store-api/customers/get-payment-setup-session"},{"title":"Complete payment setup session","description":"Completes a payment setup session by confirming the setup with the provider, resulting in a saved payment method.","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/customers/me/payment_setup_sessions/{id}/complete","href":"/api-reference/store-api/customers/complete-payment-setup-session"},{"title":"List store credits","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/store_credits","href":"/api-reference/store-api/customers/list-store-credits"},{"title":"Get a store credit","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/store_credits/{id}","href":"/api-reference/store-api/customers/get-a-store-credit"}]},{"group":"Delivery","pages":[{"title":"List delivery methods","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/delivery_methods","href":"/api-reference/store-api/delivery/list-delivery-methods"},{"title":"List pickup locations","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/delivery_methods/{id}/pickup_locations","href":"/api-reference/store-api/delivery/list-pickup-locations"}]},{"group":"Digital Links","pages":[{"title":"List my digital links","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/customers/me/digital_links","href":"/api-reference/store-api/digital-links/list-my-digital-links"},{"title":"Download a digital product","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/digital_links/{token}","href":"/api-reference/store-api/digital-links/download-a-digital-product"}]},{"group":"Markets","pages":[{"title":"List countries","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/countries","href":"/api-reference/store-api/markets/list-countries"},{"title":"Get a country","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/countries/{iso}","href":"/api-reference/store-api/markets/get-a-country"},{"title":"List supported currencies","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/currencies","href":"/api-reference/store-api/markets/list-supported-currencies"},{"title":"List supported locales","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/locales","href":"/api-reference/store-api/markets/list-supported-locales"},{"title":"List markets","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/markets","href":"/api-reference/store-api/markets/list-markets"},{"title":"Get a market","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/markets/{id}","href":"/api-reference/store-api/markets/get-a-market"},{"title":"Resolve market by country","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/markets/resolve","href":"/api-reference/store-api/markets/resolve-market-by-country"},{"title":"List countries in a market","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/markets/{market_id}/countries","href":"/api-reference/store-api/markets/list-countries-in-a-market"},{"title":"Get a country in a market","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/markets/{market_id}/countries/{id}","href":"/api-reference/store-api/markets/get-a-country-in-a-market"}]},{"group":"Newsletter Subscribers","pages":[{"title":"Subscribe to the newsletter","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/newsletter_subscribers","href":"/api-reference/store-api/newsletter-subscribers/subscribe-to-the-newsletter"},{"title":"Verify a newsletter subscription","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/newsletter_subscribers/verify","href":"/api-reference/store-api/newsletter-subscribers/verify-a-newsletter-subscription"},{"title":"Unsubscribe from the newsletter","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/newsletter_subscribers/{id}","href":"/api-reference/store-api/newsletter-subscribers/unsubscribe-from-the-newsletter"},{"title":"Request an unsubscribe token","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/newsletter_subscribers/request_unsubscribe","href":"/api-reference/store-api/newsletter-subscribers/request-an-unsubscribe-token"}]},{"group":"Orders","pages":[{"title":"List claims","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/orders/{order_id}/claims","href":"/api-reference/store-api/orders/list-claims"},{"title":"Open a claim","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/orders/{order_id}/claims","href":"/api-reference/store-api/orders/open-a-claim"},{"title":"Get an order","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/orders/{id}","href":"/api-reference/store-api/orders/get-an-order"},{"title":"List returns","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/orders/{order_id}/returns","href":"/api-reference/store-api/orders/list-returns"},{"title":"Open a return","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/orders/{order_id}/returns","href":"/api-reference/store-api/orders/open-a-return"}]},{"group":"Policies","pages":[{"title":"List store policies","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/policies","href":"/api-reference/store-api/policies/list-store-policies"},{"title":"Get a policy","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/policies/{id}","href":"/api-reference/store-api/policies/get-a-policy"}]},{"group":"Product Catalog","pages":[{"title":"List categories","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/categories","href":"/api-reference/store-api/product-catalog/list-categories"},{"title":"Get a category","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/categories/{id}","href":"/api-reference/store-api/product-catalog/get-a-category"},{"title":"List collections","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/collections","href":"/api-reference/store-api/product-catalog/list-collections"},{"title":"Get a collection","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/collections/{id}","href":"/api-reference/store-api/product-catalog/get-a-collection"},{"title":"List collection products","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/collections/{collection_id}/products","href":"/api-reference/store-api/product-catalog/list-collection-products"},{"title":"List products","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/products","href":"/api-reference/store-api/product-catalog/list-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/products/{id}","href":"/api-reference/store-api/product-catalog/get-a-product"},{"title":"Get product filters","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/products/filters","href":"/api-reference/store-api/product-catalog/get-product-filters"}]},{"group":"Sellers","pages":[{"title":"List sellers","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/sellers","href":"/api-reference/store-api/sellers/list-sellers"},{"title":"Get a seller","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/sellers/{id}","href":"/api-reference/store-api/sellers/get-a-seller"}]},{"group":"Store","pages":[{"title":"Get the current store","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/store","href":"/api-reference/store-api/store/get-the-current-store"}]},{"group":"Wishlists","pages":[{"title":"List wishlists","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/wishlists","href":"/api-reference/store-api/wishlists/list-wishlists"},{"title":"Create a wishlist","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/wishlists","href":"/api-reference/store-api/wishlists/create-a-wishlist"},{"title":"Get a wishlist","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml get /api/v3/store/wishlists/{id}","href":"/api-reference/store-api/wishlists/get-a-wishlist"},{"title":"Delete a wishlist","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/wishlists/{id}","href":"/api-reference/store-api/wishlists/delete-a-wishlist"},{"title":"Update a wishlist","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/wishlists/{id}","href":"/api-reference/store-api/wishlists/update-a-wishlist"},{"title":"Add item to wishlist","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml post /api/v3/store/wishlists/{wishlist_id}/items","href":"/api-reference/store-api/wishlists/add-item-to-wishlist"},{"title":"Remove item from wishlist","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml delete /api/v3/store/wishlists/{wishlist_id}/items/{id}","href":"/api-reference/store-api/wishlists/remove-item-from-wishlist"},{"title":"Update a wishlist item","deprecated":null,"version":null,"openapi":"/api-reference/store.yaml patch /api/v3/store/wishlists/{wishlist_id}/items/{id}","href":"/api-reference/store-api/wishlists/update-a-wishlist-item"}]}]}]},{"item":"Admin API","icon":"shield","description":"REST API for pragmatically managing stores","pages":[{"title":"Admin API","href":"/api-reference/admin-api/introduction"}]},{"item":"Webhooks","icon":"webhook","description":"Event payloads and delivery reference","pages":[{"title":"Webhooks","href":"/api-reference/webhooks-events"}]},{"item":"Legacy API v2","icon":"clock","description":"Previous-generation Storefront and Platform APIs","pages":[{"title":"Legacy API v2","href":"/api-reference/v2/introduction"}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/integrations"}]},{"tab":"User Guide","pages":[{"title":"User Guide","href":"/v5/user/what-is-spree-commerce"}]}]}]},"basePath":"","title":"Get payment setup session - Spree Commerce documentation","deploymentId":"dpl_J2QdBVuN65x4CCtpqPb371YPt4xi","buildId":"dpl_J2QdBVuN65x4CCtpqPb371YPt4xi","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-tiVafkWW.js","utils-CURQcKis.js","cloneDeep-D7WNbvHt.js","_Uint8Array-BY_XlfVz.js","isObject-FP1Yky1u.js","utils-CdFTKPRO.js","addUniqueKeysToSchema-BSfwE63N.js","snippetPresets-BHyg8yZ0.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-CTsmHnLF.js","ApiExamples-CQdVXSju.js","isEqual-ft5OxoSH.js","usePlaygroundInputsStore-BILH4rrw.js","shallow-DterCiSU.js","getApiPlaygroundDisplay-uFtORr6j.js","CodeSnippet-BeuhEvUS.js","CodeSnippets-laCoJsvn.js","getPastedJson-DOT1n5Lt.js","icon-COH-nmcZ.js","MethodPill-BbAWkCf6.js","DuplicateIcon-CpagiAFQ.js","createIcon-Bw2Dnowf.js","DynamicMarkdown-DzuINhDe.js","SectionHeading-B3H20qI6.js","axios-vUo_bRtp.js","Markdown-DBdbz5B3.js","dist-DWEsd3cZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DuX7jTnG.js"]}