Creates a payment provider Checkout session with embedded, hosted, or elements UI, supporting payment, setup, or subscription modes. A subscription session may carry both recurring and one-time prices in one cart and accepts an optional trial.
Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.
Headers
Idempotency-Key
string
Forwarded as the payment provider's request idempotency key. Retried requests with the same key and parameters are deduped by the provider (roughly a 24-hour replay window) instead of creating a second resource. Recommended: an opaque, randomly-generated value such as a UUID rather than a predictable or derived string.
Body
application/json
type
string
required
Session mode: "payment", "setup", or "subscription".
ui_mode
string
One of "embedded", "hosted", "embedded_page", "hosted_page", "elements". Default "embedded". The legacy "embedded"/"hosted" values are translated to the payment provider's current values "embedded_page"/"hosted_page" before the provider call; "elements" passes through unchanged; the response echoes the value you sent.
success_url
string
Required when ui_mode resolves to a hosted page ("hosted" or "hosted_page"). Must be a well-formed http(s) URL — a malformed value or another scheme is rejected with a 400 rather than forwarded to the provider.
return_url
string
Redirect target after completion for embedded checkouts, where it is optional. Required when ui_mode is "elements" — the payment provider rejects the session otherwise. Same http(s) URL check as success_url.
cancel_url
string
Only allowed when ui_mode resolves to a hosted page. Shows a back button on the hosted checkout page and redirects the customer here if they cancel. A non-empty value on "embedded", "embedded_page" or "elements" — including when ui_mode is omitted, which defaults to embedded — is rejected with a 400; a whitespace-only value is treated as absent. Same http(s) URL check as success_url.
customer_data
object
Customer name and email; omit if provider_customer_id provided.
Show child attributes
provider_customer_id
string
Existing payment provider customer ID.
currency
string
Required when type is "setup"; ISO 4217 code.
provider_coupon_ids
string[]
Coupon IDs; only for payment and subscription modes. Mutually exclusive with provider_promotion_code_ids.
provider_promotion_code_ids
string[]
Promotion code IDs; only for payment and subscription modes. Mutually exclusive with provider_coupon_ids — providing both is rejected with a 400.
items
object[]
Required for payment and subscription modes. A subscription cart may hold both recurring and one-time prices in one array — no discriminator is needed, each entry is routed by the price's own type, and a one-time amount lands on the subscription's first invoice, charged in full at creation. A subscription cart needs exactly one recurring price, with any number of one-time prices beside it: pause, resume and cancel act on the whole subscription, so create one subscription per recurring product. In a cart of two or more lines, a price unknown to your account is a 404 naming the id; in a one-line cart the payment provider rejects it at session creation.
Show child attributes
trial_period_days
integer
Trial length in days; positive integer. Subscription sessions only — sending it on a "payment" or "setup" session is rejected with a 400. The trial defers the recurring charge only: a one-time price in the same cart is still charged immediately. Trial-end behaviour is OpenLoop's policy and has no request field — a trial that ends with no payment method on file cancels the subscription rather than invoicing it.
excluded_payment_method_types
string[]
Payment method types the session must not offer; the account's other enabled methods still show. Values are the payment provider's payment method type names (e.g. card, klarna, affirm, afterpay_clearpay), matched exactly and forwarded unchanged. gopay, paypay, qris, rechnung and shopeepay are not yet accepted. Accepted on every session type. Excluding card also removes the card-based express buttons (Apple Pay, Link); wallets that are their own type, such as amazon_pay and cashapp, stay until excluded themselves. Excluding klarna alone can still leave Klarna available through Link; link is not an accepted value, and Link goes away only when card is excluded. An empty array, null, a non-array, a non-string entry or a value that is not accepted is rejected with a 400, and only the last of these names the value.
provider_payment_method_configuration_id
string
Id of a payment method configuration on your payment provider account. The session offers only the methods that configuration enables; without it the account's default configuration applies. Forwarded unchanged, and may be sent together with excluded_payment_method_types to narrow the configuration further. null, a non-string, or an empty or whitespace-only value is rejected with a 400; an id the payment provider doesn't recognise returns the provider's error as a 400. The payment provider's own eligibility rules still apply on top (for example, Affirm and Afterpay are offered only to buyers in the account's own country); if the restrictions leave nothing to offer, the session is still created with a 200, but its hosted page shows no payment methods.
metadata
object
Custom metadata merged onto the checkout session and the mode-specific sub-object. Distinct from customer_data.metadata, which only affects the customer record. Values must be strings. The source key is reserved. Forwarded to the payment provider and republished in events — do not include PHI or PII.
Show child attributes
Response
Success.
data
object
required
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Partners API Documentation","colors":{"primary":"#e34376","light":"#e55484","dark":"#e3235f"},"logo":{"light":"https://mintcdn.com/openloop/uFqnU7STc2L-iY-j/logo/openloop_light.png?fit=max\u0026auto=format\u0026n=uFqnU7STc2L-iY-j\u0026q=85\u0026s=36c08284ca501fdefe4311339c563474","dark":"https://mintcdn.com/openloop/uFqnU7STc2L-iY-j/logo/openloop_dark.png?fit=max\u0026auto=format\u0026n=uFqnU7STc2L-iY-j\u0026q=85\u0026s=81c334cb0ffc5f63a9595a1d611595ce"},"favicon":"https://mintcdn.com/openloop/uFqnU7STc2L-iY-j/favicon.ico?fit=max\u0026auto=format\u0026n=uFqnU7STc2L-iY-j\u0026q=85\u0026s=7be86b4f76e18b47229f3b8646ba3fa2","api":{"playground":{"display":"interactive"}},"navbar":{"links":[{"href":"https://openloophealth.com","label":"OpenLoop Health"}],"primary":{"type":"button","label":"Get Started","href":"https://openloophealth.com/contact"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/openloophealth"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"OpenLoop Health","icon":"globe","href":"https://openloophealth.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"openloop","hasAudioNarration":false,"actualSubdomain":"openloop","customDomains":[],"gitSource":{"type":"github","owner":"openloophealth","repo":"patient-zero-openloop-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aff28baca43cd0248039897","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API Reference","count":130},{"language":"default","tag":"Partner Cookbook","count":24},{"language":"default","tag":"Scheduling","count":9},{"language":"default","tag":"Guides","count":8},{"language":"default","tag":"Subscriptions","count":8},{"language":"default","tag":"Auth","count":7},{"language":"default","tag":"Billing Customers","count":7},{"language":"default","tag":"Eligibility","count":7},{"language":"default","tag":"When things go wrong","count":6},{"language":"default","tag":"Users","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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":false},"customCss":[],"page":{"pagePath":"api-reference/checkout/create-checkout-session","slug":"/api-reference/checkout/create-checkout-session","pageMetadata":{"title":"Create Checkout Session","description":"Creates a payment provider Checkout session with embedded, hosted, or elements UI, supporting payment, setup, or subscription modes. A subscription session may carry both recurring and one-time prices in one cart and accepts an optional trial.","deprecated":null,"version":null,"openapi":"/openapi.json post /checkouts/sessions","href":"/api-reference/checkout/create-checkout-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: \"Creates a payment provider Checkout session with embedded, hosted, or elements UI, supporting payment, setup, or subscription modes. A subscription session may carry both recurring and one-time prices in one cart and accepts an optional trial.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Checkout Session","description":"Creates a payment provider Checkout session with embedded, hosted, or elements UI, supporting payment, setup, or subscription modes. A subscription session may carry both recurring and one-time prices in one cart and accepts an optional trial.","deprecated":null,"version":null,"openapi":"/openapi.json post /checkouts/sessions","href":"/api-reference/checkout/create-checkout-session","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create Checkout Session","tags":["Checkout"],"security":["a5e6fa33-e175-46c1-aa4b-09df298b6e28","79ab63eb-5325-4700-82bb-1f014612209d"],"description":"Creates a payment provider Checkout session with embedded, hosted, or elements UI, supporting payment, setup, or subscription modes. A subscription session may carry both recurring and one-time prices in one cart and accepts an optional trial.","requestBody":"e9de6954-70ed-4d28-9791-bde2e6b43ad1","responses":{"200":"b320f61a-5334-4c30-bece-50025aff18ef","400":"50a59ae4-2464-4f6f-86db-71d7e05549f5","401":"346f5fde-e797-4fe8-8d4b-522e3497f16e","403":"eb9feefc-c898-44ae-a78d-8b0e73e57ffb","404":"72836582-1b9f-4610-857e-c4e49060b73d","500":"59f26b9c-a534-4e6f-b407-0430015ea4bd"},"parameters":["f6b12546-4556-4ec5-8f20-0aed6ae89558"],"method":"post","type":"path","servers":["c242b877-71eb-4138-9d4e-930ddd911326","538c36be-4e83-42ab-98cd-fcf6de7f10e5"],"path":"/checkouts/sessions","baseUrlOptions":["https://api.openloophealth.com/v0.1","https://api-staging.openloophealth.com/v0.1"],"title":"Create Checkout Session","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"f6b12546-4556-4ec5-8f20-0aed6ae89558":{"in":"header","name":"Idempotency-Key","required":false,"schema":{"type":"string","isRequired":false,"description":"Forwarded as the payment provider's request idempotency key. Retried requests with the same key and parameters are deduped by the provider (roughly a 24-hour replay window) instead of creating a second resource. Recommended: an opaque, randomly-generated value such as a UUID rather than a predictable or derived string.","uniqueKey":"","typeLabel":"string"},"description":"Forwarded as the payment provider's request idempotency key. Retried requests with the same key and parameters are deduped by the provider (roughly a 24-hour replay window) instead of creating a second resource. Recommended: an opaque, randomly-generated value such as a UUID rather than a predictable or derived string."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Session mode: `\"payment\"`, `\"setup\"`, or `\"subscription\"`.","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"ui_mode":{"type":"string","description":"One of `\"embedded\"`, `\"hosted\"`, `\"embedded_page\"`, `\"hosted_page\"`, `\"elements\"`. Default `\"embedded\"`. The legacy `\"embedded\"`/`\"hosted\"` values are translated to the payment provider's current values `\"embedded_page\"`/`\"hosted_page\"` before the provider call; `\"elements\"` passes through unchanged; the response echoes the value you sent.","uniqueKey":"ui_mode","typeLabel":"string"},"success_url":{"type":"string","description":"Required when `ui_mode` resolves to a hosted page (`\"hosted\"` or `\"hosted_page\"`). Must be a well-formed `http(s)` URL — a malformed value or another scheme is rejected with a `400` rather than forwarded to the provider.","uniqueKey":"success_url","typeLabel":"string"},"return_url":{"type":"string","description":"Redirect target after completion for embedded checkouts, where it is optional. Required when `ui_mode` is `\"elements\"` — the payment provider rejects the session otherwise. Same `http(s)` URL check as `success_url`.","uniqueKey":"return_url","typeLabel":"string"},"cancel_url":{"type":"string","description":"Only allowed when `ui_mode` resolves to a hosted page. Shows a back button on the hosted checkout page and redirects the customer here if they cancel. A non-empty value on `\"embedded\"`, `\"embedded_page\"` or `\"elements\"` — including when `ui_mode` is omitted, which defaults to embedded — is rejected with a `400`; a whitespace-only value is treated as absent. Same `http(s)` URL check as `success_url`.","uniqueKey":"cancel_url","typeLabel":"string"},"customer_data":{"type":"object","properties":{"name":{"type":"string","description":"Customer name.","uniqueKey":"customer_data.name","typeLabel":"string"},"email":{"type":"string","description":"Customer email; normalized to lowercase and trimmed server-side before the provider call. Must be a valid address of at most 512 characters. Plus addressing (`name+tag@example.com`) is supported.","uniqueKey":"customer_data.email","typeLabel":"string"},"phone":{"type":"string","description":"Phone number.","uniqueKey":"customer_data.phone","typeLabel":"string"},"metadata":{"type":"object","description":"Custom metadata.","uniqueKey":"customer_data.metadata","typeLabel":"object"}},"description":"Customer name and email; omit if `provider_customer_id` provided.","uniqueKey":"customer_data","typeLabel":"object"},"provider_customer_id":{"type":"string","description":"Existing payment provider customer ID.","uniqueKey":"provider_customer_id","typeLabel":"string"},"currency":{"type":"string","description":"Required when `type` is `\"setup\"`; ISO 4217 code.","uniqueKey":"currency","typeLabel":"string"},"provider_coupon_ids":{"type":"array","items":{"type":"string","uniqueKey":"provider_coupon_ids.items.[INDEX]","typeLabel":"string"},"description":"Coupon IDs; only for payment and subscription modes. Mutually exclusive with `provider_promotion_code_ids`.","uniqueKey":"provider_coupon_ids","typeLabel":"string[]"},"provider_promotion_code_ids":{"type":"array","items":{"type":"string","uniqueKey":"provider_promotion_code_ids.items.[INDEX]","typeLabel":"string"},"description":"Promotion code IDs; only for payment and subscription modes. Mutually exclusive with `provider_coupon_ids` — providing both is rejected with a `400`.","uniqueKey":"provider_promotion_code_ids","typeLabel":"string[]"},"items":{"type":"array","items":{"type":"object","properties":{"provider_price_id":{"type":"string","description":"Provider price ID.","isRequired":true,"uniqueKey":"\\items.items.[INDEX].provider_price_id","typeLabel":"string"},"quantity":{"type":"number","description":"Defaults to 1; must be positive integer.","uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"number"}},"required":["provider_price_id"],"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"description":"Required for payment and subscription modes. A subscription cart may hold both recurring and one-time prices in one array — no discriminator is needed, each entry is routed by the price's own type, and a one-time amount lands on the subscription's first invoice, charged in full at creation. A subscription cart needs exactly one recurring price, with any number of one-time prices beside it: pause, resume and cancel act on the whole subscription, so create one subscription per recurring product. In a cart of two or more lines, a price unknown to your account is a `404` naming the id; in a one-line cart the payment provider rejects it at session creation.","uniqueKey":"\\items","typeLabel":"object[]"},"trial_period_days":{"type":"integer","description":"Trial length in days; positive integer. **Subscription sessions only** — sending it on a `\"payment\"` or `\"setup\"` session is rejected with a `400`. The trial defers the recurring charge only: a one-time price in the same cart is still charged immediately. Trial-end behaviour is OpenLoop's policy and has no request field — a trial that ends with no payment method on file cancels the subscription rather than invoicing it.","uniqueKey":"trial_period_days","typeLabel":"integer"},"excluded_payment_method_types":{"type":"array","items":{"type":"string","uniqueKey":"excluded_payment_method_types.items.[INDEX]","typeLabel":"string"},"description":"Payment method types the session must not offer; the account's other enabled methods still show. Values are the payment provider's payment method type names (e.g. `card`, `klarna`, `affirm`, `afterpay_clearpay`), matched exactly and forwarded unchanged. `gopay`, `paypay`, `qris`, `rechnung` and `shopeepay` are not yet accepted. Accepted on every session type. Excluding `card` also removes the card-based express buttons (Apple Pay, Link); wallets that are their own type, such as `amazon_pay` and `cashapp`, stay until excluded themselves. Excluding `klarna` alone can still leave Klarna available through Link; `link` is not an accepted value, and Link goes away only when `card` is excluded. An empty array, `null`, a non-array, a non-string entry or a value that is not accepted is rejected with a `400`, and only the last of these names the value.","uniqueKey":"excluded_payment_method_types","typeLabel":"string[]"},"provider_payment_method_configuration_id":{"type":"string","description":"Id of a payment method configuration on your payment provider account. The session offers only the methods that configuration enables; without it the account's default configuration applies. Forwarded unchanged, and may be sent together with `excluded_payment_method_types` to narrow the configuration further. `null`, a non-string, or an empty or whitespace-only value is rejected with a `400`; an id the payment provider doesn't recognise returns the provider's error as a `400`. The payment provider's own eligibility rules still apply on top (for example, Affirm and Afterpay are offered only to buyers in the account's own country); if the restrictions leave nothing to offer, the session is still created with a `200`, but its hosted page shows no payment methods.","uniqueKey":"provider_payment_method_configuration_id","typeLabel":"string"},"metadata":{"type":"object","properties":{"order_id":{"type":"string","uniqueKey":"metadata.order_id","typeLabel":"string"}},"description":"Custom metadata merged onto the checkout session and the mode-specific sub-object. Distinct from `customer_data.metadata`, which only affects the customer record. Values must be strings. The `source` key is reserved. Forwarded to the payment provider and republished in events — do not include PHI or PII.","uniqueKey":"metadata","typeLabel":"object"}},"required":["type"],"uniqueKey":"","typeLabel":"object"},"example":{"ui_mode":"embedded","type":"payment","customer_data":{"name":"Example Customer","email":"customer@example.com"},"items":[{"provider_price_id":"test_price_id","quantity":1}]},"examples":{"Example":{"title":"Example","value":{"ui_mode":"embedded","type":"payment","customer_data":{"name":"Example Customer","email":"customer@example.com"},"items":[{"provider_price_id":"test_price_id","quantity":1}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"b320f61a-5334-4c30-bece-50025aff18ef":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"provider_checkout_session_id":{"type":"string","description":"Provider checkout session ID.","uniqueKey":"data.provider_checkout_session_id","typeLabel":"string"},"provider_customer_id":{"oneOf":[{"type":"string","description":"the payment provider Customer ID or null.","uniqueKey":"data.provider_customer_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"the payment provider Customer ID or null.","uniqueKey":"data.provider_customer_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.provider_customer_id","typeLabel":"string | null"},"type":{"type":"string","description":"Session type.","uniqueKey":"data.type","typeLabel":"string"},"ui_mode":{"type":"string","description":"Echoes the requested value: `\"embedded\"`/`\"hosted\"` (legacy) or `\"embedded_page\"`/`\"hosted_page\"` (dahlia).","uniqueKey":"data.ui_mode","typeLabel":"string"},"publishable_key":{"oneOf":[{"type":"string","description":"the payment provider publishable key for embedded mode; null for hosted.","uniqueKey":"data.publishable_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"the payment provider publishable key for embedded mode; null for hosted.","uniqueKey":"data.publishable_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.publishable_key","typeLabel":"string | null"},"client_secret":{"oneOf":[{"type":"string","description":"the payment provider client secret for embedded mode; null for hosted.","uniqueKey":"data.client_secret.oneOf.0","typeLabel":"string"},{"type":"null","description":"the payment provider client secret for embedded mode; null for hosted.","uniqueKey":"data.client_secret.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.client_secret","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"Checkout URL for hosted mode; null for embedded.","uniqueKey":"data.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Checkout URL for hosted mode; null for embedded.","uniqueKey":"data.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.url","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"example":{"data":{"provider_checkout_session_id":"test_checkout_session_id","provider_customer_id":"test_customer_id","type":"payment","ui_mode":"embedded","publishable_key":"test_publishable_key","client_secret":"test_checkout_session_key","url":null}},"examples":{"Example":{"title":"Example","value":{"data":{"provider_checkout_session_id":"test_checkout_session_id","provider_customer_id":"test_customer_id","type":"payment","ui_mode":"embedded","publishable_key":"test_publishable_key","client_secret":"test_checkout_session_key","url":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"50a59ae4-2464-4f6f-86db-71d7e05549f5":{"description":"ValidationError: an invalid `ui_mode`; a missing required field, including `return_url` when `ui_mode` is `\"elements\"` and `currency` when `type` is `\"setup\"`; a malformed or non-`http(s)` `success_url`, `return_url` or `cancel_url`; a `cancel_url` sent when `ui_mode` does not resolve to a hosted page; both `provider_coupon_ids` and `provider_promotion_code_ids`; invalid `metadata`; an unsupported `type`; failed items validation; a subscription session whose `items` hold two or more recurring entries, including the same recurring price on two lines (`A subscription can have only one recurring price. Create a separate subscription for each recurring product.` — checked before the session is created, so no session is created and nothing is charged); a `trial_period_days` that is not a positive integer or was sent on a non-subscription session; an `excluded_payment_method_types` that is not a non-empty array of accepted values; or a `provider_payment_method_configuration_id` that is not a non-empty string. ProviderError: a subscription session whose `items` carry no recurring price — the payment provider rejects this at session creation and its message is surfaced as-is; or a `provider_payment_method_configuration_id` the payment provider rejects, such as an id that doesn't exist on the account.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"346f5fde-e797-4fe8-8d4b-522e3497f16e":{"description":"Missing or invalid bearer token.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"eb9feefc-c898-44ae-a78d-8b0e73e57ffb":{"description":"No configuration exists for your account, or provider access has been disabled for it. A permission failure at the payment provider, for example while reading the prices of a subscription cart of two or more lines, also returns `403`.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"72836582-1b9f-4610-857e-c4e49060b73d":{"description":"NotFoundError: the configuration resolved for your account was deleted between resolution and the provider call (a rare race). Also, in a subscription session of two or more lines, a price that is unknown to your account (`items price not found: \u003cid>`).","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"59f26b9c-a534-4e6f-b407-0430015ea4bd":{"description":"Payment provider integration error.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"a5e6fa33-e175-46c1-aa4b-09df298b6e28":{"serviceToken":{"type":"oauth2","description":"Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.","flows":{"clientCredentials":{"tokenUrl":"https://api.openloophealth.com/v0.1/auth/token","scopes":{}}},"scopes":[],"schemeName":"serviceToken"}},"79ab63eb-5325-4700-82bb-1f014612209d":{"userToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User access token issued by POST /auth/token via the verification-code grant (after Verify a one-time code) or the refresh_token grant.","scopes":[],"schemeName":"userToken"}}},"servers":{"c242b877-71eb-4138-9d4e-930ddd911326":{"url":"https://api.openloophealth.com/v0.1","description":"Production partner edge"},"538c36be-4e83-42ab-98cd-fcf6de7f10e5":{"url":"https://api-staging.openloophealth.com/v0.1","description":"Staging partner edge (sandbox credentials)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.","flows":{"clientCredentials":{"tokenUrl":"https://api.openloophealth.com/v0.1/auth/token","scopes":{}}},"scopes":[],"schemeName":"serviceToken"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Service (M2M) access token issued by POST /auth/token using the client_credentials grant. Required scopes, where known, are listed on each operation below.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"serviceToken","name":"Authorization"}],"title":"serviceToken"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"User access token issued by POST /auth/token via the verification-code grant (after Verify a one-time code) or the refresh_token grant.","scopes":[],"schemeName":"userToken"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"User access token issued by POST /auth/token via the verification-code grant (after Verify a one-time code) or the refresh_token grant.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"userToken","name":"Authorization"}],"title":"userToken"}]},"originalFileLocation":"openapi.json"},"subdomain":"openloop","siteName":"Partners API Documentation","title":"Create Checkout Session - Partners API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T16:50:10.867Z","originalFileLocation":"api-reference/checkout/create-checkout-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=\"Creates a payment provider Checkout session with embedded, hosted, or elements UI, supporting payment, setup, or subscription modes. A subscription session may carry both recurring and one-time prices in one cart and accepts an optional trial.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Partners API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Checkout Session - Partners API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a payment provider Checkout session with embedded, hosted, or elements UI, supporting payment, setup, or subscription modes. A subscription session may carry both recurring and one-time prices in one cart and accepts an optional trial.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Partners API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://openloop.mintlify.app/api-reference/checkout/create-checkout-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://openloop.mintlify.site/_mintlify/api/og/v2?division=Checkout\u0026amp;title=Create+Checkout+Session\u0026amp;description=Creates+a+payment+provider+Checkout+session+with+embedded%2C+hosted%2C+or+elements+UI%2C+supporting+payment%2C+setup%2C+or+subscription+modes.+A+subscription+session+may+\u0026amp;theme=c3eb8a84b98e9b697f555ff9\u0026amp;signature=f32d2bc3ab4a37960cc6b11a447a280147d89560d73f459d72343e68320370ec\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Checkout Session - Partners API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a payment provider Checkout session with embedded, hosted, or elements UI, supporting payment, setup, or subscription modes. A subscription session may carry both recurring and one-time prices in one cart and accepts an optional trial.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://openloop.mintlify.site/_mintlify/api/og/v2?division=Checkout\u0026amp;title=Create+Checkout+Session\u0026amp;description=Creates+a+payment+provider+Checkout+session+with+embedded%2C+hosted%2C+or+elements+UI%2C+supporting+payment%2C+setup%2C+or+subscription+modes.+A+subscription+session+may+\u0026amp;theme=c3eb8a84b98e9b697f555ff9\u0026amp;signature=f32d2bc3ab4a37960cc6b11a447a280147d89560d73f459d72343e68320370ec\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/openloop/LIC2QTmC6gcwcygU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Partners API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#e34376\">\u003clink data-mint-head rel=\"canonical\" href=\"https://openloop.mintlify.app/api-reference/checkout/create-checkout-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/checkout/create-checkout-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://openloop.mintlify.app/#organization\",\"name\":\"Partners API Documentation\",\"url\":\"https://openloop.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/openloop/uFqnU7STc2L-iY-j/logo/openloop_light.png?fit=max\u0026auto=format\u0026n=uFqnU7STc2L-iY-j\u0026q=85\u0026s=36c08284ca501fdefe4311339c563474\"}},{\"@type\":\"WebSite\",\"@id\":\"https://openloop.mintlify.app#website\",\"name\":\"Partners API Documentation\",\"url\":\"https://openloop.mintlify.app\",\"publisher\":{\"@id\":\"https://openloop.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://openloop.mintlify.app/api-reference/checkout/create-checkout-session#webpage\",\"url\":\"https://openloop.mintlify.app/api-reference/checkout/create-checkout-session\",\"name\":\"Create Checkout Session\",\"description\":\"Creates a payment provider Checkout session with embedded, hosted, or elements UI, supporting payment, setup, or subscription modes. A subscription session may carry both recurring and one-time prices in one cart and accepts an optional trial.\",\"dateModified\":\"2026-11-19T16:50:10.867Z\",\"isPartOf\":{\"@id\":\"https://openloop.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://openloop.mintlify.app/api-reference/checkout/create-checkout-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://openloop.mintlify.app/api-reference/checkout/create-checkout-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Partners API Documentation\",\"item\":\"https://openloop.mintlify.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Checkout Session\",\"item\":\"https://openloop.mintlify.app/api-reference/checkout/create-checkout-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://openloop.mintlify.app/api-reference/checkout/create-checkout-session#apireference\",\"headline\":\"Create Checkout Session\",\"name\":\"Create Checkout Session\",\"description\":\"Creates a payment provider Checkout session with embedded, hosted, or elements UI, supporting payment, setup, or subscription modes. A subscription session may carry both recurring and one-time prices in one cart and accepts an optional trial.\",\"url\":\"https://openloop.mintlify.app/api-reference/checkout/create-checkout-session\",\"mainEntityOfPage\":{\"@id\":\"https://openloop.mintlify.app/api-reference/checkout/create-checkout-session#webpage\"},\"dateModified\":\"2026-11-19T16:50:10.867Z\",\"publisher\":{\"@id\":\"https://openloop.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://openloop.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Partners API Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Partners API Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/checkout/create-checkout-session.md","siteName":"Partners API Documentation","nav":{"global":{"anchors":[{"anchor":"OpenLoop Health","icon":"globe","href":"https://openloophealth.com"}]},"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":""}]},{"tab":"Partner Cookbook","pages":[{"title":"Partner Cookbook","href":"/cookbook"}]},{"tab":"API Reference","groups":[{"group":"Guides","pages":[{"title":"API Overview","href":"/api-reference/introduction"},{"title":"Data Standards","mode":"wide","href":"/api-reference/data-standards"},{"title":"Best Practices","href":"/best-practices"},{"title":"Product \u0026 Price IDs","href":"/api-reference/product-and-price-ids"},{"title":"Scheduling","href":"/api-reference/scheduling-guide"},{"title":"Eligibility","href":"/api-reference/eligibility-guide"},{"title":"User Registration","href":"/api-reference/user-registration-guide"},{"title":"How orders are created","href":"/orders/order-model"}]},{"group":"Events","pages":[{"title":"Events","href":"/events"}]},{"group":"Auth","pages":[{"title":"Obtain a service token","openapi":"POST /auth/token","href":"/auth/obtain-token"},{"title":"Register a user","openapi":"post /auth/register","href":"/auth/register"},{"title":"Send a one-time code","openapi":"post /auth/send-otp","href":"/auth/send-otp"},{"title":"Verify a one-time code","openapi":"post /auth/verify-otp","href":"/auth/verify-otp"},{"title":"Exchange a verification code","openapi":"POST /auth/token","href":"/auth/exchange-verification-code"},{"title":"Refresh a token","openapi":"POST /auth/token","href":"/auth/refresh-token"},{"title":"Revoke a session","openapi":"post /auth/revoke","href":"/auth/revoke"}]},{"group":"Users","pages":[{"openapi":"get /iam/users/find","title":"Find a user by email","href":"/users/find-user"},{"title":"Read a user's patient link","openapi":"get /iam/users/links","href":"/users/get-user-link"},{"title":"Delete the current user","openapi":"delete /iam/users/me","href":"/users/delete-user"}]},{"group":"Allergy Intolerances","pages":[{"title":"List allergy intolerances","deprecated":null,"version":null,"openapi":"/openapi.json get /allergy-intolerances","href":"/api-reference/allergy-intolerances/list-allergy-intolerances"},{"title":"Create allergy intolerance","deprecated":null,"version":null,"openapi":"/openapi.json post /allergy-intolerances","href":"/api-reference/allergy-intolerances/create-allergy-intolerance"},{"title":"Get allergy intolerance","deprecated":null,"version":null,"openapi":"/openapi.json get /allergy-intolerances/{id}","href":"/api-reference/allergy-intolerances/get-allergy-intolerance"},{"title":"Update allergy intolerance","deprecated":null,"version":null,"openapi":"/openapi.json put /allergy-intolerances/{id}","href":"/api-reference/allergy-intolerances/update-allergy-intolerance"}]},{"group":"Consents","pages":[{"title":"List consents","deprecated":null,"version":null,"openapi":"/openapi.json get /consents","href":"/api-reference/consents/list-consents"},{"title":"Create consent","deprecated":null,"version":null,"openapi":"/openapi.json post /consents","href":"/api-reference/consents/create-consent"},{"title":"Get consent","deprecated":null,"version":null,"openapi":"/openapi.json get /consents/{id}","href":"/api-reference/consents/get-consent"},{"title":"Update consent","deprecated":null,"version":null,"openapi":"/openapi.json put /consents/{id}","href":"/api-reference/consents/update-consent"}]},{"group":"Document References","pages":[{"title":"List document references","deprecated":null,"version":null,"openapi":"/openapi.json get /document-references","href":"/api-reference/document-references/list-document-references"},{"title":"Create document reference","deprecated":null,"version":null,"openapi":"/openapi.json post /document-references","href":"/api-reference/document-references/create-document-reference"},{"title":"Upload document content","deprecated":null,"version":null,"openapi":"/openapi.json post /document-references/content","href":"/api-reference/document-references/upload-document-content"},{"title":"Get document reference","deprecated":null,"version":null,"openapi":"/openapi.json get /document-references/{id}","href":"/api-reference/document-references/get-document-reference"},{"title":"Update document reference","deprecated":null,"version":null,"openapi":"/openapi.json put /document-references/{id}","href":"/api-reference/document-references/update-document-reference"},{"title":"Get document reference content","deprecated":null,"version":null,"openapi":"/openapi.json get /document-references/{id}/content","href":"/api-reference/document-references/get-document-reference-content"}]},{"group":"Laboratories","pages":[{"title":"Create lab requisition","deprecated":null,"version":null,"openapi":"/openapi.json post /laboratories","href":"/api-reference/laboratories/create-lab-requisition"}]},{"group":"Medication Statements","pages":[{"title":"List medication statements","deprecated":null,"version":null,"openapi":"/openapi.json get /medication-statements","href":"/api-reference/medication-statements/list-medication-statements"},{"title":"Create medication statement","deprecated":null,"version":null,"openapi":"/openapi.json post /medication-statements","href":"/api-reference/medication-statements/create-medication-statement"},{"title":"Get medication statement","deprecated":null,"version":null,"openapi":"/openapi.json get /medication-statements/{id}","href":"/api-reference/medication-statements/get-medication-statement"}]},{"group":"Observations","pages":[{"title":"List observations","deprecated":null,"version":null,"openapi":"/openapi.json get /observations","href":"/api-reference/observations/list-observations"},{"title":"Create observation","deprecated":null,"version":null,"openapi":"/openapi.json post /observations","href":"/api-reference/observations/create-observation"},{"title":"Get observation","deprecated":null,"version":null,"openapi":"/openapi.json get /observations/{id}","href":"/api-reference/observations/get-observation"}]},{"group":"Organizations","pages":[{"title":"Get organization","deprecated":null,"version":null,"openapi":"/openapi.json get /organizations/{id}","href":"/api-reference/organizations/get-organization"}]},{"group":"Patients","pages":[{"title":"List patients","deprecated":null,"version":null,"openapi":"/openapi.json get /patients","href":"/api-reference/patients/list-patients"},{"title":"Create patient","deprecated":null,"version":null,"openapi":"/openapi.json post /patients","href":"/api-reference/patients/create-patient"},{"title":"Get patient","deprecated":null,"version":null,"openapi":"/openapi.json get /patients/{id}","href":"/api-reference/patients/get-patient"},{"title":"Update patient","deprecated":null,"version":null,"openapi":"/openapi.json put /patients/{id}","href":"/api-reference/patients/update-patient"}]},{"group":"Users","pages":[{"title":"Delete your account","deprecated":null,"version":null,"openapi":"/openapi.json delete /iam/users/me","href":"/api-reference/users/delete-your-account"},{"title":"Get a user's linked record","deprecated":null,"version":null,"openapi":"/openapi.json get /iam/users/links","href":"/api-reference/users/get-a-users-linked-record"},{"title":"Find a user by email","deprecated":null,"version":null,"openapi":"/openapi.json get /iam/users/find","href":"/api-reference/users/find-a-user-by-email"}]},{"group":"Questionnaire Responses","pages":[{"title":"List questionnaire responses","deprecated":null,"version":null,"openapi":"/openapi.json get /questionnaire-responses","href":"/api-reference/questionnaire-responses/list-questionnaire-responses"},{"title":"Create questionnaire response","deprecated":null,"version":null,"openapi":"/openapi.json post /questionnaire-responses","href":"/api-reference/questionnaire-responses/create-questionnaire-response"},{"title":"Get questionnaire response","deprecated":null,"version":null,"openapi":"/openapi.json get /questionnaire-responses/{id}","href":"/api-reference/questionnaire-responses/get-questionnaire-response"},{"title":"Update questionnaire response","deprecated":null,"version":null,"openapi":"/openapi.json put /questionnaire-responses/{id}","href":"/api-reference/questionnaire-responses/update-questionnaire-response"}]},{"group":"Questionnaires","pages":[{"title":"List questionnaires","deprecated":null,"version":null,"openapi":"/openapi.json get /questionnaires","href":"/api-reference/questionnaires/list-questionnaires"},{"title":"Get questionnaire","deprecated":null,"version":null,"openapi":"/openapi.json get /questionnaires/{id}","href":"/api-reference/questionnaires/get-questionnaire"}]},{"group":"Related Persons","pages":[{"title":"List related persons","deprecated":null,"version":null,"openapi":"/openapi.json get /related-persons","href":"/api-reference/related-persons/list-related-persons"},{"title":"Create related person","deprecated":null,"version":null,"openapi":"/openapi.json post /related-persons","href":"/api-reference/related-persons/create-related-person"},{"title":"Get related person","deprecated":null,"version":null,"openapi":"/openapi.json get /related-persons/{id}","href":"/api-reference/related-persons/get-related-person"},{"title":"Update related person","deprecated":null,"version":null,"openapi":"/openapi.json put /related-persons/{id}","href":"/api-reference/related-persons/update-related-person"}]},{"group":"Sites","pages":[{"title":"List sites","deprecated":null,"version":null,"openapi":"/openapi.json get /sites","href":"/api-reference/sites/list-sites"},{"title":"Create site","deprecated":null,"version":null,"openapi":"/openapi.json post /sites","href":"/api-reference/sites/create-site"},{"title":"Get site","deprecated":null,"version":null,"openapi":"/openapi.json get /sites/{key}","href":"/api-reference/sites/get-site"},{"title":"Delete site","deprecated":null,"version":null,"openapi":"/openapi.json delete /sites/{key}","href":"/api-reference/sites/delete-site"},{"title":"Update site","deprecated":null,"version":null,"openapi":"/openapi.json patch /sites/{key}","href":"/api-reference/sites/update-site"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Create task","deprecated":null,"version":null,"openapi":"/openapi.json post /tasks","href":"/api-reference/tasks/create-task"},{"title":"Get task","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{id}","href":"/api-reference/tasks/get-task"},{"title":"Update task","deprecated":null,"version":null,"openapi":"/openapi.json put /tasks/{id}","href":"/api-reference/tasks/update-task"},{"title":"Delete task","deprecated":null,"version":null,"openapi":"/openapi.json delete /tasks/{id}","href":"/api-reference/tasks/delete-task"}]},{"group":"Scheduling","pages":[{"title":"List bookable appointment types","deprecated":null,"version":null,"openapi":"/openapi.json get /appointment-types","href":"/api-reference/scheduling/list-bookable-appointment-types"},{"title":"Retrieve an appointment type","deprecated":null,"version":null,"openapi":"/openapi.json get /appointment-types/{id}","href":"/api-reference/scheduling/retrieve-an-appointment-type"},{"title":"Search available slots","deprecated":null,"version":null,"openapi":"/openapi.json get /slots","href":"/api-reference/scheduling/search-available-slots"},{"title":"Reserve a slot","deprecated":null,"version":null,"openapi":"/openapi.json post /reservations","href":"/api-reference/scheduling/reserve-a-slot"},{"title":"Release a slot reservation","deprecated":null,"version":null,"openapi":"/openapi.json delete /reservations/{id}","href":"/api-reference/scheduling/release-a-slot-reservation"},{"title":"List appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /appointments","href":"/api-reference/scheduling/list-appointments"},{"title":"Book an appointment","deprecated":null,"version":null,"openapi":"/openapi.json post /appointments","href":"/api-reference/scheduling/book-an-appointment"},{"title":"Retrieve an appointment","deprecated":null,"version":null,"openapi":"/openapi.json get /appointments/{id}","href":"/api-reference/scheduling/retrieve-an-appointment"},{"title":"Update an appointment","deprecated":null,"version":null,"openapi":"/openapi.json patch /appointments/{id}","href":"/api-reference/scheduling/update-an-appointment"}]},{"group":"Prices","pages":[{"title":"Get Price","deprecated":null,"version":null,"openapi":"/openapi.json get /prices/{price_id}","href":"/api-reference/prices/get-price"}]},{"group":"Products","pages":[{"title":"List Products","deprecated":null,"version":null,"openapi":"/openapi.json get /products","href":"/api-reference/products/list-products"},{"title":"Get Product By Id","deprecated":null,"version":null,"openapi":"/openapi.json get /products/{product_id}","href":"/api-reference/products/get-product-by-id"},{"title":"List Product Prices","description":"Lists every price for a product in your own configuration. No pagination — the product's full price list is returned in one response.","deprecated":null,"version":null,"openapi":"/openapi.json get /products/{product_id}/prices","href":"/api-reference/products/list-product-prices"}]},{"group":"Checkout","pages":[{"title":"Create Checkout Session","deprecated":null,"version":null,"openapi":"/openapi.json post /checkouts/sessions","href":"/api-reference/checkout/create-checkout-session"}]},{"group":"Coupons","pages":[{"title":"List Coupons","description":"Lists all coupons for your configuration.","deprecated":null,"version":null,"openapi":"/openapi.json get /coupons","href":"/api-reference/coupons/list-coupons"},{"title":"Create Coupons","deprecated":null,"version":null,"openapi":"/openapi.json post /coupons","href":"/api-reference/coupons/create-coupons"},{"title":"Get Coupon","deprecated":null,"version":null,"openapi":"/openapi.json get /coupons/{provider_coupon_id}","href":"/api-reference/coupons/get-coupon"},{"title":"Delete Coupon","deprecated":null,"version":null,"openapi":"/openapi.json delete /coupons/{provider_coupon_id}","href":"/api-reference/coupons/delete-coupon"}]},{"group":"Intents","pages":[{"title":"Get Payment Intent","deprecated":null,"version":null,"openapi":"/openapi.json get /intents/payments/{provider_payment_intent_id}","href":"/api-reference/intents/get-payment-intent"},{"title":"Get Setup Intent","deprecated":null,"version":null,"openapi":"/openapi.json get /intents/setups/{provider_setup_intent_id}","href":"/api-reference/intents/get-setup-intent"},{"title":"Create Setup Intent","deprecated":null,"version":null,"openapi":"/openapi.json post /intents/setups","href":"/api-reference/intents/create-setup-intent"}]},{"group":"Invoices","pages":[{"title":"Get Invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /invoices","href":"/api-reference/invoices/get-invoices"},{"title":"Create Invoice Preview","deprecated":null,"version":null,"openapi":"/openapi.json post /invoices/previews","href":"/api-reference/invoices/create-invoice-preview"},{"title":"Pay Invoice","deprecated":null,"version":null,"openapi":"/openapi.json post /invoices/{provider_invoice_id}/payments","href":"/api-reference/invoices/pay-invoice"},{"title":"Create Refund","deprecated":null,"version":null,"openapi":"/openapi.json post /invoices/{provider_invoice_id}/refunds","href":"/api-reference/invoices/create-refund"}]},{"group":"Payment Methods","pages":[{"title":"Get Payment Methods","deprecated":null,"version":null,"openapi":"/openapi.json get /payment-methods","href":"/api-reference/payment-methods/get-payment-methods"}]},{"group":"Promotion Codes","pages":[{"title":"List Promotion Codes","deprecated":null,"version":null,"openapi":"/openapi.json get /promotion-codes","href":"/api-reference/promotion-codes/list-promotion-codes"},{"title":"Create Promotion Code","deprecated":null,"version":null,"openapi":"/openapi.json post /promotion-codes","href":"/api-reference/promotion-codes/create-promotion-code"},{"title":"Deactivate Promotion Code","deprecated":null,"version":null,"openapi":"/openapi.json delete /promotion-codes/{provider_promotion_code_id}","href":"/api-reference/promotion-codes/deactivate-promotion-code"}]},{"group":"Subscriptions","pages":[{"title":"Get Subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /subscriptions","href":"/api-reference/subscriptions/get-subscriptions"},{"title":"Create Subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /subscriptions","href":"/api-reference/subscriptions/create-subscription"},{"title":"Get Subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /subscriptions/{provider_subscription_id}","href":"/api-reference/subscriptions/get-subscription"},{"title":"Update Subscription","deprecated":null,"version":null,"openapi":"/openapi.json put /subscriptions/{provider_subscription_id}","href":"/api-reference/subscriptions/update-subscription"},{"title":"Cancel Subscription","deprecated":null,"version":null,"openapi":"/openapi.json delete /subscriptions/{provider_subscription_id}","href":"/api-reference/subscriptions/cancel-subscription"},{"title":"List Subscription Invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /subscriptions/{provider_subscription_id}/invoices","href":"/api-reference/subscriptions/list-subscription-invoices"},{"title":"Pause Subscription","deprecated":null,"version":null,"openapi":"/openapi.json post /subscriptions/{provider_subscription_id}/pauses","href":"/api-reference/subscriptions/pause-subscription"},{"title":"Resume Subscription","deprecated":null,"version":null,"openapi":"/openapi.json delete /subscriptions/{provider_subscription_id}/pauses","href":"/api-reference/subscriptions/resume-subscription"}]},{"group":"Configs","pages":[{"title":"Get Config","deprecated":null,"version":null,"openapi":"/openapi.json get /configs","href":"/api-reference/configs/get-config"}]},{"group":"Billing Portals","pages":[{"title":"List Billing Portals","deprecated":null,"version":null,"openapi":"/openapi.json get /billing-portals","href":"/api-reference/billing-portals/list-billing-portals"},{"title":"Create Retention Portal Session","deprecated":null,"version":null,"openapi":"/openapi.json post /billing-portals/retention-sessions","href":"/api-reference/billing-portals/create-retention-portal-session"},{"title":"Create Portal Session","deprecated":null,"version":null,"openapi":"/openapi.json post /billing-portals/{provider_billing_portal_id}/sessions","href":"/api-reference/billing-portals/create-portal-session"}]},{"group":"Auth","pages":[]},{"group":"Billing Customers","pages":[{"title":"Get Customers","deprecated":null,"version":null,"openapi":"/openapi.json get /billing-customers","href":"/api-reference/billing-customers/get-customers"},{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/openapi.json post /billing-customers","href":"/api-reference/billing-customers/create-customer"},{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/openapi.json get /billing-customers/{provider_customer_id}","href":"/api-reference/billing-customers/get-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/openapi.json put /billing-customers/{provider_customer_id}","href":"/api-reference/billing-customers/update-customer"},{"title":"List Billing Customer Subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /billing-customers/{provider_customer_id}/subscriptions","href":"/api-reference/billing-customers/list-billing-customer-subscriptions"},{"title":"List Balance Transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /billing-customers/{provider_customer_id}/balance-transactions","href":"/api-reference/billing-customers/list-balance-transactions"},{"title":"Create Balance Transaction","deprecated":null,"version":null,"openapi":"/openapi.json post /billing-customers/{provider_customer_id}/balance-transactions","href":"/api-reference/billing-customers/create-balance-transaction"}]},{"group":"Eligibility","pages":[{"title":"Submit an eligibility verification","deprecated":null,"version":null,"openapi":"/openapi.json post /eligibility-verifications","href":"/api-reference/eligibility/submit-an-eligibility-verification"},{"title":"Retrieve an eligibility verification","deprecated":null,"version":null,"openapi":"/openapi.json get /eligibility-verifications/{id}","href":"/api-reference/eligibility/retrieve-an-eligibility-verification"},{"title":"Submit an insurance discovery","deprecated":null,"version":null,"openapi":"/openapi.json post /insurance-discoveries","href":"/api-reference/eligibility/submit-an-insurance-discovery"},{"title":"Retrieve an insurance discovery","deprecated":null,"version":null,"openapi":"/openapi.json get /insurance-discoveries/{id}","href":"/api-reference/eligibility/retrieve-an-insurance-discovery"},{"title":"Coordinate benefits across payers","deprecated":null,"version":null,"openapi":"/openapi.json post /benefit-coordinations","href":"/api-reference/eligibility/coordinate-benefits-across-payers"},{"title":"Resolve a Medicare Beneficiary Identifier","deprecated":null,"version":null,"openapi":"/openapi.json post /medicare-id-lookups","href":"/api-reference/eligibility/resolve-a-medicare-beneficiary-identifier"},{"title":"Check network status for a payer in a state","deprecated":null,"version":null,"openapi":"/openapi.json post /network-status","href":"/api-reference/eligibility/check-network-status-for-a-payer-in-a-state"}]},{"group":"Payer Directory","pages":[{"title":"List or search payers","deprecated":null,"version":null,"openapi":"/openapi.json get /payers","href":"/api-reference/payer-directory/list-or-search-payers"},{"title":"Retrieve a payer","deprecated":null,"version":null,"openapi":"/openapi.json get /payers/{payer_id}","href":"/api-reference/payer-directory/retrieve-a-payer"}]},{"group":"Patient Passport","pages":[{"title":"Get a patient's Passport profile","deprecated":null,"version":null,"openapi":"/openapi.json get /passport/profile","href":"/api-reference/patient-passport/get-a-patients-passport-profile"},{"title":"List a patient's Passport appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /passport/appointments","href":"/api-reference/patient-passport/list-a-patients-passport-appointments"},{"title":"List a patient's Passport orders","deprecated":null,"version":null,"openapi":"/openapi.json get /passport/orders","href":"/api-reference/patient-passport/list-a-patients-passport-orders"},{"title":"List a patient's Passport subscriptions","deprecated":null,"version":null,"openapi":"/openapi.json get /passport/subscriptions","href":"/api-reference/patient-passport/list-a-patients-passport-subscriptions"},{"title":"Get a patient's Passport journey","deprecated":null,"version":null,"openapi":"/openapi.json get /passport/journey","href":"/api-reference/patient-passport/get-a-patients-passport-journey"}]}]}]},"basePath":"","title":"Create Checkout Session - Partners API Documentation","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}