{
"message": "Internal server error",
"statusCode": 500
}
Authorizations
HTTPBasicOAuth2PasswordBearer
Authorization
string
header
required
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
consumerOfferId
string<uuid>
required
Identifier of the consumer offer
Query Parameters
awaitStatus
enum<string>
Consumer offer status to wait for:
FULLY_CREATED: all entitlements have been created
FULLY_ACTIVE: all entitlements are active
FULLY_TERMINATED: all entitlements have been terminated
Available options:
FULLY_CREATED,
FULLY_ACTIVE,
FULLY_TERMINATED
timeout
string
How long you wish to wait for the response.
ISO 8601 duration format, between 1 and 10 seconds e.g. PT10S
Response
Ok
Consumer offer in a get response.
consumerOffer
ConsumerOfferDetail · object
required
Consumer offer detail
Show child attributes
entitlements
Entitlement · object[]
required
Entitlements created under this consumer offer.
Show child attributes
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Bango product documentation","description":"Product and API documentation for Bango Digital Vending Machine® (DVM™) and Direct Carrier Billing (DCB), including integration and operations guides.","colors":{"primary":"#006272","light":"#00b9d5","dark":"#00333d"},"logo":{"light":"https://mintcdn.com/bango/6QC7Ytb7V743Uvvu/logo/bango_logo_dark.png?fit=max\u0026auto=format\u0026n=6QC7Ytb7V743Uvvu\u0026q=85\u0026s=3ef75914dc0e2776bcbbe94129f2130e","dark":"https://mintcdn.com/bango/6QC7Ytb7V743Uvvu/logo/bango_logo_white.png?fit=max\u0026auto=format\u0026n=6QC7Ytb7V743Uvvu\u0026q=85\u0026s=fcc3106ce2bfe8533216f946e31ff2d7"},"favicon":"https://mintcdn.com/bango/-YQLPEjairNlbNNj/images/favicon.png?fit=max\u0026auto=format\u0026n=-YQLPEjairNlbNNj\u0026q=85\u0026s=9c1390956defba1de35137e307237b72","api":{"openapi":["openapi/current/dvm/reseller-to-dvm/offer/openapi.yaml","openapi/current/dvm/reseller-to-dvm/product/openapi.yaml","openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json","openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml","openapi/current/dvm/dvm-to-reseller/notification/openapi.yaml","openapi/current/dvm/dvm-to-reseller/eligibility/openapi.yaml","openapi/current/dvm/dvm-to-reseller/charge/openapi.json","openapi/current/dvm/dvm-to-content-provider/entitlement/openapi.yaml","openapi/current/dvm/content-provider-to-dvm/entitlement/openapi.yaml","openapi/legacy/payments/merchant-to-bango/openapi.yaml","openapi/legacy/payments/payment-provider-to-bango/openapi.yaml","openapi/legacy/resale/bango-to-content-provider/openapi.yaml","openapi/legacy/resale/bango-to-reseller/openapi.yaml","openapi/legacy/resale/content-provider-to-bango/openapi.yaml","openapi/legacy/resale/reseller-to-bango/openapi.yaml","openapi/legacy/subscriptions/bango-to-partner/openapi.yaml","openapi/legacy/subscriptions/partner-to-bango/openapi.yaml","openapi/current/dcb-payments/bango-to-payment-provider/openapi.yaml","openapi/current/dcb-payments/merchant-to-bango/identity-token/openapi.yaml","openapi/current/dcb-payments/merchant-to-bango/identity-verification/openapi.yaml","openapi/current/dcb-payments/merchant-to-bango/payments/openapi.yaml","openapi/current/dcb-payments/payment-provider-to-bango/openapi.yaml"],"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","javascript","python"],"autogenerate":true},"url":"full","mdx":{"auth":{"method":"basic"}}},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#ffffff","dark":"#15181a"}},"navbar":{"links":[{"href":"https://bango.com","label":"Website"},{"href":"https://bango.com/category/blogs/","label":"Blog"},{"href":"mailto:support@bango.com","label":"Support"}],"primary":{"type":"button","label":"Enter DVM","href":"https://dvm.bango.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/bango"}},"fonts":{"family":"Arial"},"icons":{"library":"fontawesome"},"styling":{"eyebrows":"breadcrumbs","latex":true},"contextual":{"options":["copy","chatgpt","claude","vscode","download-spec"],"display":"header"},"markdown":{"schema":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bango","hasAudioNarration":false,"actualSubdomain":"bango","customDomains":["docs.bango.com"],"gitSource":{"type":"gitlab","owner":"bango/public-documentation","repo":"mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":78224299,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af5e495cf5b122bc79c89c2","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Legacy","count":140},{"language":"default","tag":"Resale","count":61},{"language":"default","tag":"Docs","count":59},{"language":"default","tag":"Reseller","count":47},{"language":"default","tag":"DCB Payments v5","count":39},{"language":"default","tag":"APIs","count":38},{"language":"default","tag":"Subscriptions","count":27},{"language":"default","tag":"Entitlements","count":23},{"language":"default","tag":"API Reference","count":22},{"language":"default","tag":"DCB","count":21}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@bango.com","showHelpButton":true}},"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}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--bango-pink: #CE0058;--bango-pink-light: #F5D6E4;--bango-purple: #470A68;--bango-teal-dark: #006272;--bango-teal-light: #008578;--bango-teal-light-bg: #E9F2F3}.nav-tabs{display:flex!important;justify-content:flex-start!important;width:auto!important;gap:0!important}.nav-tabs-item{flex:none!important;width:6rem!important;min-width:6rem!important;justify-content:center!important}#navbar .nav-tabs-item svg[style*=\"mask-image\"]{display:block;background-color:currentColor!important;mask-repeat:no-repeat;mask-position:center;mask-size:contain;-webkit-mask-repeat:no-repeat;-webkit-mask-position:center;-webkit-mask-size:contain}#navbar{border-bottom:none!important}#navbar .nav-tabs-item.border-primary,#navbar .nav-tabs-item[aria-current=\"page\"]{border-bottom:2px solid var(--bango-teal-dark)!important;margin-bottom:-2px!important}#navbar .nav-logo{height:3.0625rem!important;width:auto!important}#navbar a[href].bg-primary,#navbar button.bg-primary,#navbar .nav-bar-btn-primary,#navbar a.nav-bar-btn-primary{background-color:var(--bango-teal-dark)!important;color:white!important;border-color:var(--bango-teal-dark)}#navbar a[href].bg-primary:hover,#navbar button.bg-primary:hover,#navbar .nav-bar-btn-primary:hover{background-color:var(--bango-teal-light)!important;border-color:var(--bango-teal-light)}#sidebar-title,.sidebar-group-header h5,#sidebar-content .sidebar-group-header h5{color:#111827!important;font-weight:700!important}.nav-tag-pill,#sidebar-content .sidebar-group-header [class*=\"tag\"],.sidebar .sidebar-group-header [class*=\"tag\"],#sidebar-content .sidebar-group-header .badge,.sidebar .sidebar-group-header .badge{background-color:var(--bango-pink-light)!important;color:var(--bango-pink)!important;font-size:0.65rem!important;font-weight:600!important;text-transform:lowercase!important;padding:0.15rem 0.4rem!important;border-radius:9999px!important}.dark .nav-tag-pill,.dark #sidebar-content .sidebar-group-header [class*=\"tag\"],.dark .sidebar .sidebar-group-header [class*=\"tag\"],.dark #sidebar-content .sidebar-group-header .badge,.dark .sidebar .sidebar-group-header .badge{background-color:rgba(206, 0, 88, 0.25)!important;color:#F9A8C4!important}.dark #sidebar-title,.dark .sidebar-group-header h5,.dark #sidebar-content .sidebar-group-header h5{color:#e5e7eb!important}#sidebar-content #sidebar-group a,.sidebar #sidebar-group a{color:#4b5563!important;font-weight:400!important;padding:0.375rem 0.75rem!important;border-radius:9999px!important}#sidebar-content #sidebar-group a:hover,.sidebar #sidebar-group a:hover{color:#111827!important;background-color:#f3f4f6!important}#sidebar-content #sidebar-group a:hover,.sidebar #sidebar-group a:hover,#sidebar-content #sidebar-group a.border-primary,#sidebar-content #sidebar-group a.text-primary.border-primary,.sidebar a.border-primary{box-shadow:none!important}.dark #sidebar-content #sidebar-group a:hover,.dark .sidebar #sidebar-group a:hover,.dark #sidebar-content #sidebar-group a.border-primary,.dark .sidebar a.border-primary{box-shadow:none!important}.dark #sidebar-content #sidebar-group a,.dark .sidebar #sidebar-group a{color:#9ca3af!important}.dark #sidebar-content #sidebar-group a:hover,.dark .sidebar #sidebar-group a:hover{color:#e5e7eb!important;background-color:rgba(255, 255, 255, 0.08)!important}#sidebar-content #sidebar-group a.border-primary,#sidebar-content #sidebar-group a.text-primary.border-primary,.sidebar a.border-primary{background-color:var(--bango-teal-light-bg)!important;color:#111827!important;border-color:transparent!important;font-weight:400!important}#sidebar-content #sidebar-group a.border-primary *,.sidebar a.border-primary *{color:inherit!important;font-weight:inherit!important}#sidebar-content #sidebar-group a [class*=\"tag\"],.sidebar #sidebar-group a [class*=\"tag\"],#sidebar-content #sidebar-group a .badge,.sidebar #sidebar-group a .badge{color:unset!important;font-weight:unset!important;background:unset!important;border:unset!important;box-shadow:unset!important}.dark #sidebar-content #sidebar-group a.border-primary,.dark .sidebar a.border-primary{background-color:rgba(0, 98, 114, 0.2)!important;color:#e5e7eb!important}#content-area a:not(.nav-bar-btn-primary):not([class*=\"btn\"]):not(.capability-tile-link){color:var(--bango-teal-dark)}#content-area a:not(.nav-bar-btn-primary):not([class*=\"btn\"]):not(.capability-tile-link):hover{color:var(--bango-pink)}footer{border-top:2px solid var(--bango-teal-light)}.capabilities-grid{display:grid;grid-template-columns:repeat(auto-fill, minmax(260px, 1fr));gap:1.25rem;margin:1.5rem 0;align-items:stretch}.capability-tile-link{display:block;min-height:200px;height:100%;text-decoration:none!important;color:inherit;border-bottom:none!important;box-shadow:none!important}.capability-tile-link:hover{text-decoration:none!important}.capability-tile-link::after{display:none!important}.capability-tile{background:white;border:1px solid #d1d5db;border-radius:0.75rem;padding:1.5rem;min-height:200px;height:100%;display:flex;flex-direction:column;transition:border-color 0.2s ease, box-shadow 0.2s ease}.capability-tile:hover{border-color:var(--bango-teal-dark);box-shadow:0 4px 12px rgba(0, 98, 114, 0.12)}.capability-icon{display:block;margin-bottom:0.75rem}.capability-title{display:block;font-weight:700;font-size:1rem;color:#111827;margin-bottom:0.5rem}.capability-tile p{color:#4b5563;font-size:0.9375rem;line-height:1.5;margin:0;flex:1}.dark .capability-tile{background:rgba(255, 255, 255, 0.05);border-color:rgba(255, 255, 255, 0.15)}.dark .capability-tile:hover{border-color:var(--bango-teal-light);box-shadow:0 4px 12px rgba(0, 133, 120, 0.2)}.dark .capability-title{color:#e5e7eb}.dark .capability-tile p{color:#9ca3af}"}],"page":{"pagePath":"api-reference/consumer-offers/get-consumer-offer-by-id","slug":"/api-reference/consumer-offers/get-consumer-offer-by-id","pageMetadata":{"title":"Get Consumer Offer By Id","description":"Get Consumer Offer by ID.","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json get /consumerOffers/{consumerOfferId}","href":"/api-reference/consumer-offers/get-consumer-offer-by-id","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get Consumer Offer by ID.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Consumer Offer By Id","description":"Get Consumer Offer by ID.","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json get /consumerOffers/{consumerOfferId}","href":"/api-reference/consumer-offers/get-consumer-offer-by-id","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Consumer Offers"],"summary":"Get Consumer Offer By Id","description":"Get Consumer Offer by ID.","operationId":"Get_Consumer_Offer_by_ID_consumerOffers__consumerOfferId__get","security":["e5013787-c8c7-46e9-ae20-0c1bdec1d9e3","77ce6e8d-cc0b-48f8-b54f-b475dec0fdb5"],"parameters":["d83c17ae-3e6e-4e5b-8462-4fb33fbd501a","3a589fd5-6268-4a01-9b8b-911c6c7e4ef6","e826ee49-6065-479c-a5d5-4a06403e1e48"],"responses":{"200":"615766be-f94a-4cba-b84a-7945ea8a10db","400":"c382a958-5d34-4146-adfc-85dcaa509f36","401":"a962456e-8f68-49a6-8f4f-f0507973695e","404":"60a254e5-45e6-4724-a0d8-3ae7044634d5","500":"03cf5a09-8d79-42d9-973c-806134ca291c"},"method":"get","type":"path","servers":[],"path":"/consumerOffers/{consumerOfferId}","baseUrlOptions":[],"title":"Get Consumer Offer By Id","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","urlDisplay":"full"},"dependencies":{"parameters":{"d83c17ae-3e6e-4e5b-8462-4fb33fbd501a":{"name":"consumerOfferId","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Identifier of the consumer offer","title":"Consumerofferid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Identifier of the consumer offer"},"3a589fd5-6268-4a01-9b8b-911c6c7e4ef6":{"name":"awaitStatus","in":"query","required":false,"schema":{"type":"string","enum":["FULLY_CREATED","FULLY_ACTIVE","FULLY_TERMINATED"],"title":"ConsumerOfferStatusFilter","description":"Consumer offer status to wait for:\n* `FULLY_CREATED`: all entitlements have been created\n* `FULLY_ACTIVE`: all entitlements are active\n* `FULLY_TERMINATED`: all entitlements have been terminated\n","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Consumer offer status to wait for:\n* `FULLY_CREATED`: all entitlements have been created\n* `FULLY_ACTIVE`: all entitlements are active\n* `FULLY_TERMINATED`: all entitlements have been terminated\n"},"e826ee49-6065-479c-a5d5-4a06403e1e48":{"name":"timeout","in":"query","required":false,"schema":{"type":"string","description":"How long you wish to wait for the response.\nISO 8601 duration format, between 1 and 10 seconds e.g. PT10S","title":"Timeout","isRequired":false,"uniqueKey":"","typeLabel":"string"},"description":"How long you wish to wait for the response.\nISO 8601 duration format, between 1 and 10 seconds e.g. PT10S"}},"responses":{"615766be-f94a-4cba-b84a-7945ea8a10db":{"description":"Ok","content":{"application/json":{"schema":{"properties":{"consumerOffer":{"properties":{"consumerOfferId":{"type":"string","format":"uuid","title":"Consumerofferid","description":"A globally unique and immutable identifier of the Consumer Offer","examples":["338d31e1-a289-40dd-beff-ab41c1fc5f51"],"isRequired":true,"uniqueKey":"consumerOffer.consumerOfferId","typeLabel":"string\u003cuuid>"},"offerId":{"type":"string","format":"uuid","title":"Offer ID","description":"A globally unique and immutable identifier of the offer the consumer has subcribed to.","examples":["7560fca0-d8a9-4124-a172-924debec874e"],"isRequired":true,"uniqueKey":"consumerOffer.offerId","typeLabel":"string\u003cuuid>"},"consumer":{"properties":{"consumerIdentifier":{"type":"string","maxLength":400,"title":"Consumeridentifier","description":"Consumer identifier","isRequired":true,"uniqueKey":"consumerOffer.consumer.consumerIdentifier","typeLabel":"string"},"billingIdentifier":{"type":"string","title":"Billingidentifier","description":"Billing identifier","uniqueKey":"consumerOffer.consumer.billingIdentifier","typeLabel":"string"},"communicationInformation":{"properties":{"emailAddress":{"type":"string","title":"Emailaddress","description":"An email address that can be used to contact the consumer.","uniqueKey":"consumerOffer.consumer.communicationInformation.emailAddress","typeLabel":"string"},"msisdn":{"type":"string","title":"Msisdn","description":"A mobile phone number that can be used to contact the consumer, with international prefix","uniqueKey":"consumerOffer.consumer.communicationInformation.msisdn","typeLabel":"string"}},"type":"object","title":"Communicationinformation","description":"Communication channel with the consumer. May be used to send reminders or important information.","uniqueKey":"consumerOffer.consumer.communicationInformation","typeLabel":"Communicationinformation · object"}},"type":"object","required":["consumerIdentifier"],"title":"Consumer","description":"Consumer data.","isRequired":true,"uniqueKey":"consumerOffer.consumer","typeLabel":"Consumer · object"},"status":{"type":"string","enum":["REQUESTED","PARTIALLY_CREATED","FULLY_CREATED","CREATES_FAILED","FULLY_ACTIVE","FULLY_TERMINATED","PARTIALLY_TERMINATED"],"title":"ConsumerOfferStatus","description":"Consumer offer status:\n\n* `REQUESTED`: creation of the consumer offer was requested\n* `PARTIALLY_CREATED`: some entitlement were created, but others failed\n* `FULLY_CREATED`: all entitlements have been created\n* `CREATES_FAILED`: all entitlements failed to be created\n* `FULLY_ACTIVE`: all entitlements are active\n* `FULLY_TERMINATED`: all entitlements have been terminated\n* `PARTIALLY_TERMINATED`: some entitlement terminated succesfully, some terminations failed\n","isRequired":true,"uniqueKey":"consumerOffer.status","typeLabel":"enum\u003cstring>"},"timeline":{"properties":{"createRequestedTs":{"type":"string","format":"date-time","title":"Createrequestedts","description":"Date creation of the offer was requested","isRequired":true,"uniqueKey":"consumerOffer.timeline.createRequestedTs","typeLabel":"string\u003cdate-time>"},"createdTs":{"type":"string","format":"date-time","title":"Createdts","description":"Date the offer was created","uniqueKey":"consumerOffer.timeline.createdTs","typeLabel":"string\u003cdate-time>"},"createsFailedTs":{"type":"string","format":"date-time","title":"Createsfailedts","description":"Date the offer failed to be created","uniqueKey":"consumerOffer.timeline.createsFailedTs","typeLabel":"string\u003cdate-time>"},"entitlementsRequestedTs":{"type":"string","format":"date-time","title":"Entitlementsrequestedts","description":"Date the entitlements for the offer were requested","uniqueKey":"consumerOffer.timeline.entitlementsRequestedTs","typeLabel":"string\u003cdate-time>"},"terminateRequestedTs":{"type":"string","format":"date-time","title":"Terminaterequestedts","description":"Date the entitlements for the offer were terminated","uniqueKey":"consumerOffer.timeline.terminateRequestedTs","typeLabel":"string\u003cdate-time>"},"plannedCancellationTs":{"type":"string","format":"date-time","title":"Plannedcancellationts","description":"Scheduled date and time for cancel","uniqueKey":"consumerOffer.timeline.plannedCancellationTs","typeLabel":"string\u003cdate-time>"}},"type":"object","required":["createRequestedTs"],"title":"ConsumerOfferTimeline","description":"Timeline of changes made to the consumer offer","isRequired":true,"uniqueKey":"consumerOffer.timeline","typeLabel":"ConsumerOfferTimeline · object"},"subStatus":{"type":"string","enum":["PENDING_ACTION","PENDING_CREATES","PENDING_ACTIVATES","PENDING_TERMINATES","PENDING_CANCELS"],"title":"Substatus","description":"Consumer offer sub-status:\n\n* `PENDING_ACTION`: consumer offer creation is pending an action\n* `PENDING_CREATES`: entitlement creation is pending\n* `PENDING_ACTIVATES`: entitlement activation is pending\n* `PENDING_TERMINATES`: entitlement termination is pending\n* `PENDING_CANCELS`: entitlement cancellation is pending\n","uniqueKey":"consumerOffer.subStatus","typeLabel":"enum\u003cstring>"}},"type":"object","required":["consumerOfferId","offerId","consumer","status","timeline"],"title":"ConsumerOfferDetail","description":"Consumer offer detail","isRequired":true,"uniqueKey":"consumerOffer","typeLabel":"ConsumerOfferDetail · object"},"entitlements":{"items":{"properties":{"entitlementId":{"type":"string","format":"uuid","title":"Entitlementid","description":"A globally unique and immutable identifier of the entitlement.","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].entitlementId","typeLabel":"string\u003cuuid>"},"merchantAccountKey":{"type":"string","title":"Merchantaccountkey","description":"A globally unique, immutable, human readable identifier of the content provider that delivers the product.","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].merchantAccountKey","typeLabel":"string"},"productKey":{"type":"string","title":"Productkey","description":"A globally unique, immutable, human readable identifier of the product the user is entitled to.","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].productKey","typeLabel":"string"},"status":{"type":"string","enum":["REQUESTED","CREATE_FAILED","CREATED","ACTIVE","SUSPENDED","ENDED"],"title":"EntitlementStatus","description":"Current status of the entitlement\n* `REQUESTED`: creation of the entitlement on the content provider is in progress\n* `CREATE_FAILED`: creation of the entitlement on the content provider failed\n* `CREATED`: creation of the entitlement on the content provider succeeded\n* `ACTIVE`: entitlement is associated to the consumer's account on the content provider\n* `SUSPENDED`: entitlement is associated, but the consumer access to the content has been suspended\n* `ENDED`: entitlement has ended, and the customer has lost access to the content\n","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"timeline":{"properties":{"createRequestedTs":{"type":"string","format":"date-time","title":"Createrequestedts","description":"Date when the creation of the entitlement was requested.","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].timeline.createRequestedTs","typeLabel":"string\u003cdate-time>"},"createdTs":{"type":"string","format":"date-time","title":"Createdts","description":"Date when the creation of the entitlement was successfully completed.","uniqueKey":"entitlements.items.[INDEX].timeline.createdTs","typeLabel":"string\u003cdate-time>"},"createFailedTs":{"type":"string","format":"date-time","title":"Createfailedts","description":"Date when the creation of the entitlement failed.","uniqueKey":"entitlements.items.[INDEX].timeline.createFailedTs","typeLabel":"string\u003cdate-time>"},"activatedTs":{"type":"string","format":"date-time","title":"Activatedts","description":"Date when the entitlement was activated.","uniqueKey":"entitlements.items.[INDEX].timeline.activatedTs","typeLabel":"string\u003cdate-time>"},"terminatedTs":{"type":"string","format":"date-time","title":"Terminatedts","description":"Date when the entitlement was cancelled.","uniqueKey":"entitlements.items.[INDEX].timeline.terminatedTs","typeLabel":"string\u003cdate-time>"}},"type":"object","required":["createRequestedTs"],"title":"EntitlementTimeline","description":"Timestamp of key events for this entitlement.","isRequired":true,"uniqueKey":"entitlements.items.[INDEX].timeline","typeLabel":"EntitlementTimeline · object"},"subStatus":{"type":"string","enum":["PENDING_CREATE","PENDING_ACTIVATE","ENDING","IMMEDIATE"],"title":"Substatus","description":"Sub Status of the entitlement.","uniqueKey":"entitlements.items.[INDEX].subStatus","typeLabel":"enum\u003cstring>"},"sharedCustomerId":{"type":"string","format":"uuid","title":"Sharedcustomerid","description":"Auto-generated unique consumer id for this content provider","uniqueKey":"entitlements.items.[INDEX].sharedCustomerId","typeLabel":"string\u003cuuid>"},"source":{"properties":{"brand":{"type":"string","title":"Brand","description":"Reseller's brand","uniqueKey":"entitlements.items.[INDEX].source.brand","typeLabel":"string"},"channelType":{"type":"string","enum":["App","Call Centre","Email","Mobile","Other","Retail","SMS","Set Top Box","Website"],"title":"Channeltype","description":"Channel used by the consumer in the creation or activation process.","uniqueKey":"entitlements.items.[INDEX].source.channelType","typeLabel":"enum\u003cstring>"},"country":{"type":"string","title":"Country","description":"Consumer's country (ISO two-letter country code).","uniqueKey":"entitlements.items.[INDEX].source.country","typeLabel":"string"},"region":{"type":"string","title":"Region","description":"Consumer's regional area or area code.","uniqueKey":"entitlements.items.[INDEX].source.region","typeLabel":"string"}},"type":"object","title":"Source","description":"Metadata related to the creation or activation process.","uniqueKey":"entitlements.items.[INDEX].source","typeLabel":"Source · object"},"activation":{"properties":{"activationCode":{"type":"string","title":"Activationcode","description":"The activation response will normally be a url. However, this field is returned instead of `url` if the content provider supports activation codes rather than URLs.","uniqueKey":"entitlements.items.[INDEX].activation.activationCode","typeLabel":"string"},"activationUrl":{"type":"string","title":"Activationurl","description":"The url that the reseller must redirect the user to to start the activation process.","uniqueKey":"entitlements.items.[INDEX].activation.activationUrl","typeLabel":"string"},"activationUrlExpiryTs":{"type":"string","format":"date-time","title":"Activationurlexpiryts","description":"Date and time when activation information will expire (if provided by the content provider). Field is in UTC ISO 8601 format.","uniqueKey":"entitlements.items.[INDEX].activation.activationUrlExpiryTs","typeLabel":"string\u003cdate-time>"}},"type":"object","title":"Activation","description":"Information needed for entitlement activation. Present only if status is `PENDING_ACTIVATION`.","uniqueKey":"entitlements.items.[INDEX].activation","typeLabel":"Activation · object"}},"type":"object","required":["entitlementId","merchantAccountKey","productKey","status","timeline"],"title":"Entitlement","description":"Entitlement to a specific product within a Consumer Offer.","uniqueKey":"entitlements.items.[INDEX]","typeLabel":"Entitlement · object"},"type":"array","title":"Entitlements","description":"Entitlements created under this consumer offer.","isRequired":true,"uniqueKey":"entitlements","typeLabel":"Entitlement · object[]"}},"type":"object","required":["consumerOffer","entitlements"],"title":"ConsumerOfferRead","description":"Consumer offer in a get response.","uniqueKey":"","typeLabel":"ConsumerOfferRead · object"},"examples":{"Ok":{"title":"Ok","value":{"consumerOffer":{"consumerOfferId":"338d31e1-a289-40dd-beff-ab41c1fc5f51","offerId":"7560fca0-d8a9-4124-a172-924debec874e","consumer":{"consumerIdentifier":"6X3D5MHHVSRGKDRLCHIC3Q2W2AQE55BK","billingIdentifier":"RDZN22AAVYAHVDN3N2OB2A7ADA3FVQWG","communicationInformation":{"emailAddress":"example@bango.com","msisdn":"+441234567890"}},"status":"REQUESTED","subStatus":"PENDING_CREATES","timeline":{"createRequestedTs":"1970-01-01T00:00:00.000Z","createdTs":"1970-01-01T00:00:00.000Z","createsFailedTs":"1970-01-01T00:00:00.000Z","entitlementsRequestedTs":"1970-01-01T00:00:00.000Z","terminateRequestedTs":"1970-01-01T00:00:00.000Z"}},"entitlements":[{"entitlementId":"b0163d06-1fa3-4c9b-a298-29635ca7151d","merchantAccountKey":"MY_CONTENT_PROVIDER","productKey":"My-Product","status":"REQUESTED","subStatus":"PENDING_CREATE","sharedCustomerId":"19c9dafb-c000-4000-8abb-231782b4b101","timeline":{"activatedTs":"1970-01-01T00:00:00.000Z","createFailedTs":"1970-01-01T00:00:00.000Z","createRequestedTs":"1970-01-01T00:00:00.000Z","createdTs":"1970-01-01T00:00:00.000Z","terminatedTs":"1970-01-01T00:00:00.000Z"},"source":{"brand":"My Brand","channelType":"Website","country":"GB","region":"Cambridgeshire"},"activation":{"activationCode":"string","activationUrl":"string","activationUrlExpiryTs":"1970-01-01T00:00:00.000Z"}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"c382a958-5d34-4146-adfc-85dcaa509f36":{"description":"Bad request","content":{"application/json":{"examples":{"Bad Request":{"title":"Bad Request","value":{"message":"Bad Request","statusCode":400}}},"schema":{"properties":{"statusCode":{"type":"integer","title":"Statuscode","description":"HTTP Status Code","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"Description of the error","uniqueKey":"message","typeLabel":"string"}},"type":"object","title":"ErrorResponse","description":"Error response for Consumer Offer API.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"exampleType":"examples"}},"exampleType":"examples"},"a962456e-8f68-49a6-8f4f-f0507973695e":{"description":"Invalid credentials (no response body returned)","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"60a254e5-45e6-4724-a0d8-3ae7044634d5":{"description":"Not found","content":{"application/json":{"examples":{"Not found":{"title":"Not found","value":{"message":"Not found","statusCode":404}}},"schema":{"properties":{"statusCode":{"type":"integer","title":"Statuscode","description":"HTTP Status Code","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"Description of the error","uniqueKey":"message","typeLabel":"string"}},"type":"object","title":"ErrorResponse","description":"Error response for Consumer Offer API.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"exampleType":"examples"}},"exampleType":"examples"},"03cf5a09-8d79-42d9-973c-806134ca291c":{"description":"Internal server error","content":{"application/json":{"examples":{"Internal server error":{"title":"Internal server error","value":{"message":"Internal server error","statusCode":500}}},"schema":{"properties":{"statusCode":{"type":"integer","title":"Statuscode","description":"HTTP Status Code","uniqueKey":"statusCode","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"Description of the error","uniqueKey":"message","typeLabel":"string"}},"type":"object","title":"ErrorResponse","description":"Error response for Consumer Offer API.","uniqueKey":"","typeLabel":"ErrorResponse · object"},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e5013787-c8c7-46e9-ae20-0c1bdec1d9e3":{"HTTPBasic":{"type":"http","scheme":"basic","scopes":[]}},"77ce6e8d-cc0b-48f8-b54f-b475dec0fdb5":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/token"}},"scopes":[]}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication header of the form `Basic \u003cencoded-value>`, where `\u003cencoded-value>` is the base64-encoded string `username:password`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"HTTPBasic","name":"Authorization"}],"title":"HTTPBasic"},{"schemes":[{"scheme":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/token"}},"scopes":[]},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"The access token received from the authorization server in the OAuth 2.0 flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2PasswordBearer","name":"Authorization"}],"title":"OAuth2PasswordBearer"}]},"originalFileLocation":"openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json"},"subdomain":"bango","siteName":"Bango product documentation","title":"Get Consumer Offer By Id - Bango product documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-23T09:10:11.455Z","originalFileLocation":"api-reference/consumer-offers/get-consumer-offer-by-id.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=\"Get Consumer Offer by ID.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bango product documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_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/bango/D4mbEm-MowhRm-F_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Consumer Offer By Id - Bango product documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get Consumer Offer by ID.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bango product documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.bango.com/api-reference/consumer-offers/get-consumer-offer-by-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bango.mintlify.site/_mintlify/api/og/v2?division=Consumer+Offers\u0026amp;title=Get+Consumer+Offer+By+Id\u0026amp;description=Get+Consumer+Offer+by+ID.\u0026amp;theme=ac4beb546e71a1132cdf8a4b\u0026amp;signature=2cf380c45c4c829ef427238dc45a2ffe63a1d10c749c9d88e913cf8039dacae2\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Consumer Offer By Id - Bango product documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get Consumer Offer by ID.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bango.mintlify.site/_mintlify/api/og/v2?division=Consumer+Offers\u0026amp;title=Get+Consumer+Offer+By+Id\u0026amp;description=Get+Consumer+Offer+by+ID.\u0026amp;theme=ac4beb546e71a1132cdf8a4b\u0026amp;signature=2cf380c45c4c829ef427238dc45a2ffe63a1d10c749c9d88e913cf8039dacae2\">\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/bango/D4mbEm-MowhRm-F_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bango product documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#006272\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.bango.com/api-reference/consumer-offers/get-consumer-offer-by-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/consumer-offers/get-consumer-offer-by-id.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.bango.com/#organization\",\"name\":\"Bango product documentation\",\"url\":\"https://docs.bango.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bango/6QC7Ytb7V743Uvvu/logo/bango_logo_dark.png?fit=max\u0026auto=format\u0026n=6QC7Ytb7V743Uvvu\u0026q=85\u0026s=3ef75914dc0e2776bcbbe94129f2130e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.bango.com#website\",\"name\":\"Bango product documentation\",\"url\":\"https://docs.bango.com\",\"publisher\":{\"@id\":\"https://docs.bango.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.bango.com/api-reference/consumer-offers/get-consumer-offer-by-id#webpage\",\"url\":\"https://docs.bango.com/api-reference/consumer-offers/get-consumer-offer-by-id\",\"name\":\"Get Consumer Offer By Id\",\"description\":\"Get Consumer Offer by ID.\",\"dateModified\":\"2026-09-23T09:10:11.455Z\",\"isPartOf\":{\"@id\":\"https://docs.bango.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bango.com/api-reference/consumer-offers/get-consumer-offer-by-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bango.com/api-reference/consumer-offers/get-consumer-offer-by-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Consumer Offers\",\"item\":\"https://docs.bango.com/api-reference/consumer-offers/the-consumer-offer-object\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Consumer Offer By Id\",\"item\":\"https://docs.bango.com/api-reference/consumer-offers/get-consumer-offer-by-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.bango.com/api-reference/consumer-offers/get-consumer-offer-by-id#apireference\",\"headline\":\"Get Consumer Offer By Id\",\"name\":\"Get Consumer Offer By Id\",\"description\":\"Get Consumer Offer by ID.\",\"url\":\"https://docs.bango.com/api-reference/consumer-offers/get-consumer-offer-by-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bango.com/api-reference/consumer-offers/get-consumer-offer-by-id#webpage\"},\"dateModified\":\"2026-09-23T09:10:11.455Z\",\"publisher\":{\"@id\":\"https://docs.bango.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.bango.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bango product documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Bango product documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/consumer-offers/get-consumer-offer-by-id.md","siteName":"Bango product documentation","nav":{"global":null,"tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/welcome"}]},{"tab":"Guides","icon":"book-open-reader","pages":[{"title":"Guides","href":"/guides/quick-start-bundle"}]},{"tab":"APIs","icon":"rectangle-api","groups":[{"group":"DVM APIs","public":true,"icon":"rectangle-api","pages":[{"title":"DVM API overview","href":"/API/dvm-api-overview"},{"title":"Working with DVM APIs","sidebarTitle":"Working with DVM APIs","href":"/API/working-with-dvm-apis"},{"title":"OAuth 2.0 authentication","sidebarTitle":"OAuth 2.0","href":"/API/oauth2-authentication"},{"title":"API changelog","sidebarTitle":"API changelog","href":"/API/changelog"},{"title":"API resources","href":"/API/api-objects"},{"title":"Manage API keys","href":"/API/manage-api-keys"}]},{"group":"Products","public":true,"icon":"box","pages":[{"title":"Product","href":"/api-reference/products/the-product-object"},{"group":"Product catalog","pages":[{"title":"Get products","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/product/openapi.yaml get /catalogs/products","href":"/api-reference/product-catalog/get-products"},{"title":"Get a product","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/product/openapi.yaml get /catalogs/products/{productId}","href":"/api-reference/product-catalog/get-a-product"}]}]},{"group":"Offers","public":true,"icon":"tag","pages":[{"title":"Offer","href":"/api-reference/offers/the-offer-object"},{"title":"Check offer eligibility","hidden":true,"href":"/api-reference/offers/check-offer-eligibility"},{"group":"Offer management","pages":[{"title":"Get offers","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/offer/openapi.yaml get /catalogs/offers","href":"/api-reference/offer-management/get-offers"},{"title":"Get an offer","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/offer/openapi.yaml get /catalogs/offers/{offerId}","href":"/api-reference/offer-management/get-an-offer"}]}]},{"group":"Consumer Offers","public":true,"icon":"users","pages":[{"title":"Consumer Offer","description":"Schema and fields for the Consumer Offer resource","href":"/api-reference/consumer-offers/the-consumer-offer-object"},{"title":"Change log","description":"Version history and updates for the Consumer Offers API","hidden":true,"href":"/changelog"},{"group":"Consumer Offers","pages":[{"title":"Get Consumer Offer By Id","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json get /consumerOffers/{consumerOfferId}","href":"/api-reference/consumer-offers/get-consumer-offer-by-id"},{"title":"Create Consumer Offer","description":"Create a consumer offer.","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json post /consumerOffers","href":"/api-reference/consumer-offers/create-consumer-offer"},{"title":"Cancel Consumer Offer","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json post /consumerOffers/{consumerOfferId}/cancellation","href":"/api-reference/consumer-offers/cancel-consumer-offer"},{"title":"Search Consumer Offer","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json post /consumerOffers/search","href":"/api-reference/consumer-offers/search-consumer-offer"},{"title":"Immedately Cancel A Consumer Offer","deprecated":true,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/consumer-offer/openapi.json post /consumerOffers/{consumerOfferId}/terminate","href":"/api-reference/consumer-offers/immedately-cancel-a-consumer-offer"}]}]},{"group":"Entitlements","public":true,"icon":"key","pages":[{"title":"Entitlement","href":"/api-reference/entitlements/the-entitlement-object"},{"title":"Retrieve recent top ups","hidden":true,"href":"/api-reference/top-ups/retrieve-recent-top-ups"},{"title":"Create a top up","hidden":true,"href":"/api-reference/top-ups/create-a-top-up"},{"group":"Reseller","pages":[{"group":"Echo","pages":[{"title":"Check connection","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/echo/{echoString}","href":"/api-reference/echo/check-connection"}]},{"group":"Entitlement","pages":[{"title":"Get an entitlement using externalEntitlementId","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml get /v1/entitlement","href":"/api-reference/entitlement/get-an-entitlement-using-externalentitlementid"},{"title":"Create an entitlement","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement","href":"/api-reference/entitlement/create-an-entitlement"},{"title":"Update an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml patch /v1/merchant/entitlement/{merchantEntitlementId}","href":"/api-reference/entitlement/update-an-entitlement"},{"title":"Get an entitlement","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml get /v1/entitlement/{entitlementId}","href":"/api-reference/entitlement/get-an-entitlement"},{"title":"Request activation info","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/activationInfo/{entitlementId}","href":"/api-reference/entitlement/request-activation-info"},{"title":"Account recovery","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/accountRecovery/{entitlementId}","href":"/api-reference/entitlement/account-recovery"},{"title":"Search for entitlements","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/report","href":"/api-reference/entitlement/search-for-entitlements"},{"title":"Suspend an entitlement","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/suspend/{entitlementId}","href":"/api-reference/entitlement/suspend-an-entitlement"},{"title":"Resume an entitlement","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/resume/{entitlementId}","href":"/api-reference/entitlement/resume-an-entitlement"},{"title":"Cancel an entitlement","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/cancel/{entitlementId}","href":"/api-reference/entitlement/cancel-an-entitlement"},{"title":"Revoke an entitlement","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /v1/entitlement/revoke/{entitlementId}","href":"/api-reference/entitlement/revoke-an-entitlement"}]},{"group":"Top Ups","pages":[{"title":"Get recent top ups","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml get /topups/entitlements/{entitlementId}","href":"/api-reference/top-ups/get-recent-top-ups"},{"title":"Create top ups","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/reseller-to-dvm/entitlement/openapi.yaml post /topups/entitlements/{entitlementId}","href":"/api-reference/top-ups/create-top-ups"}]}]},{"group":"From content provider","pages":[{"group":"Echo","pages":[{"title":"Service echo","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/echo/{echoRequestId}","href":"/api-reference/echo/service-echo"}]},{"group":"Entitlement","pages":[{"title":"Retrieve entitlement by merchant entitlement id","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml get /v1/merchant/entitlement/{merchantEntitlementId}","href":"/api-reference/entitlement/retrieve-entitlement-by-merchant-entitlement-id"},{"title":"Update an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml patch /v1/merchant/entitlement/{merchantEntitlementId}","href":"/api-reference/entitlement/update-an-entitlement"},{"title":"Get a list of entitlements for a bangoUserId or sharedCustomerId, matching specific criteria","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/merchant/entitlement/report","href":"/api-reference/entitlement/get-a-list-of-entitlements-for-a-bangouserid-or-sharedcustomerid-matching-specific-criteria"},{"title":"Activate an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/merchant/entitlement/activate/{merchantEntitlementId}","href":"/api-reference/entitlement/activate-an-entitlement"},{"title":"Terminate an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/merchant/entitlement/terminate/{merchantEntitlementId}","href":"/api-reference/entitlement/terminate-an-entitlement"}]}]},{"group":"To content provider","pages":[{"group":"Entitlement","pages":[{"title":"Create Entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml post /v1/entitlement","href":"/api-reference/entitlement/create-entitlement"},{"title":"Patch Entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml patch /v1/entitlement","href":"/api-reference/entitlement/patch-entitlement"},{"title":"Terminate Entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml post /v1/entitlement/terminate/{merchantEntitlementId}","href":"/api-reference/entitlement/terminate-entitlement"}]},{"group":"Eligibility","pages":[{"title":"Check user eligibility","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml post /v1/entitlement/checkeligibility","href":"/api-reference/eligibility/check-user-eligibility"}]}]}]},{"group":"Billing Plans","public":true,"icon":"credit-card","hidden":true,"pages":[{"title":"Retrieve billing history","href":"/api-reference/billing-plans/retrieve-billing-history"},{"title":"Retrieve current \u0026 next bill","href":"/api-reference/billing-plans/retrieve-current-and-next-bill"}]},{"group":"Notifications","public":true,"icon":"message-code","pages":[{"group":"notification","pages":[{"title":"Notification","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/bango-to-partner/openapi.yaml post /","href":"/api-reference/notification/notification"}]}]},{"group":"Eligibility","public":true,"icon":"user-viewfinder","pages":[{"group":"API Reference","pages":[{"title":"Send an eligibility request to a partner","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/dvm-to-reseller/eligibility/openapi.yaml post /{partnerUrlForEligibilityCheck}","href":"/api-reference/send-an-eligibility-request-to-a-partner"}]}]},{"group":"Charge","public":true,"icon":"file-invoice-dollar","pages":[{"group":"Charge and refund","pages":[{"title":"Charge","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/dvm-to-reseller/charge/openapi.json post /charges","href":"/api-reference/charge-and-refund/charge"},{"title":"Refund","deprecated":null,"version":null,"openapi":"/openapi/current/dvm/dvm-to-reseller/charge/openapi.json post /refunds","href":"/api-reference/charge-and-refund/refund"}]}]},{"group":"Testing","public":true,"icon":"stamp","pages":[{"title":"Testing overview","href":"/testing/testing-overview"},{"title":"Bango Music","href":"/testing/bango-music"},{"title":"Mock response headers","href":"/testing/mock-response-headers"}]}]},{"tab":"CX","icon":"palette","hidden":true,"pages":[{"title":"CX","href":"/cx/cx-general-settings"}]},{"tab":"DCB","icon":"mobile-screen-button","pages":[{"title":"DCB","href":"/payments"}]},{"tab":"Legacy","icon":"rotate-left","products":[{"product":"Platform","description":"About the Bango Platform","pages":[{"group":"Getting started","public":true,"pages":[{"title":"Integration steps","href":"/legacy/platform/getting-started"},{"title":"What Bango needs from you","href":"/legacy/platform/getting-started/signup-data"},{"title":"Integration steps","hidden":true,"href":"/platform/getting-started/index"},{"title":"What Bango needs from you","hidden":true,"href":"/platform/getting-started/signup-data"}]},{"group":"Architecture","public":true,"pages":[{"title":"Bango Platform architecture","href":"/legacy/platform/architecture/index"},{"title":"Terminology","href":"/legacy/platform/architecture/terminology"},{"title":"Bango Platform architecture","hidden":true,"href":"/platform/architecture/index"},{"title":"Terminology","hidden":true,"href":"/platform/architecture/terminology"}]},{"group":"Connectivity","public":true,"pages":[{"title":"Connectivity overview","href":"/legacy/platform/connectivity/index"},{"title":"Bango API endpoint URLs","href":"/legacy/platform/connectivity/endpoints"},{"title":"Basic authentication","href":"/legacy/platform/connectivity/basic-auth"},{"title":"IP whitelisting","href":"/legacy/platform/connectivity/ip-whitelist"},{"title":"TLS/SSL with X.509 server certificate","href":"/legacy/platform/connectivity/ssl-cert"},{"title":"Signing HTTP messages","href":"/legacy/platform/connectivity/signing-http-messages"},{"title":"Basic authentication","hidden":true,"href":"/platform/connectivity/basic-auth"},{"title":"Bango API endpoint URLs","hidden":true,"href":"/platform/connectivity/endpoints"},{"title":"Connectivity overview","hidden":true,"href":"/platform/connectivity/index"},{"title":"IP whitelisting","hidden":true,"href":"/platform/connectivity/ip-whitelist"},{"title":"Signing HTTP Messages","hidden":true,"href":"/platform/connectivity/signing-http-messages"},{"title":"TLS/SSL with X.509 server certificate","hidden":true,"href":"/platform/connectivity/ssl-cert"}]},{"group":"Help","public":true,"pages":[{"title":"Troubleshooting","href":"/legacy/platform/architecture/index-1"},{"title":"What's new on this site?","href":"/legacy/platform/architecture/updates"},{"title":"Support contact details","href":"/legacy/platform/architecture/support"}]}]},{"product":"Resale","description":"Channel subscription distribution","groups":[{"group":"General","pages":[{"title":"About Bango Resale","href":"/legacy/resale/index"},{"title":"Bango Dashboard","href":"/legacy/resale/dashboard"},{"title":"Developer tools","href":"/legacy/resale/developer-tools"}]},{"group":"Reseller","public":true,"pages":[{"title":"About Bango Resale for resellers ","href":"/legacy/resale/reseller/index"},{"title":"Bundling and reselling with Bango Resale ","href":"/legacy/resale/reseller/getting-started"},{"title":"Bango Reseller API architecture","href":"/legacy/resale/reseller/architecture"},{"group":"Entitlements","public":true,"pages":[{"title":"Entitlements overview ","href":"/legacy/resale/reseller/entitlements/index"},{"title":"Creating an entitlement","href":"/legacy/resale/reseller/entitlements/create"},{"title":"Retrieving a single entitlement","href":"/legacy/resale/reseller/entitlements/read"},{"title":"Retrieving multiple entitlements","href":"/legacy/resale/reseller/entitlements/retrieve"},{"title":"Updating an entitlement","href":"/legacy/resale/reseller/entitlements/update"},{"title":"Suspending an entitlement","href":"/legacy/resale/reseller/entitlements/suspend"},{"title":"Resuming an entitlement","href":"/legacy/resale/reseller/entitlements/resume"},{"title":"Canceling an entitlement","href":"/legacy/resale/reseller/entitlements/cancel"},{"title":"Revoking an entitlement","href":"/legacy/resale/reseller/entitlements/revoke"}]},{"title":"Testing overview","href":"/legacy/resale/reseller/testing"},{"group":"Reseller API reference","public":true,"pages":[{"title":"Reseller API reference overview","href":"/legacy/resale/reseller/api-ref/index"},{"title":"Standard reasons for suspend, cancel, revoke, and terminate","href":"/legacy/resale/reseller/api-ref/reason-codes"},{"title":"Sending requests to Bango ","href":"/legacy/resale/reseller/api-ref/requests"},{"group":"Echo","pages":[{"title":"Service echo. Used to check Bango Resale API availability.","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/echo/{echoRequestId}","href":"/api-reference/echo/service-echo-used-to-check-bango-resale-api-availability"}]},{"group":"Get entitlement","pages":[{"title":"Get entitlement from ExternalEntitlementId","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml get /v1/entitlement","href":"/api-reference/get-entitlement/get-entitlement-from-externalentitlementid"},{"title":"Get entitlement from BangoEntitlementId","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml get /v1/entitlement/{entitlementId}","href":"/api-reference/get-entitlement/get-entitlement-from-bangoentitlementid"}]},{"group":"Create entitlement","pages":[{"title":"Create a new entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement","href":"/api-reference/create-entitlement/create-a-new-entitlement"}]},{"group":"Update entitlement","pages":[{"title":"Update an existing entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml patch /v1/entitlement","href":"/api-reference/update-entitlement/update-an-existing-entitlement"}]},{"group":"Entitlement report","pages":[{"title":"Get a list of entitlements for a customerIdentifier, matching specific criteria","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement/report","href":"/api-reference/entitlement-report/get-a-list-of-entitlements-for-a-customeridentifier-matching-specific-criteria"}]},{"group":"Suspend entitlement","pages":[{"title":"Suspend an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement/suspend/{entitlementId}","href":"/api-reference/suspend-entitlement/suspend-an-entitlement"}]},{"group":"Resume entitlement","pages":[{"title":"Resume an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement/resume/{entitlementId}","href":"/api-reference/resume-entitlement/resume-an-entitlement"}]},{"group":"Cancel entitlement","pages":[{"title":"Cancel an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement/cancel/{entitlementId}","href":"/api-reference/cancel-entitlement/cancel-an-entitlement"}]},{"group":"Revoke entitlement","pages":[{"title":"Revoke an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement/revoke/{entitlementId}","href":"/api-reference/revoke-entitlement/revoke-an-entitlement"}]},{"group":"Send a notification","pages":[{"title":"Send a notification","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/reseller-to-bango/openapi.yaml post /v1/entitlement/notify/{entitlementId}","href":"/api-reference/send-a-notification/send-a-notification"}]}]},{"group":"Reseller notifications","public":true,"pages":[{"title":"Notifications from Bango","href":"/legacy/resale/reseller/api-ref/notifications"},{"group":"notification","pages":[{"title":"Notification","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/bango-to-partner/openapi.yaml post /","href":"/api-reference/notification/notification"}]}]},{"group":"Reporting","public":true,"pages":[{"title":"Reporting overview","href":"/legacy/resale/reseller/reporting/index"},{"title":"Reseller entitlement reports v2","href":"/legacy/resale/reseller/reporting/entitlement-reports-v2"},{"title":"Reseller Record Correlation Reports","href":"/legacy/resale/reseller/reporting/record-correlation-reports"}]},{"title":"Batch processing","href":"/legacy/resale/reseller/batch-processing"},{"title":"Bango Care","href":"/legacy/resale/reseller/bangocare"},{"title":"Frequently asked questions (FAQ)","href":"/legacy/resale/reseller/faq/index"}]},{"group":"Merchant","public":true,"pages":[{"title":"About Bango Resale for merchants","href":"/legacy/resale/merchant/index"},{"title":"Bundling OTT services with Bango Resale","href":"/legacy/resale/merchant/getting-started"},{"title":"Bango Merchant Interface API architecture","href":"/legacy/resale/merchant/architecture"},{"title":"Testing overview","href":"/legacy/resale/merchant/testing"},{"title":"Merchant Interface Overview","href":"/legacy/resale/merchant-interface/index"},{"group":"Merchant interface - Bango initiated","public":true,"pages":[{"group":"Entitlement","pages":[{"title":"Create Entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml post /v1/entitlement","href":"/api-reference/entitlement/create-entitlement"},{"title":"Patch Entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml patch /v1/entitlement","href":"/api-reference/entitlement/patch-entitlement"},{"title":"Terminate Entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml post /v1/entitlement/terminate/{merchantEntitlementId}","href":"/api-reference/entitlement/terminate-entitlement"}]},{"group":"Eligibility","pages":[{"title":"Check user eligibility","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/bango-to-content-provider/openapi.yaml post /v1/entitlement/checkeligibility","href":"/api-reference/eligibility/check-user-eligibility"}]}]},{"group":"Merchant interface - merchant initiated","public":true,"pages":[{"group":"Echo","pages":[{"title":"Service echo","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/echo/{echoRequestId}","href":"/api-reference/echo/service-echo"}]},{"group":"Entitlement","pages":[{"title":"Retrieve entitlement by merchant entitlement id","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml get /v1/merchant/entitlement/{merchantEntitlementId}","href":"/api-reference/entitlement/retrieve-entitlement-by-merchant-entitlement-id"},{"title":"Update an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml patch /v1/merchant/entitlement/{merchantEntitlementId}","href":"/api-reference/entitlement/update-an-entitlement"},{"title":"Get a list of entitlements for a bangoUserId or sharedCustomerId, matching specific criteria","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/merchant/entitlement/report","href":"/api-reference/entitlement/get-a-list-of-entitlements-for-a-bangouserid-or-sharedcustomerid-matching-specific-criteria"},{"title":"Activate an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/merchant/entitlement/activate/{merchantEntitlementId}","href":"/api-reference/entitlement/activate-an-entitlement"},{"title":"Terminate an entitlement","deprecated":null,"version":null,"openapi":"/openapi/legacy/resale/content-provider-to-bango/openapi.yaml post /v1/merchant/entitlement/terminate/{merchantEntitlementId}","href":"/api-reference/entitlement/terminate-an-entitlement"}]}]},{"group":"Reporting","public":true,"pages":[{"title":"Reporting Overview","href":"/legacy/resale/merchant/reporting/index"},{"title":"Merchant Entitlement Reports","href":"/legacy/resale/merchant/reporting/merchant-entitlement-reports"},{"title":"Merchant Record Correlation Reports","href":"/legacy/resale/merchant/reporting/merchant-record-correlation-reports"}]},{"title":"Bango Care","href":"/legacy/resale/merchant/bangocare"}]},{"group":"End of Life","public":true,"pages":[{"title":"End of life","href":"/legacy/resale/eol/index"},{"title":"Reactivating an entitlement","href":"/legacy/resale/eol/reactivating-entitlement"},{"title":"Entitlement reactivation API","href":"/legacy/resale/eol/entitlement-reactivation-api"},{"title":"Entitlement reports","href":"/legacy/resale/eol/entitlement-reports"},{"title":"Reconciliation reports","href":"/legacy/resale/eol/reconciliation-reports"}]}]},{"product":"Subscriptions","description":"Subscriptions management for channels","pages":[{"title":"Bango Subscriptions API","href":"/legacy/subscriptions/index"},{"group":"API Reference","public":true,"pages":[{"title":"API reference","href":"/legacy/subscriptions/api-ref/index"},{"group":"Sending requests to Bango","pages":[{"title":"Sending requests to Bango","href":"/legacy/subscriptions/api-ref/requests"},{"group":"echo","pages":[{"title":"Service availability check","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml post /echo/{echoRequestId}","href":"/api-reference/echo/service-availability-check"}]},{"group":"subscriptions","pages":[{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml post /subscription","href":"/api-reference/subscriptions/create-a-subscription"},{"title":"Retrieve a subscription by id","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml get /subscription/{subscriptionId}","href":"/api-reference/subscriptions/retrieve-a-subscription-by-id"},{"title":"Change a subscription's plan","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml put /subscription/{subscriptionId}","href":"/api-reference/subscriptions/change-a-subscriptions-plan"},{"title":"Cancel a subscription now or at a future date","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml delete /subscription/{subscriptionId}","href":"/api-reference/subscriptions/cancel-a-subscription-now-or-at-a-future-date"},{"title":"Retrieve a subscription by external key","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml get /subscription/externalKey/{externalKey}","href":"/api-reference/subscriptions/retrieve-a-subscription-by-external-key"},{"title":"Retrieve all subscriptions for a Bango User ID","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml get /subscription/bangouser/{bangoUserId}","href":"/api-reference/subscriptions/retrieve-all-subscriptions-for-a-bango-user-id"},{"title":"Uncancel a pending cancellation request for a subscription","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml put /subscription/{subscriptionId}/uncancel","href":"/api-reference/subscriptions/uncancel-a-pending-cancellation-request-for-a-subscription"}]},{"group":"plans","pages":[{"title":"Create a plan","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml post /plan","href":"/api-reference/plans/create-a-plan"},{"title":"Retrieve a plan by name","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml get /plan/name/{planName}","href":"/api-reference/plans/retrieve-a-plan-by-name"},{"title":"Retrieve a plan by id","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml get /plan/{planId}","href":"/api-reference/plans/retrieve-a-plan-by-id"},{"title":"Retrieve all plans","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/partner-to-bango/openapi.yaml get /plans","href":"/api-reference/plans/retrieve-all-plans"}]}]},{"group":"Notifications from Bango","pages":[{"title":"Notifications from Bango","href":"/legacy/subscriptions/api-ref/notifications"},{"group":"notification","pages":[{"title":"Notification","deprecated":null,"version":null,"openapi":"/openapi/legacy/subscriptions/bango-to-partner/openapi.yaml post /","href":"/api-reference/notification/notification"}]}]}]},{"group":"Concepts","public":true,"pages":[{"title":"Key concepts","href":"/legacy/subscriptions/concepts/index"},{"title":"Products and plans","href":"/legacy/subscriptions/concepts/products-plans"},{"title":"Subscription lifecycle and timeline","href":"/legacy/subscriptions/concepts/lifecycle"},{"title":"Billing periods","href":"/legacy/subscriptions/concepts/billing-periods"},{"title":"Renewal","href":"/legacy/subscriptions/concepts/renewal"},{"title":"Conversion","href":"/legacy/subscriptions/concepts/conversion"},{"title":"Idempotency","href":"/legacy/subscriptions/concepts/idempotency"},{"title":"FAQ","href":"/legacy/subscriptions/faq/index"}]},{"title":"Changes, deprecations, and end-of-life dates","href":"/legacy/subscriptions/changelog"},{"title":"Testing","href":"/legacy/subscriptions/testing"}]},{"product":"DCB Payments v5","description":"Technology rails for Direct Carrier Billing","pages":[{"title":"About Bango Payments","href":"/legacy/dcb-payments-v5/index"},{"group":"Getting started","public":true,"pages":[{"title":"Selling with Bango Payments","href":"/legacy/dcb-payments-v5/getting-started/selling-with-bango-payments"}]},{"group":"Architecture","public":true,"pages":[{"title":"Bango Payments architecture","href":"/legacy/dcb-payments-v5/architecture/architecture"},{"title":"High-level sequence diagram","href":"/legacy/dcb-payments-v5/architecture/high-level-sequence-diagram"},{"title":"Bango Platform features","href":"/legacy/dcb-payments-v5/architecture/features"}]},{"group":"Identifying users","public":true,"pages":[{"title":"Identification overview","href":"/legacy/dcb-payments-v5/identifying-users/index"},{"title":"Skeleton code","href":"/legacy/dcb-payments-v5/identifying-users/skeleton-code"},{"title":"Common request/response flows","href":"/legacy/dcb-payments-v5/identifying-users/common-request-response-flows"},{"title":"Identity selection and methods","href":"/legacy/dcb-payments-v5/identifying-users/identity-selection-and-methods"}]},{"group":"Transactions","public":true,"pages":[{"title":"Transactions overview","href":"/legacy/dcb-payments-v5/transactions/index"},{"title":"Checking available payment methods","href":"/legacy/dcb-payments-v5/transactions/checking-available-payment-methods"},{"title":"Authorizing a payment","href":"/legacy/dcb-payments-v5/transactions/authorizing-a-payment"},{"title":"Capturing a payment","href":"/legacy/dcb-payments-v5/transactions/capturing-a-payment"},{"title":"Canceling or refunding a payment","href":"/legacy/dcb-payments-v5/transactions/canceling-or-refunding-a-payment"},{"title":"Retrieving transaction details","href":"/legacy/dcb-payments-v5/transactions/retrieving-transaction-details"},{"title":"Subscriptions and recurring transactions","href":"/legacy/dcb-payments-v5/transactions/subscriptions-and-recurring-transactions"}]},{"group":"Testing","public":true,"pages":[{"title":"Testing overview","href":"/legacy/dcb-payments-v5/testing/index"},{"title":"Using the Testing Guide","href":"/legacy/dcb-payments-v5/testing/using-the-testing-guide"},{"title":"The Prefer HTTP header","href":"/legacy/dcb-payments-v5/testing/the-prefer-http-header"},{"title":"Bango TestPay","href":"/legacy/dcb-payments-v5/testing/bango-testpay"},{"title":"Production testing","href":"/legacy/dcb-payments-v5/testing/production-testing"}]},{"group":"Merchant API reference","public":true,"pages":[{"title":"API reference overview","href":"/legacy/dcb-payments-v5/api-reference/index"},{"title":"Callbacks and notifications","href":"/legacy/dcb-payments-v5/api-reference/callbacks-and-notifications"},{"title":"Transaction Payment Items structure","href":"/legacy/dcb-payments-v5/api-reference/transaction-payment-items"},{"group":"Identity","pages":[{"title":"Retrieve data about a user.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml get /user/{userIdentifier}","href":"/api-reference/identity/retrieve-data-about-a-user"},{"title":"Delete a user.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/merchant-to-bango/openapi.yaml delete /v5/identity/{bangoUserId}","href":"/api-reference/identity/delete-a-user"},{"title":"Get a user's Bango ID (initial request)","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/merchant-to-bango/openapi.yaml post /v5/identity","href":"/api-reference/identity/get-a-users-bango-id-initial-request"},{"title":"Get a user's Bango ID (subsequent request)","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/merchant-to-bango/openapi.yaml post /v5/identity/{sessionId}","href":"/api-reference/identity/get-a-users-bango-id-subsequent-request"}]},{"group":"Transaction","pages":[{"title":"Authorize transaction","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml post /transaction","href":"/api-reference/transaction/authorize-transaction"},{"title":"Check available payment methods","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/merchant-to-bango/openapi.yaml options /v5/transaction","href":"/api-reference/transaction/check-available-payment-methods"},{"title":"Retrieve data about a transaction.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml get /transaction/{transactionId}","href":"/api-reference/transaction/retrieve-data-about-a-transaction"},{"title":"Capture transaction","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml put /transaction/{transactionId}","href":"/api-reference/transaction/capture-transaction"},{"title":"Cancel or refund a transaction.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml patch /transaction/{transactionId}","href":"/api-reference/transaction/cancel-or-refund-a-transaction"}]}]},{"group":"Payment Provider API reference","public":true,"pages":[{"title":"Payment Provider API reference overview","href":"/legacy/dcb-payments-v5/payment-provider-api-reference/index"},{"group":"Identity","pages":[{"title":"Retrieve data about a user.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml get /user/{userIdentifier}","href":"/api-reference/identity/retrieve-data-about-a-user"}]},{"group":"Transaction","pages":[{"title":"Authorize transaction","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml post /transaction","href":"/api-reference/transaction/authorize-transaction"},{"title":"Retrieve data about a transaction.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml get /transaction/{transactionId}","href":"/api-reference/transaction/retrieve-data-about-a-transaction"},{"title":"Capture transaction","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml put /transaction/{transactionId}","href":"/api-reference/transaction/capture-transaction"},{"title":"Cancel or refund a transaction.","deprecated":null,"version":null,"openapi":"/openapi/legacy/payments/payment-provider-to-bango/openapi.yaml patch /transaction/{transactionId}","href":"/api-reference/transaction/cancel-or-refund-a-transaction"}]}]},{"group":"Reporting","public":true,"pages":[{"title":"Transaction reports","href":"/legacy/dcb-payments-v5/reporting/transaction-reports"}]},{"group":"Bango care","public":true,"pages":[{"title":"Bango Care","href":"/legacy/dcb-payments-v5/bango-care/index"}]},{"group":"Bango dashboard","public":true,"pages":[{"title":"Bango Dashboard","href":"/legacy/dcb-payments-v5/bango-dashboard/index"}]},{"group":"Developer tools","public":true,"pages":[{"title":"Developer Tools","href":"/legacy/dcb-payments-v5/developer-tools/index"}]},{"title":"Change log","href":"/legacy/dcb-payments-v5/changelog"}]}]}]},"basePath":"","title":"Get Consumer Offer By Id - Bango product documentation","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"]}