{
"error": {
"message": "The Bearer token does not match the x-supertab-client-id header | Missing or invalid x-supertab-client-id | Invalid subject type {request_subject_type} found, {expected_token_type} expected",
"code": "client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type"
}
}
{
"error": {
"message": "Currency not found | No offering price found | Site not found.",
"code": "currency_not_found | offering_price_not_found | site_not_found"
}
}
Retrieves information about the current site, identified by the Client ID.
The response contains information about all the available offerings, configuration for the experiences
(e.g. paygates and buttons), and some other metadata.
GET
/
site
Error
A valid request URL is required to generate request examples
{
"error": {
"message": "The Bearer token does not match the x-supertab-client-id header | Missing or invalid x-supertab-client-id | Invalid subject type {request_subject_type} found, {expected_token_type} expected",
"code": "client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type"
}
}
{
"error": {
"message": "Currency not found | No offering price found | Site not found.",
"code": "currency_not_found | offering_price_not_found | site_not_found"
}
}
Whether the merchant has the white-label option enabled. When True, Supertab surfaces (paywall, button, checkout) should render the white-labelled version with Supertab branding removed.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Supertab docs","colors":{"primary":"#0A0E1A","light":"#F3F3F4","dark":"#0A0E1A"},"logo":{"light":"https://mintcdn.com/supertab/bP-daIW8qZO4pzbo/logo/light.svg?fit=max\u0026auto=format\u0026n=bP-daIW8qZO4pzbo\u0026q=85\u0026s=47631a4a02f7428d1c2479d804aea54d","dark":"https://mintcdn.com/supertab/bP-daIW8qZO4pzbo/logo/dark.svg?fit=max\u0026auto=format\u0026n=bP-daIW8qZO4pzbo\u0026q=85\u0026s=0fae8412d2464504a082bd910292aa43"},"favicon":"https://mintcdn.com/supertab/nIjMo5xiY0_gRI-4/favicon.webp?fit=max\u0026auto=format\u0026n=nIjMo5xiY0_gRI-4\u0026q=85\u0026s=419af455c4dcfc9b93f2893e0ccec259","api":{"playground":{"display":"simple"}},"navbar":{"links":[{"href":"https://support.supertab.co/hc/en-us/requests/new","label":"Support"}],"primary":{"type":"button","label":"Business Portal","href":"https://business.supertab.co"}},"footer":{"socials":{"x":"https://x.com/getsupertab","linkedin":"https://www.linkedin.com/company/supertab"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"supertab","hasAudioNarration":false,"actualSubdomain":"supertab","customDomains":["docs.supertab.co"],"gitSource":{"type":"github","owner":"laterpay","repo":"supertab-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae9227464072a14c6718829:success","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":27},{"language":"default","tag":"Supertab.js","count":14},{"language":"default","tag":"Customer API","count":12},{"language":"default","tag":"Documentation","count":11},{"language":"default","tag":"Endpoints","count":9},{"language":"default","tag":"Merchant API","count":6},{"language":"default","tag":"Introduction","count":5},{"language":"default","tag":"Supertab Experiences","count":5},{"language":"default","tag":"Reference","count":4},{"language":"default","tag":"Integrate","count":3}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@supertab.co"}},"basePath":"","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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"customer-api/endpoints/retrieve-site","slug":"/customer-api/endpoints/retrieve-site","pageMetadata":{"title":"Retrieve website","openapi":"get /site","description":"Retrieves information about the current site, identified by the Client ID.\nThe response contains information about all the available offerings, configuration for the experiences\n(e.g. paygates and buttons), and some other metadata.","href":"/customer-api/endpoints/retrieve-site"},"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: \"Retrieves information about the current site, identified by the Client ID.\\nThe response contains information about all the available offerings, configuration for the experiences\\n(e.g. paygates and buttons), and some other metadata.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(`div`,{class:`mint-flex mint-items-baseline mint-border-b mint-pb-2.5 mint-border-gray-100 dark:mint-border-gray-800 mint-w-full`,children:_jsx(Heading,{level:`4`,id:`required-scopes`,class:`mint-flex-1 mint-mb-0`,children:`Required Scopes`})}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.code,{children:`capi:read`}),` - Read access to Customer API resources`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve website","openapi":"get /site","description":"Retrieves information about the current site, identified by the Client ID.\nThe response contains information about all the available offerings, configuration for the experiences\n(e.g. paygates and buttons), and some other metadata.","href":"/customer-api/endpoints/retrieve-site"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Required Scopes","slug":"required-scopes","depth":4,"children":[]}],"codeExamples":{}},"jsLinks":[],"dynamicCss":".mint-mb-0 {\n margin-bottom: 0px\n}\n.mint-flex {\n display: flex\n}\n.mint-w-full {\n width: 100%\n}\n.mint-flex-1 {\n flex: 1 1 0%\n}\n.mint-items-baseline {\n align-items: baseline\n}\n.mint-border-b {\n border-bottom-width: 1px\n}\n.mint-border-gray-100 {\n --tw-border-opacity: 1;\n border-color: rgb(243 244 246 / var(--tw-border-opacity, 1))\n}\n.mint-pb-2\\.5 {\n padding-bottom: 0.625rem\n}\n.dark\\:mint-border-gray-800:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(31 41 55 / var(--tw-border-opacity, 1))\n}","openApiReferenceData":{"operation":{"tags":["Customer"],"summary":"Retrieve inventory available for sale.","description":"Retrieves information about the current site, identified by the Client ID.\nThe response contains information about all the available offerings, configuration for the experiences\n(e.g. paygates and buttons), and some other metadata.","operationId":"retrieve-site","security":["d275a134-b16c-497c-abee-938d9937e1b2"],"parameters":["67e3c2fe-0a4e-423d-9bff-f8bf80789618","46944522-64bc-49e6-a2e9-6a00daf2c576"],"responses":{"200":"136a417e-d60b-40be-9d08-10314e75c6f8","401":"73c0a43c-55f7-4ef8-8e73-92c01a4ba78e","403":"b786f6fb-f190-4ab9-9fdc-26f5ff6b2708","404":"1caae37a-ffbd-4b10-9deb-4ea2c42f49a4","422":"2aa46558-2e75-4716-ba4c-8082d95530a8"},"method":"get","type":"path","servers":["fe955e79-97ae-4236-8fba-69915f967126"],"path":"/site","baseUrlOptions":["/capi"],"title":"Retrieve inventory available for sale.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"67e3c2fe-0a4e-423d-9bff-f8bf80789618":{"name":"x-api-version","in":"header","required":false,"schema":{"type":"string","format":"date","title":"Customer API version","description":"The version of the Customer API you are using.","default":"2025-04-01","isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"The version of the Customer API you are using.","examples":{"default":{"value":"2025-04-01"}}},"46944522-64bc-49e6-a2e9-6a00daf2c576":{"name":"x-supertab-client-id","in":"header","required":true,"schema":{"title":"Client Id","type":"string","format":"tagged_id","examples":["live_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9","test_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"],"isRequired":true,"description":"Your Client ID with Supertab. Used to identify the website on which Customer is making a Purchase.","uniqueKey":"","typeLabel":"string\u003ctagged_id>"},"description":"Your Client ID with Supertab. Used to identify the website on which Customer is making a Purchase."}},"responses":{"136a417e-d60b-40be-9d08-10314e75c6f8":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the site","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"url":{"type":"string","minLength":1,"format":"uri","title":"Url","description":"URL of the site. Supertab will not authenticate customers unless this matches the domain you are serving from.","examples":["https://supertab.co"],"isRequired":true,"uniqueKey":"url","typeLabel":"string\u003curi>"},"auth_redirect_uri":{"type":"string","minLength":1,"format":"uri","title":"Auth Redirect Uri","description":"Passed to Supertab when authenticating customers on this site","examples":["https://signon.supertab.co/auth-proxy"],"isRequired":true,"uniqueKey":"auth_redirect_uri","typeLabel":"string\u003curi>"},"logo_url":{"oneOf":[{"type":"string","title":"Logo Url","description":"The URL of the logo for this site provided to Supertab","format":"uri","minLength":1,"isRequired":true,"uniqueKey":"logo_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","title":"Logo Url","description":"The URL of the logo for this site provided to Supertab","isRequired":true,"uniqueKey":"logo_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"logo_url","typeLabel":"string\u003curi> | null"},"content_keys":{"items":{"type":"string","uniqueKey":"content_keys.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Content Keys","description":"List of content_keys to use when checking entitlement to your site.","isRequired":true,"uniqueKey":"content_keys","typeLabel":"string[]"},"offerings":{"items":{"properties":{"id":{"type":"string","title":"Id","examples":["offering.cf637646-71a4-430d-aaea-a66f1a48a83c"],"isRequired":true,"uniqueKey":"offerings.items.[INDEX].id","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"Customer facing name for the offering.","examples":["1 week access to theleek.com"],"isRequired":true,"uniqueKey":"offerings.items.[INDEX].description","typeLabel":"string"},"entitlement_details":{"oneOf":[{"type":"object","title":"Entitlement","description":"Specifies the nature and duration of purchased entitlement.\n\nWhere you have chosen to have Supertab manage entitlements for you, customer's purchasing such an offering will be granted entitlement to the content associated with the offering for the length of time specified.","required":["duration","is_recurring","content_key"],"example":{"content_key":"site.cf637646-71a4-430d-aaea-a66f1a48a83c","duration":"1w","is_recurring":false},"properties":{"duration":{"type":"string","maxLength":9,"minLength":2,"pattern":"^\\d*[s|m|h|d|w|M|y]$","title":"Duration","description":"Duration of the timepass, as `{length}{unit}`.\n\nPossible units:\n\n| **Directive** | **Meaning** |\n| ------------- | ------------- |\n| y | years |\n| M | months |\n| w | weeks |\n| d | days |\n| h | hours |\n| m | minutes |\n| s | seconds |\n\nExamples:\n\n```\n{\n // 1 year\n \"duration\": \"1y\",\n // 2 months\n \"duration\": \"2M\",\n // 3 weeks\n \"duration\": \"3w\",\n // 4 days\n \"duration\": \"4d\",\n // 5 hours\n \"duration\": \"5h\",\n // 6 minutes\n \"duration\": \"6m\",\n // 7 seconds\n \"duration\": \"7s\"\n}\n```","isRequired":true,"uniqueKey":"offerings.items.[INDEX].entitlement_details.oneOf.0.duration","typeLabel":"string"},"is_recurring":{"type":"boolean","title":"Is Recurring","description":"Is entitlement sold on a recurring (subscription) basis","isRequired":true,"uniqueKey":"offerings.items.[INDEX].entitlement_details.oneOf.0.is_recurring","typeLabel":"boolean"},"content_key":{"type":"string","title":"Content Key","description":"The content key being purchased, if you have chosen to have Supertab manage customer entitlement for you.","isRequired":true,"uniqueKey":"offerings.items.[INDEX].entitlement_details.oneOf.0.content_key","typeLabel":"string"}},"isRequired":true,"uniqueKey":"offerings.items.[INDEX].entitlement_details.oneOf.0","typeLabel":"Entitlement · object"},{"type":"null","description":"Specifies the nature and duration of purchased entitlement.\n\nWhere you have chosen to have Supertab manage entitlements for you, customer's purchasing such an offering will be granted entitlement to the content associated with the offering for the length of time specified.","example":{"content_key":"site.cf637646-71a4-430d-aaea-a66f1a48a83c","duration":"1w","is_recurring":false},"isRequired":true,"uniqueKey":"offerings.items.[INDEX].entitlement_details.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"offerings.items.[INDEX].entitlement_details","typeLabel":"Entitlement · object | null"},"price":{"properties":{"amount":{"type":"integer","title":"Amount","description":"Price amount expressed in currency base units","examples":[50],"isRequired":true,"uniqueKey":"offerings.items.[INDEX].price.amount","typeLabel":"integer"},"currency":{"properties":{"code":{"type":"string","title":"Code","description":"ISO2417 currency code","examples":["USD"],"isRequired":true,"uniqueKey":"offerings.items.[INDEX].price.currency.code","typeLabel":"string"},"name":{"type":"string","title":"Name","description":"Full name","examples":["US Dollar"],"isRequired":true,"uniqueKey":"offerings.items.[INDEX].price.currency.name","typeLabel":"string"},"symbol":{"type":"string","title":"Symbol","description":"Unicode currency symbol","examples":["$"],"isRequired":true,"uniqueKey":"offerings.items.[INDEX].price.currency.symbol","typeLabel":"string"},"base_unit":{"type":"integer","title":"Base Unit","description":"The relationship between the currency's minor and major unit.\n\nFor most currencies including USD \u0026 EUR this will be `100`. For currencies which do not use decimals (e.g JPY) this will `1`","examples":[100],"isRequired":true,"uniqueKey":"offerings.items.[INDEX].price.currency.base_unit","typeLabel":"integer"}},"type":"object","required":["code","name","symbol","base_unit"],"title":"Currency","description":"The price's currency","isRequired":true,"uniqueKey":"offerings.items.[INDEX].price.currency","typeLabel":"Currency · object"}},"type":"object","required":["amount","currency"],"title":"Price","description":"The price of this offering.\n\nThe available price is customer-aware when possible, Supertab restricts some customers to certain currencies depending on their location and prior interactions with Supertab.","isRequired":true,"uniqueKey":"offerings.items.[INDEX].price","typeLabel":"Price · object"},"is_pay_now":{"type":"boolean","title":"Is Pay Now","description":"Offering requires upfront payment, customer will be taken to checkout immediately on purchase.\n\nUsed to control Call To Action during purchase confirmation.","isRequired":true,"uniqueKey":"offerings.items.[INDEX].is_pay_now","typeLabel":"boolean"},"guest_checkout_available":{"type":"boolean","title":"Guest Checkout Available","description":"Whether this offering is eligible for guest checkout in the displayed currency. When True, the frontend can initiate a guest checkout session for this offering.","isRequired":true,"uniqueKey":"offerings.items.[INDEX].guest_checkout_available","typeLabel":"boolean"}},"type":"object","required":["id","description","entitlement_details","price","is_pay_now","guest_checkout_available"],"title":"Offering","uniqueKey":"offerings.items.[INDEX]","typeLabel":"Offering · object"},"type":"array","title":"Offerings","description":"Offerings are what is available for customers to purchase.\n\nYou can define your available offerings in the [Supertab Business Portal](https://business.supertab.co/).","isRequired":true,"uniqueKey":"offerings","typeLabel":"Offering · object[]"},"experiences":{"items":{"properties":{"id":{"type":"string","title":"Id","description":"The experience ID","examples":["experience.cf637646-71a4-430d-aaea-a66f1a48a83c"],"isRequired":true,"uniqueKey":"experiences.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","title":"Name","description":"The experience name","isRequired":true,"uniqueKey":"experiences.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["basic_paygate","basic_supertab_button","rich_paygate","rich_supertab_button"],"title":"ExperienceType","description":"The type of the experience, used by Supertab to determine how to display the experience UI","isRequired":true,"uniqueKey":"experiences.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"offerings":{"items":{"type":"string","format":"tagged_id","examples":["offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9"],"uniqueKey":"experiences.items.[INDEX].offerings.items.[INDEX]","typeLabel":"string\u003ctagged_id>"},"type":"array","title":"Offerings","description":"List of offering IDs attached to this experience.\n\nThis includes all possible offerings sold by this experience, details of how to display these to customers are found in `ui_config`.","isRequired":true,"uniqueKey":"experiences.items.[INDEX].offerings","typeLabel":"string\u003ctagged_id>[]"},"configuration":{"properties":{"ui_config":{"additionalProperties":true,"type":"object","title":"Ui Config","description":"Used by Supertab to control look, feel \u0026 branding","isRequired":true,"uniqueKey":"experiences.items.[INDEX].configuration.ui_config","typeLabel":"Ui Config · object"},"on_close":{"oneOf":[{"type":"string","title":"On Close","description":"Used by Supertab to control experience dismissal behaviour","isRequired":true,"uniqueKey":"experiences.items.[INDEX].configuration.on_close.oneOf.0","typeLabel":"string"},{"type":"null","title":"On Close","description":"Used by Supertab to control experience dismissal behaviour","isRequired":true,"uniqueKey":"experiences.items.[INDEX].configuration.on_close.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"experiences.items.[INDEX].configuration.on_close","typeLabel":"string | null"},"upsells":{"items":{"properties":{"main_offering":{"type":"string","format":"tagged_id","title":"Main Offering","examples":["offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9"],"isRequired":true,"uniqueKey":"experiences.items.[INDEX].configuration.upsells.items.[INDEX].main_offering","typeLabel":"string\u003ctagged_id>"},"upsell_offering":{"type":"string","format":"tagged_id","title":"Upsell Offering","examples":["offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9"],"isRequired":true,"uniqueKey":"experiences.items.[INDEX].configuration.upsells.items.[INDEX].upsell_offering","typeLabel":"string\u003ctagged_id>"},"discount":{"type":"number","title":"Discount","isRequired":true,"uniqueKey":"experiences.items.[INDEX].configuration.upsells.items.[INDEX].discount","typeLabel":"number"}},"type":"object","required":["main_offering","upsell_offering","discount"],"title":"Upsell","uniqueKey":"experiences.items.[INDEX].configuration.upsells.items.[INDEX]","typeLabel":"Upsell · object"},"type":"array","title":"Upsells","default":[],"deprecated":true,"isRequired":true,"uniqueKey":"experiences.items.[INDEX].configuration.upsells","typeLabel":"Upsell · object[]"}},"type":"object","required":["ui_config","on_close","upsells"],"title":"ExperienceConfiguration","isRequired":true,"uniqueKey":"experiences.items.[INDEX].configuration","typeLabel":"ExperienceConfiguration · object"}},"type":"object","required":["id","name","type","offerings","configuration"],"title":"Experience","uniqueKey":"experiences.items.[INDEX]","typeLabel":"Experience · object"},"type":"array","title":"Experiences","description":"When using Supertab to manage your sales UI, this list of experiences contains the information we use to display an Experience to your customers.","isRequired":true,"uniqueKey":"experiences","typeLabel":"Experience · object[]"},"test_mode":{"type":"boolean","title":"Test Mode","description":"See Test Mode's [Documentation](https://docs.supertab.co/supertab-experiences/test-mode) for details","isRequired":true,"uniqueKey":"test_mode","typeLabel":"boolean"},"white_label":{"type":"boolean","title":"White Label","description":"Whether the merchant has the white-label option enabled. When True, Supertab surfaces (paywall, button, checkout) should render the white-labelled version with Supertab branding removed.","default":false,"isRequired":true,"uniqueKey":"white_label","typeLabel":"boolean"}},"type":"object","required":["name","url","auth_redirect_uri","logo_url","content_keys","offerings","experiences","test_mode","white_label"],"title":"Site","description":"A site is any website, SaaS product or any other place you deploy Supertab.\n\nIt is the top level object in your inventory and contains all offerings.","uniqueKey":"","typeLabel":"Site · object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","url":"https://supertab.co","auth_redirect_uri":"https://signon.supertab.co/auth-proxy","logo_url":"\u003cstring>","content_keys":["\u003cstring>"],"offerings":[{"id":"offering.cf637646-71a4-430d-aaea-a66f1a48a83c","description":"1 week access to theleek.com","entitlement_details":{"content_key":"site.cf637646-71a4-430d-aaea-a66f1a48a83c","duration":"1w","is_recurring":false},"price":{"amount":50,"currency":{"code":"USD","name":"US Dollar","symbol":"$","base_unit":100}},"is_pay_now":true,"guest_checkout_available":true}],"experiences":[{"id":"experience.cf637646-71a4-430d-aaea-a66f1a48a83c","name":"\u003cstring>","type":"basic_paygate","offerings":["offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9"],"configuration":{"ui_config":{},"on_close":"\u003cstring>","upsells":[]}}],"test_mode":true,"white_label":false}}},"exampleType":"generated"}},"exampleType":"generated"},"73c0a43c-55f7-4ef8-8e73-92c01a4ba78e":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"A codename for the error","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable error message","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","title":"Unauthorized","uniqueKey":"","typeLabel":"Unauthorized · object"},"example":{"error":{"message":"Invalid authentication credentials","code":"invalid_credentials"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Invalid authentication credentials","code":"invalid_credentials"}}}},"exampleType":"examples"}},"description":"Unauthorized","exampleType":"examples"},"b786f6fb-f190-4ab9-9fdc-26f5ff6b2708":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"A codename for the error","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable error message","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","title":"Forbidden","uniqueKey":"","typeLabel":"Forbidden · object"},"example":{"error":{"message":"The Bearer token does not match the x-supertab-client-id header | Missing or invalid x-supertab-client-id | Invalid subject type {request_subject_type} found, {expected_token_type} expected","code":"client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"The Bearer token does not match the x-supertab-client-id header | Missing or invalid x-supertab-client-id | Invalid subject type {request_subject_type} found, {expected_token_type} expected","code":"client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type"}}}},"exampleType":"examples"}},"description":"Forbidden","exampleType":"examples"},"1caae37a-ffbd-4b10-9deb-4ea2c42f49a4":{"content":{"application/json":{"schema":{"properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"A codename for the error","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable error message","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","title":"Not Found","uniqueKey":"","typeLabel":"Not Found · object"},"example":{"error":{"message":"Currency not found | No offering price found | Site not found.","code":"currency_not_found | offering_price_not_found | site_not_found"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Currency not found | No offering price found | Site not found.","code":"currency_not_found | offering_price_not_found | site_not_found"}}}},"exampleType":"examples"}},"description":"Not Found","exampleType":"examples"},"2aa46558-2e75-4716-ba4c-8082d95530a8":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"error":{"type":"array","description":"A general error code and message accompanied by the list of attributes that failed validation","items":{"type":"object","properties":{"code":{"type":"string","description":"A short generic error code","uniqueKey":"error.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable error message","uniqueKey":"error.items.[INDEX].message","typeLabel":"string"},"errors":{"type":"array","description":"A list of attributes that failed validation","items":{"type":"object","properties":{"attribute":{"type":"string","description":"The path to the attribute that failed validation","uniqueKey":"error.items.[INDEX].errors.items.[INDEX].attribute","typeLabel":"string"},"code":{"type":"string","description":"An error code of this attribute's specific validation error","uniqueKey":"error.items.[INDEX].errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"A human-readable error message of this attribute's specific validation error","uniqueKey":"error.items.[INDEX].errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"error.items.[INDEX].errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.items.[INDEX].errors","typeLabel":"object[]"}},"uniqueKey":"error.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error","typeLabel":"object[]"}},"type":"object","title":"Validation Error","uniqueKey":"","typeLabel":"Validation Error · object"},"example":{"error":[{"code":"validation_error","message":"Validation Error","errors":[{"attribute":"query -> subject","code":"missing","message":"field required"}]}]},"examples":{"Example":{"title":"Example","value":{"error":[{"code":"validation_error","message":"Validation Error","errors":[{"attribute":"query -> subject","code":"missing","message":"field required"}]}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"d275a134-b16c-497c-abee-938d9937e1b2":{"oauth":{"type":"oauth2","description":"Supertab OAuth2 flow for CAPI. See [Authentication](/customer-api/authentication).","flows":{"authorizationCode":{"scopes":{"capi:read":"Access to view capi","capi:write":"Access to write for capi"},"authorizationUrl":"https://auth.supertab.co/oauth2/auth","tokenUrl":"https://auth.supertab.co/oauth2/token"}},"scopes":["capi:read"]}}},"servers":{"fe955e79-97ae-4236-8fba-69915f967126":{"url":"/capi"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"Supertab OAuth2 flow for CAPI. See [Authentication](/customer-api/authentication).","flows":{"authorizationCode":{"scopes":{"capi:read":"Access to view capi","capi:write":"Access to write for capi"},"authorizationUrl":"https://auth.supertab.co/oauth2/auth","tokenUrl":"https://auth.supertab.co/oauth2/token"}},"scopes":["capi:read"]},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"Supertab OAuth2 flow for CAPI. See [Authentication](/customer-api/authentication).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth","name":"Authorization"}],"title":"oauth"}]},"originalFileLocation":"customer-api/openapi-2025-04-01.json"},"subdomain":"supertab","siteName":"Supertab docs","title":"Retrieve website - Supertab docs","navMaps":{"firstHrefInVersion":{"2025-04-01":{"href":"/customer-api/endpoints/retrieve-site","matchLevel":0},"v3":{"href":"/supertab-js/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-03-02T17:09:03.600Z","originalFileLocation":"customer-api/endpoints/retrieve-site.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=\"Retrieves information about the current site, identified by the Client ID. The response contains information about all the available offerings, configuration for the experiences (e.g. paygates and buttons), and some other metadata.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Supertab docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/supertab/24UJgC29HVwRWzPH/_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/supertab/24UJgC29HVwRWzPH/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/supertab/24UJgC29HVwRWzPH/_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/supertab/24UJgC29HVwRWzPH/_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/supertab/24UJgC29HVwRWzPH/_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/supertab/24UJgC29HVwRWzPH/_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/supertab/24UJgC29HVwRWzPH/_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/supertab/24UJgC29HVwRWzPH/_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/supertab/24UJgC29HVwRWzPH/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve website - Supertab docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves information about the current site, identified by the Client ID. The response contains information about all the available offerings, configuration for the experiences (e.g. paygates and buttons), and some other metadata.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Supertab docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.supertab.co/customer-api/endpoints/retrieve-site\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://supertab.mintlify.site/_mintlify/api/og/v2?division=Endpoints\u0026amp;title=Retrieve+website\u0026amp;description=Retrieves+information+about+the+current+site%2C+identified+by+the+Client+ID.%0AThe+response+contains+information+about+all+the+available+offerings%2C+configuration+fo\u0026amp;theme=a787be16a1efd3a0409f7aca\u0026amp;signature=f60b84b9bd19656dbf3415bdea3e3d4681f462bdb5d83d52192227f09056d2e8\">\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=\"Retrieve website - Supertab docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves information about the current site, identified by the Client ID. The response contains information about all the available offerings, configuration for the experiences (e.g. paygates and buttons), and some other metadata.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://supertab.mintlify.site/_mintlify/api/og/v2?division=Endpoints\u0026amp;title=Retrieve+website\u0026amp;description=Retrieves+information+about+the+current+site%2C+identified+by+the+Client+ID.%0AThe+response+contains+information+about+all+the+available+offerings%2C+configuration+fo\u0026amp;theme=a787be16a1efd3a0409f7aca\u0026amp;signature=f60b84b9bd19656dbf3415bdea3e3d4681f462bdb5d83d52192227f09056d2e8\">\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/supertab/24UJgC29HVwRWzPH/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Supertab docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0A0E1A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.supertab.co/customer-api/endpoints/retrieve-site\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/customer-api/endpoints/retrieve-site.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.supertab.co/#organization\",\"name\":\"Supertab docs\",\"url\":\"https://docs.supertab.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/supertab/bP-daIW8qZO4pzbo/logo/light.svg?fit=max\u0026auto=format\u0026n=bP-daIW8qZO4pzbo\u0026q=85\u0026s=47631a4a02f7428d1c2479d804aea54d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.supertab.co#website\",\"name\":\"Supertab docs\",\"url\":\"https://docs.supertab.co\",\"publisher\":{\"@id\":\"https://docs.supertab.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.supertab.co/customer-api/endpoints/retrieve-site#webpage\",\"url\":\"https://docs.supertab.co/customer-api/endpoints/retrieve-site\",\"name\":\"Retrieve website\",\"description\":\"Retrieves information about the current site, identified by the Client ID. The response contains information about all the available offerings, configuration for the experiences (e.g. paygates and buttons), and some other metadata.\",\"dateModified\":\"2026-03-02T17:09:03.600Z\",\"isPartOf\":{\"@id\":\"https://docs.supertab.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.supertab.co/customer-api/endpoints/retrieve-site#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.supertab.co/customer-api/endpoints/retrieve-site#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.supertab.co/customer-api/endpoints/retrieve-customer\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve website\",\"item\":\"https://docs.supertab.co/customer-api/endpoints/retrieve-site\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.supertab.co/customer-api/endpoints/retrieve-site#apireference\",\"headline\":\"Retrieve website\",\"name\":\"Retrieve website\",\"description\":\"Retrieves information about the current site, identified by the Client ID. The response contains information about all the available offerings, configuration for the experiences (e.g. paygates and buttons), and some other metadata.\",\"url\":\"https://docs.supertab.co/customer-api/endpoints/retrieve-site\",\"mainEntityOfPage\":{\"@id\":\"https://docs.supertab.co/customer-api/endpoints/retrieve-site#webpage\"},\"dateModified\":\"2026-03-02T17:09:03.600Z\",\"publisher\":{\"@id\":\"https://docs.supertab.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.supertab.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Supertab docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Supertab docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/customer-api/endpoints/retrieve-site.md","siteName":"Supertab docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/supertab-introduction/overview/about-supertab"}]},{"tab":"Updates","pages":[{"title":"Updates","href":"/updates/product"}]},{"tab":"Supertab.js","versions":[{"version":"v3","groups":[{"group":"Supertab.js","pages":[{"title":"Getting Started","href":"/supertab-js/introduction"},{"title":"Installation","href":"/supertab-js/installation"}]},{"group":"Experiences","pages":[{"title":"Paywall Experiences","href":"/supertab-js/experiences/paywall"}]},{"group":"API Reference","pages":[{"title":"SDK Overview","sidebarTitle":"Overview","href":"/supertab-js/reference/overview"},{"title":"Supertab.createPaygate","tag":"DEPRECATED","href":"/supertab-js/reference/create-paygate"},{"title":"Supertab.createPaywall","href":"/supertab-js/reference/create-paywall"},{"title":"Supertab.createPurchaseButton","href":"/supertab-js/reference/purchase-button"},{"title":"Supertab.createPurchase","sidebarTitle":"Supertab.createPurchase","href":"/supertab-js/reference/create-purchase"},{"title":"Supertab.auth","href":"/supertab-js/reference/auth"},{"title":"Supertab.api","href":"/supertab-js/reference/api"},{"title":"Supertab.checkout","href":"/supertab-js/reference/checkout"},{"title":"Errors","href":"/supertab-js/reference/errors"}]}]}]},{"tab":"API Reference","dropdowns":[{"dropdown":"Customer API","icon":"browsers","versions":[{"version":"2025-04-01","groups":[{"group":"Introduction","pages":[{"title":"Customer API","sidebarTitle":"Customer API","icon":"browsers","href":"/customer-api/overview"}]},{"group":"Reference","pages":[{"title":"Authentication","sidebarTitle":"Authentication","icon":"lock","href":"/customer-api/authentication"},{"title":"Versioning","sidebarTitle":"Versioning \u0026 Changes","icon":"calendar-clock","href":"/customer-api/versioning"}]},{"group":"Guides","pages":[{"title":"Making a Purchase","icon":"circle-dollar-to-slot","href":"/customer-api/making-a-purchase"},{"title":"Check for Entitlements, including Prior Entitlements","sidebarTitle":"Check for Entitlements","icon":"check","href":"/customer-api/entitlements"}]},{"group":"Endpoints","pages":[{"title":"Retrieve current customer","openapi":"GET /customers/me","description":"Retrieve the current customer.\n\nIf the user is authenticated, retrieve the customer's current tab.\n\nFor unauthenticated requests, retrieve a predicted currency and tab limit based on the user's location.","href":"/customer-api/endpoints/retrieve-customer"},{"title":"Retrieve website","openapi":"get /site","href":"/customer-api/endpoints/retrieve-site"},{"openapi":"post /purchases/offerings","title":"Purchase an offering","description":"Purchases a pre-defined offering by placing it on the customer's current tab.\n\nDepending on the customer's existing relationship with Supertab they may be required to make purchases\nin a specific currency. Check /customers/me for information on what currency the customer makes purchases in.\n\nIf the new purchase causes the tab to become full a payment is required before the purchase will complete.","href":"/customer-api/endpoints/purchase-an-offering"},{"openapi":"get /onetime_offerings/{onetime_offering_id}","title":"Retrieve a one-time offering","href":"/customer-api/endpoints/retrieve-a-one-time-offering"},{"openapi":"post /purchases/onetime_offerings","title":"Purchase a one-time offering","href":"/customer-api/endpoints/purchase-a-one-time-offering"},{"openapi":"get /purchases/{purchase_id}","title":"Retrieve a purchase","href":"/customer-api/endpoints/retrieve-a-purchase"},{"openapi":"get /entitlements/{content_key}","title":"Retrieve entitlement status","href":"/customer-api/endpoints/retrieve-entitlement-status"}]}]}]},{"dropdown":"Merchant API","icon":"server","versions":[{"version":"2025-04-01","groups":[{"group":"Introduction","pages":[{"title":"Merchant API","sidebarTitle":"Merchant API","icon":"server","href":"/merchant-api/overview"}]},{"group":"Reference","pages":[{"title":"Authentication","sidebarTitle":"Authentication","icon":"lock","href":"/merchant-api/authentication"},{"title":"Versioning","sidebarTitle":"Versioning \u0026 Changes","icon":"calendar-clock","href":"/merchant-api/versioning"}]},{"group":"Endpoints","pages":[{"title":"Create New One-Time Offering","openapi":"post /onetime_offerings","href":"/merchant-api/endpoints/create-onetime-offering"},{"title":"Retrieve a One-Time Offering","openapi":"get /onetime_offerings/{onetime_offering_id}","href":"/merchant-api/endpoints/retrieve-onetime-offering"}]},{"group":"Webhooks","pages":[{"title":"Consuming Webhooks","sidebarTitle":"Consuming Webhooks","icon":"globe","href":"/merchant-api/webhooks/consuming-webhooks"}]}]}]}]}]},"basePath":"","title":"Retrieve website - Supertab docs","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}