{
"error": {
"message": "Cannot open a tab in the given currency. Check allowed currency with 'Get Current User' endpoint | Recurring Sales Model is not supported in test mode. | Dynamic message depending on how the price is wrong | The given currency is not enabled for sales | The given currency is not supported by the system",
"code": "tab_currency_not_allowed | recurring_sales_model_not_supported_for_test_clients | invalid_price | currency_not_enabled | currency_not_supported"
}
}
{
"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 | Merchant does not have access to offering",
"code": "client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type | offering_access_not_allowed"
}
}
{
"error": {
"message": "Purchases are not enabled for the merchant | The purchase's currency does not match the tab's currency",
"code": "purchases_not_enabled_for_merchant | currency_mismatch_error"
}
}
Purchases a pre-defined offering by placing it on the customer’s current tab.
Depending on the customer’s existing relationship with Supertab they may be required to make purchases
in a specific currency. Check /customers/me for information on what currency the customer makes purchases in.
If the new purchase causes the tab to become full a payment is required before the purchase will complete.
POST
/
purchases
/
offerings
Error
A valid request URL is required to generate request examples
{
"error": {
"message": "Cannot open a tab in the given currency. Check allowed currency with 'Get Current User' endpoint | Recurring Sales Model is not supported in test mode. | Dynamic message depending on how the price is wrong | The given currency is not enabled for sales | The given currency is not supported by the system",
"code": "tab_currency_not_allowed | recurring_sales_model_not_supported_for_test_clients | invalid_price | currency_not_enabled | currency_not_supported"
}
}
{
"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 | Merchant does not have access to offering",
"code": "client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type | offering_access_not_allowed"
}
}
{
"error": {
"message": "Purchases are not enabled for the merchant | The purchase's currency does not match the tab's currency",
"code": "purchases_not_enabled_for_merchant | currency_mismatch_error"
}
}
Details of what to do next to complete pending purchases
Show child attributes
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":""},"chroma":{"liveDeploymentHistoryId":"6a340f739919529d42026a32","collectionId":"9c179565-a860-4006-b96f-8f17e9a8d6c6","schemaVersion":"v3"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae9227464072a14c6718829:success","clientVersion":"0.0.4054","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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"customer-api/endpoints/purchase-an-offering","slug":"/customer-api/endpoints/purchase-an-offering","pageMetadata":{"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"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Purchases a pre-defined offering by placing it on the customer’s current tab.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Depending 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 }), \"\\n\", _jsx(_components.p, {\n children: \"If the new purchase causes the tab to become full a payment is required before the purchase will complete.\"\n })]\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:write`}),` - Write 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":{"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"}}},"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":"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.","operationId":"purchase-offering","security":["5ef0f92c-00de-4213-ad7f-4a2391121783"],"parameters":["e9cc1ce1-11d0-40e2-945b-afda0e2d1a2a","4058e0f3-2bbc-4ad6-b8a2-6f1a5b782703"],"requestBody":"2fd229f0-60fc-49df-9348-1ec23f1c9f1a","responses":{"201":"7c2c912a-65e3-47c3-8629-6394eb649bf5","400":"7a8bef29-bf8a-47b5-a49e-8ceeb88e3e61","401":"6f362508-bd76-4cd4-84cd-f2d548774afd","403":"c42f116d-4ab3-4f07-bf97-2996cec733b7","404":"af47010e-5c1a-400f-8ce5-755067307261","409":"c2c9fc81-224c-475b-acb5-9c9af20a04bf","422":"1be9def9-1dfc-42f8-a73e-d9e7e7587ff6"},"method":"post","type":"path","servers":["fe955e79-97ae-4236-8fba-69915f967126"],"path":"/purchases/offerings","baseUrlOptions":["/capi"],"title":"Purchase an offering","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e9cc1ce1-11d0-40e2-945b-afda0e2d1a2a":{"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"}}},"4058e0f3-2bbc-4ad6-b8a2-6f1a5b782703":{"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."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"offering_id":{"type":"string","format":"tagged_id","title":"Offering Id","examples":["offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9"],"isRequired":true,"uniqueKey":"offering_id","typeLabel":"string\u003ctagged_id>"},"currency_code":{"type":"string","maxLength":3,"minLength":3,"title":"Currency Code","isRequired":true,"uniqueKey":"currency_code","typeLabel":"string"},"metadata":{"additionalProperties":{"oneOf":[{"type":"number","uniqueKey":"metadata.additionalProperties.oneOf.0","typeLabel":"number"},{"type":"boolean","uniqueKey":"metadata.additionalProperties.oneOf.1","typeLabel":"boolean"},{"type":"integer","uniqueKey":"metadata.additionalProperties.oneOf.2","typeLabel":"integer"},{"type":"string","uniqueKey":"metadata.additionalProperties.oneOf.3","typeLabel":"string"},{"type":"null","uniqueKey":"metadata.additionalProperties.oneOf.4","typeLabel":"null"}],"uniqueKey":"metadata.additionalProperties","typeLabel":"number | boolean | integer | string | null"},"type":"object","title":"Metadata","default":{},"uniqueKey":"metadata","typeLabel":"Metadata · object"}},"type":"object","required":["offering_id","currency_code"],"title":"PurchaseOfferingRequest","uniqueKey":"","typeLabel":"PurchaseOfferingRequest · object"},"examples":{"Example":{"title":"Example","value":{"offering_id":"offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9","currency_code":"\u003cstring>","metadata":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"7c2c912a-65e3-47c3-8629-6394eb649bf5":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"purchase":{"oneOf":[{"type":"object","title":"Purchase","description":"Purchase created as a result of purchasing this offering.\n\nA null value means no purchase was created, see action_required_details for the reason.","required":["id","offering_id","onetime_offering_id","purchased_at","completed_at","description","price","status","metadata","entitlement_status"],"properties":{"id":{"oneOf":[{"type":"string","title":"Id","description":"When a Purchase has been made with you, shows the ID of the Purchase. Otherwise obfuscated and is shown as `null`.","format":"tagged_id","example":"purchase.cf637646-71a4-430d-aaea-a66f1a48a83c","isRequired":true,"uniqueKey":"purchase.oneOf.0.id.oneOf.0","typeLabel":"string\u003ctagged_id>"},{"type":"null","title":"Id","description":"When a Purchase has been made with you, shows the ID of the Purchase. Otherwise obfuscated and is shown as `null`.","example":"purchase.cf637646-71a4-430d-aaea-a66f1a48a83c","isRequired":true,"uniqueKey":"purchase.oneOf.0.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"purchase.oneOf.0.id","typeLabel":"string\u003ctagged_id> | null"},"offering_id":{"oneOf":[{"type":"string","title":"Offering Id","description":"Which offering was purchased, if this purchase resulted from purchasing a pre-defined offering.","format":"tagged_id","example":"offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9","isRequired":true,"uniqueKey":"purchase.oneOf.0.offering_id.oneOf.0","typeLabel":"string\u003ctagged_id>"},{"type":"null","title":"Offering Id","description":"Which offering was purchased, if this purchase resulted from purchasing a pre-defined offering.","isRequired":true,"uniqueKey":"purchase.oneOf.0.offering_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"purchase.oneOf.0.offering_id","typeLabel":"string\u003ctagged_id> | null"},"onetime_offering_id":{"oneOf":[{"type":"string","title":"Onetime Offering Id","description":"Which one-time offering was purchased, if this purchase resulted from purchasing a one-time offering.","format":"tagged_id","example":"onetime_offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9","isRequired":true,"uniqueKey":"purchase.oneOf.0.onetime_offering_id.oneOf.0","typeLabel":"string\u003ctagged_id>"},{"type":"null","title":"Onetime Offering Id","description":"Which one-time offering was purchased, if this purchase resulted from purchasing a one-time offering.","isRequired":true,"uniqueKey":"purchase.oneOf.0.onetime_offering_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"purchase.oneOf.0.onetime_offering_id","typeLabel":"string\u003ctagged_id> | null"},"purchased_at":{"oneOf":[{"type":"string","title":"Purchased At","description":"The time the purchase completed.","format":"date-time","example":"2025-01-01T12:00:00Z","isRequired":true,"uniqueKey":"purchase.oneOf.0.purchased_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Purchased At","description":"The time the purchase completed.","example":"2025-01-01T12:00:00Z","isRequired":true,"uniqueKey":"purchase.oneOf.0.purchased_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"purchase.oneOf.0.purchased_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","title":"Completed At","description":"The time the purchase completed.\n\nWhere Supertab requires a payment this will be null until the payment completes.","format":"date-time","example":"2025-01-01T12:00:00Z","isRequired":true,"uniqueKey":"purchase.oneOf.0.completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Completed At","description":"The time the purchase completed.\n\nWhere Supertab requires a payment this will be null until the payment completes.","example":"2025-01-01T12:00:00Z","isRequired":true,"uniqueKey":"purchase.oneOf.0.completed_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"purchase.oneOf.0.completed_at","typeLabel":"string\u003cdate-time> | null"},"description":{"type":"string","title":"Description","description":"A summary of the purchase, usually including the site name and the type of a given entitlement.","examples":["The Leek - 24 Hours Time Pass","1 Month Subscription"],"isRequired":true,"uniqueKey":"purchase.oneOf.0.description","typeLabel":"string"},"price":{"properties":{"amount":{"type":"integer","title":"Amount","description":"Price amount expressed in currency base units","examples":[50],"isRequired":true,"uniqueKey":"purchase.oneOf.0.price.amount","typeLabel":"integer"},"currency":{"properties":{"code":{"type":"string","title":"Code","description":"ISO2417 currency code","examples":["USD"],"isRequired":true,"uniqueKey":"purchase.oneOf.0.price.currency.code","typeLabel":"string"},"name":{"type":"string","title":"Name","description":"Full name","examples":["US Dollar"],"isRequired":true,"uniqueKey":"purchase.oneOf.0.price.currency.name","typeLabel":"string"},"symbol":{"type":"string","title":"Symbol","description":"Unicode currency symbol","examples":["$"],"isRequired":true,"uniqueKey":"purchase.oneOf.0.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":"purchase.oneOf.0.price.currency.base_unit","typeLabel":"integer"}},"type":"object","required":["code","name","symbol","base_unit"],"title":"Currency","description":"The price's currency","isRequired":true,"uniqueKey":"purchase.oneOf.0.price.currency","typeLabel":"Currency · object"}},"type":"object","required":["amount","currency"],"title":"Price","description":"An amount of money","isRequired":true,"uniqueKey":"purchase.oneOf.0.price","typeLabel":"Price · object"},"status":{"type":"string","enum":["completed","pending","abandoned"],"title":"PurchaseStatus","description":"The status of the purchase.\n\nPurchases may be pending or completed.\n\nOnly completed purchases grant access, pending purchases are purchases which require payment before entitlement is granted","isRequired":true,"uniqueKey":"purchase.oneOf.0.status","typeLabel":"enum\u003cstring>"},"metadata":{"additionalProperties":{"oneOf":[{"type":"number","uniqueKey":"purchase.oneOf.0.metadata.additionalProperties.oneOf.0","typeLabel":"number"},{"type":"boolean","uniqueKey":"purchase.oneOf.0.metadata.additionalProperties.oneOf.1","typeLabel":"boolean"},{"type":"integer","uniqueKey":"purchase.oneOf.0.metadata.additionalProperties.oneOf.2","typeLabel":"integer"},{"type":"string","uniqueKey":"purchase.oneOf.0.metadata.additionalProperties.oneOf.3","typeLabel":"string"},{"type":"null","uniqueKey":"purchase.oneOf.0.metadata.additionalProperties.oneOf.4","typeLabel":"null"}],"uniqueKey":"purchase.oneOf.0.metadata.additionalProperties","typeLabel":"number | boolean | integer | string | null"},"type":"object","title":"Metadata","description":"Freeform metadata associated with the purchase.\n\nThis can be used for e.g associating the purchase with a user identifier in your system","default":{},"isRequired":true,"uniqueKey":"purchase.oneOf.0.metadata","typeLabel":"Metadata · object"},"entitlement_status":{"oneOf":[{"type":"object","title":"EntitlementStatus","description":"The customer's access (if any) as a result of this purchase","required":["content_key","has_entitlement","expires","recurs_at"],"properties":{"content_key":{"type":"string","title":"Content Key","description":"The content_key being checked","examples":["site.cf637646-71a4-430d-aaea-a66f1a48a83c"],"isRequired":true,"uniqueKey":"purchase.oneOf.0.entitlement_status.oneOf.0.content_key","typeLabel":"string"},"has_entitlement":{"type":"boolean","title":"Has Entitlement","description":"If the customer has access to this content","isRequired":true,"uniqueKey":"purchase.oneOf.0.entitlement_status.oneOf.0.has_entitlement","typeLabel":"boolean"},"expires":{"oneOf":[{"type":"string","title":"Expires","description":"When the customer's access will expire","format":"date-time","isRequired":true,"uniqueKey":"purchase.oneOf.0.entitlement_status.oneOf.0.expires.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Expires","description":"When the customer's access will expire","isRequired":true,"uniqueKey":"purchase.oneOf.0.entitlement_status.oneOf.0.expires.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"purchase.oneOf.0.entitlement_status.oneOf.0.expires","typeLabel":"string\u003cdate-time> | null"},"recurs_at":{"oneOf":[{"type":"string","title":"Recurs At","description":"If this access is a result of a subscription, the time the subscription will renew unless cancelled by the customer.","format":"date-time","isRequired":true,"uniqueKey":"purchase.oneOf.0.entitlement_status.oneOf.0.recurs_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Recurs At","description":"If this access is a result of a subscription, the time the subscription will renew unless cancelled by the customer.","isRequired":true,"uniqueKey":"purchase.oneOf.0.entitlement_status.oneOf.0.recurs_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"purchase.oneOf.0.entitlement_status.oneOf.0.recurs_at","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"purchase.oneOf.0.entitlement_status.oneOf.0","typeLabel":"EntitlementStatus · object"},{"type":"null","description":"The customer's access (if any) as a result of this purchase","isRequired":true,"uniqueKey":"purchase.oneOf.0.entitlement_status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"purchase.oneOf.0.entitlement_status","typeLabel":"EntitlementStatus · object | null"}},"isRequired":true,"uniqueKey":"purchase.oneOf.0","typeLabel":"Purchase · object"},{"type":"null","description":"Purchase created as a result of purchasing this offering.\n\nA null value means no purchase was created, see action_required_details for the reason.","isRequired":true,"uniqueKey":"purchase.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"purchase","typeLabel":"Purchase · object | null"},"action_required":{"type":"boolean","title":"Action Required","description":"Determines if further interaction with the customer required on Supertab in order to complete this purchase.\n\nMost commonly this will be when Supertab required a customer to make a payment before continuing.","isRequired":true,"uniqueKey":"action_required","typeLabel":"boolean"},"action_required_details":{"oneOf":[{"type":"object","title":"ActionRequiredDetails","description":"Details of what to do next to complete pending purchases","required":["next","reason"],"properties":{"next":{"type":"string","title":"Next","description":"Forward the user here to start e.g. a checkout session which should then be opened in a pop-up window.","examples":["https://checkout.supertab.co?tab_id=tab.13de9ebb-83bd-4aeb-80aa-6f2a21c1be69"],"isRequired":true,"uniqueKey":"action_required_details.oneOf.0.next","typeLabel":"string"},"reason":{"type":"string","title":"Reason","description":"Describes why action should be taken","examples":["Payment required to complete purchase","Before you can make new purchases, payment is required"],"isRequired":true,"uniqueKey":"action_required_details.oneOf.0.reason","typeLabel":"string"}},"isRequired":true,"uniqueKey":"action_required_details.oneOf.0","typeLabel":"ActionRequiredDetails · object"},{"type":"null","description":"Details of what to do next to complete pending purchases","isRequired":true,"uniqueKey":"action_required_details.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"action_required_details","typeLabel":"ActionRequiredDetails · object | null"}},"type":"object","required":["purchase","action_required","action_required_details"],"title":"OfferingPurchaseResult","uniqueKey":"","typeLabel":"OfferingPurchaseResult · object"},"examples":{"Example":{"title":"Example","value":{"purchase":{"id":"purchase.cf637646-71a4-430d-aaea-a66f1a48a83c","offering_id":"offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9","onetime_offering_id":"onetime_offering.4df706b5-297a-49c5-a4cd-2a10eca12ff9","purchased_at":"2025-01-01T12:00:00Z","completed_at":"2025-01-01T12:00:00Z","description":"The Leek - 24 Hours Time Pass","price":{"amount":50,"currency":{"code":"USD","name":"US Dollar","symbol":"$","base_unit":100}},"status":"completed","metadata":{},"entitlement_status":{"content_key":"site.cf637646-71a4-430d-aaea-a66f1a48a83c","has_entitlement":true,"expires":"2023-11-07T05:31:56Z","recurs_at":"2023-11-07T05:31:56Z"}},"action_required":true,"action_required_details":{"next":"https://checkout.supertab.co?tab_id=tab.13de9ebb-83bd-4aeb-80aa-6f2a21c1be69","reason":"Payment required to complete purchase"}}}},"exampleType":"generated"}},"exampleType":"generated"},"7a8bef29-bf8a-47b5-a49e-8ceeb88e3e61":{"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":"Bad Request","uniqueKey":"","typeLabel":"Bad Request · object"},"example":{"error":{"message":"Cannot open a tab in the given currency. Check allowed currency with 'Get Current User' endpoint | Recurring Sales Model is not supported in test mode. | Dynamic message depending on how the price is wrong | The given currency is not enabled for sales | The given currency is not supported by the system","code":"tab_currency_not_allowed | recurring_sales_model_not_supported_for_test_clients | invalid_price | currency_not_enabled | currency_not_supported"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Cannot open a tab in the given currency. Check allowed currency with 'Get Current User' endpoint | Recurring Sales Model is not supported in test mode. | Dynamic message depending on how the price is wrong | The given currency is not enabled for sales | The given currency is not supported by the system","code":"tab_currency_not_allowed | recurring_sales_model_not_supported_for_test_clients | invalid_price | currency_not_enabled | currency_not_supported"}}}},"exampleType":"examples"}},"description":"Bad Request","exampleType":"examples"},"6f362508-bd76-4cd4-84cd-f2d548774afd":{"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"},"c42f116d-4ab3-4f07-bf97-2996cec733b7":{"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 | Merchant does not have access to offering","code":"client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type | offering_access_not_allowed"}},"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 | Merchant does not have access to offering","code":"client_id_mismatch | missing_or_invalid_x_supertab_client_id | invalid_subject_type | offering_access_not_allowed"}}}},"exampleType":"examples"}},"description":"Forbidden","exampleType":"examples"},"af47010e-5c1a-400f-8ce5-755067307261":{"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":"No offering price found","code":"offering_price_not_found"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"No offering price found","code":"offering_price_not_found"}}}},"exampleType":"examples"}},"description":"Not Found","exampleType":"examples"},"c2c9fc81-224c-475b-acb5-9c9af20a04bf":{"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":"Conflict","uniqueKey":"","typeLabel":"Conflict · object"},"example":{"error":{"message":"Purchases are not enabled for the merchant | The purchase's currency does not match the tab's currency","code":"purchases_not_enabled_for_merchant | currency_mismatch_error"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Purchases are not enabled for the merchant | The purchase's currency does not match the tab's currency","code":"purchases_not_enabled_for_merchant | currency_mismatch_error"}}}},"exampleType":"examples"}},"description":"Conflict","exampleType":"examples"},"1be9def9-1dfc-42f8-a73e-d9e7e7587ff6":{"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":{"5ef0f92c-00de-4213-ad7f-4a2391121783":{"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:write"]}}},"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:write"]},"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":"Purchase an offering - Supertab docs","navMaps":{"firstHrefInVersion":{"2025-04-01":{"href":"/customer-api/endpoints/purchase-an-offering","matchLevel":0},"v3":{"href":"/supertab-js/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-01-22T10:51:53.624Z","originalFileLocation":"customer-api/endpoints/purchase-an-offering.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=\"Purchases a pre-defined offering by placing it on the customer\u0026#x27;s current tab. Depending on the customer\u0026#x27;s existing relationship with Supertab they may be required to make purchases in a specific currency. Check /customers/me for information on what currency the customer makes purchases in. If the new purchase causes the tab to become full a payment is required before the purchase will complete.\">\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=\"Purchase an offering - Supertab docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Purchases a pre-defined offering by placing it on the customer\u0026#x27;s current tab. Depending on the customer\u0026#x27;s existing relationship with Supertab they may be required to make purchases in a specific currency. Check /customers/me for information on what currency the customer makes purchases in. If the new purchase causes the tab to become full a payment is required before the purchase will complete.\">\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/purchase-an-offering\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://supertab.mintlify.app/_mintlify/api/og/v2?division=Endpoints\u0026amp;title=Purchase+an+offering\u0026amp;description=Purchases+a+pre-defined+offering+by+placing+it+on+the+customer%27s+current+tab.%0A%0ADepending+on+the+customer%27s+existing+relationship+with+Supertab+they+may+be+requi\u0026amp;theme=f8f57096d3469e3d3e9bab6c\u0026amp;signature=aa42be125c4ad160a9e11e1b9bf108cc2d7db794d4fb9f1bff11fc01bf20439b\">\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=\"Purchase an offering - Supertab docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Purchases a pre-defined offering by placing it on the customer\u0026#x27;s current tab. Depending on the customer\u0026#x27;s existing relationship with Supertab they may be required to make purchases in a specific currency. Check /customers/me for information on what currency the customer makes purchases in. If the new purchase causes the tab to become full a payment is required before the purchase will complete.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://supertab.mintlify.app/_mintlify/api/og/v2?division=Endpoints\u0026amp;title=Purchase+an+offering\u0026amp;description=Purchases+a+pre-defined+offering+by+placing+it+on+the+customer%27s+current+tab.%0A%0ADepending+on+the+customer%27s+existing+relationship+with+Supertab+they+may+be+requi\u0026amp;theme=f8f57096d3469e3d3e9bab6c\u0026amp;signature=aa42be125c4ad160a9e11e1b9bf108cc2d7db794d4fb9f1bff11fc01bf20439b\">\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/purchase-an-offering\">\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/purchase-an-offering.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/purchase-an-offering#webpage\",\"url\":\"https://docs.supertab.co/customer-api/endpoints/purchase-an-offering\",\"name\":\"Purchase an offering\",\"description\":\"Purchases a pre-defined offering by placing it on the customer's current tab. Depending on the customer's existing relationship with Supertab they may be required to make purchases in a specific currency. Check /customers/me for information on what currency the customer makes purchases in. If the new purchase causes the tab to become full a payment is required before the purchase will complete.\",\"dateModified\":\"2026-01-22T10:51:53.624Z\",\"isPartOf\":{\"@id\":\"https://docs.supertab.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.supertab.co/customer-api/endpoints/purchase-an-offering#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.supertab.co/customer-api/endpoints/purchase-an-offering#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.supertab.co/customer-api/endpoints/retrieve-customer\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Purchase an offering\",\"item\":\"https://docs.supertab.co/customer-api/endpoints/purchase-an-offering\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.supertab.co/customer-api/endpoints/purchase-an-offering#apireference\",\"headline\":\"Purchase an offering\",\"name\":\"Purchase an offering\",\"description\":\"Purchases a pre-defined offering by placing it on the customer's current tab. Depending on the customer's existing relationship with Supertab they may be required to make purchases in a specific currency. Check /customers/me for information on what currency the customer makes purchases in. If the new purchase causes the tab to become full a payment is required before the purchase will complete.\",\"url\":\"https://docs.supertab.co/customer-api/endpoints/purchase-an-offering\",\"mainEntityOfPage\":{\"@id\":\"https://docs.supertab.co/customer-api/endpoints/purchase-an-offering#webpage\"},\"dateModified\":\"2026-01-22T10:51:53.624Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","href":"/customer-api/endpoints/retrieve-customer"},{"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"},{"openapi":"post /purchases/offerings","title":"Purchase an offering","href":"/customer-api/endpoints/purchase-an-offering"},{"openapi":"get /onetime_offerings/{onetime_offering_id}","title":"Retrieve a one-time offering","description":"Retrieves 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":"Purchase an offering - Supertab docs","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","clsx-B2v50t8t.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DJnKvr0g.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BHrrjR1K.js"]}