Information about payment status displayed in the Entitlement API
Show child attributes
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Wingback","colors":{"primary":"#EF3B4D","light":"#FF7886","dark":"#D81D38"},"favicon":"/media/favicon.png","logo":{"light":"https://mintcdn.com/wingback/GadBRdJt85xVxME0/media/logo/light.svg?fit=max\u0026auto=format\u0026n=GadBRdJt85xVxME0\u0026q=85\u0026s=93b61d8945910151ec8df39c2b469c8e","dark":"https://mintcdn.com/wingback/GadBRdJt85xVxME0/media/logo/dark.svg?fit=max\u0026auto=format\u0026n=GadBRdJt85xVxME0\u0026q=85\u0026s=ba6722dedd801b55082f19792ea3b441"},"api":{"mdx":{"server":"https://api.wingback.com"}},"navbar":{"links":[],"primary":{"type":"button","label":"Go to Dashboard","href":"https://app.wingback.com/"}},"footer":{"socials":{"website":"https://wingback.com","twitter":"https://twitter.com/wingbackapp","linkedin":"https://www.linkedin.com/company/wingbackapp/"}},"integrations":{"posthog":{"apiKey":"phc_9zg8YkIBr0SuofRjG6TujIu9Q6I2deAFFat4U3DpbrV","apiHost":"https://i.wingback.com"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wingback","hasAudioNarration":false,"actualSubdomain":"wingback","customDomains":["docs-int.wingback.com"],"gitSource":{"type":"github","owner":"wingbackapp","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"docs","mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a20c343cf0492c7637e2ac2","collectionId":"df9c82e5-67e0-472b-acfa-7306b676d252","schemaVersion":"v2"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a20c343cf0492c7637e2ac2:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Developer Documentation","count":41},{"language":"default","tag":"API Reference","count":31},{"language":"default","tag":"SGI Fundamentals","count":19},{"language":"default","tag":"Pricing Model Guides","count":16},{"language":"default","tag":"User Guides","count":13},{"language":"default","tag":"User Manuals","count":10},{"language":"default","tag":"Customer","count":8},{"language":"default","tag":"Payment","count":6},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Feature Overview","count":6}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"dev/api-reference/entitlement/get_c_entitlement_customerid_billing","slug":"/dev/api-reference/entitlement/get_c_entitlement_customerid_billing","pageMetadata":{"title":"Get Billing Entitlements","openapi":"GET /v1/c/entitlement/{customer_id}/billing","description":"Retrieve current plan, payment cycle, payment status and account status for a customer","href":"/dev/api-reference/entitlement/get_c_entitlement_customerid_billing"},"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: \"Retrieve current plan, payment cycle, payment status and account status for a customer\"\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];const IntRedir=()=>{if(typeof document===`undefined`){return null}else{setTimeout(()=>{const currentUrl=new URL(window.location.href);if(currentUrl.hostname===`docs-int.wingback.com`){currentUrl.hostname=`docs.wingback.com`;window.location.replace(currentUrl.toString())}},1);return _jsx(_Fragment,{})}};function _createMdxContent(props){const{_MdxComponentBoundary}={..._provideComponents(),...props.components};if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsx(_MdxComponentBoundary,{name:`IntRedir`,children:_jsx(IntRedir,{})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{IntRedir,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Billing Entitlements","openapi":"GET /v1/c/entitlement/{customer_id}/billing","description":"Retrieve current plan, payment cycle, payment status and account status for a customer","href":"/dev/api-reference/entitlement/get_c_entitlement_customerid_billing"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[19,38,""],[136,436,"null;function _creat"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/wingback/bbb25f53a15d63f9/int-redir.js"],"openApiReferenceData":{"operation":{"tags":["entitlement"],"operationId":"get_billing","parameters":["a311b074-215c-4ae6-9287-6e7bb8bc93aa","1d0dd28f-c9c6-4282-ad9d-1883a717d1c5"],"responses":{"200":"0099b6ec-681b-49ea-8027-0257029500a7"},"security":["9f90a79f-fd4e-413f-a613-b0a554f15fc2","aab1a1e3-a2a4-4755-ab39-e941d8aab106"],"method":"get","type":"path","servers":["a4003425-b8cc-41a9-b3c3-854191252b9c","bc411509-c143-4d72-a409-c7938d980f87"],"path":"/v1/c/entitlement/{customer_id}/billing","baseUrlOptions":["http://127.0.0.1:8080","https://api.app.test.wingback.com"],"title":"","description":"Retrieve current plan, payment cycle, payment status and account status for a customer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a311b074-215c-4ae6-9287-6e7bb8bc93aa":{"name":"customer_id","in":"path","description":"Id of the customer","required":true,"schema":{"type":"string","isRequired":true,"description":"Id of the customer","uniqueKey":"","typeLabel":"string"}},"1d0dd28f-c9c6-4282-ad9d-1883a717d1c5":{"name":"due_date_before","in":"query","required":false,"schema":{"oneOf":[{"type":"string","format":"date","uniqueKey":"oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cdate> | null"}}},"responses":{"0099b6ec-681b-49ea-8027-0257029500a7":{"description":"Billing information for current cycle","content":{"application/json":{"schema":{"type":"object","description":"Data to show the billing status of the customer (last payment date, wallet balance, etc)","required":["customer","contract","payment"],"properties":{"contract":{"type":"object","description":"Describes Contract object for Entitlement endpoint","required":["contract_id","status"],"properties":{"contract_id":{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","isRequired":true,"uniqueKey":"contract.contract_id","typeLabel":"string"},"status":{"type":"string","description":"Status of the contract:\n* Active - Contract is active\n* Pending - Contract is not active\n* Scheduled - Contract is scheduled to activate in the future\n* Canceled - Contract has been canceled\n* Moved - User upgraded from this contract to a different one\n* NotReady - Contract was created, but billing engine has not completed contract setup","enum":["active","pending","scheduled","canceled","moved","not_ready"],"isRequired":true,"uniqueKey":"contract.status","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"contract","typeLabel":"object"},"customer":{"type":"object","description":"Describes the status of the customer for Entitlement response","required":["status"],"properties":{"status":{"type":"string","description":"Status of the Customer\n* Active - customer is active\n* Inactive - Customer account was deactivated\n* Temporary - Customer was created, but registration process was not completed","enum":["active","inactive","temporary"],"isRequired":true,"uniqueKey":"customer.status","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"customer","typeLabel":"object"},"payment":{"type":"object","description":"Information about payment status displayed in the Entitlement API","required":["payment_provider","unpaid_invoices_info","wallet_balance","wallet_balances"],"properties":{"payment_provider":{"type":"string","description":"The payment providers known by the backend.\n\nThose variants MUST be kept identical to the variants of\nthe payment_provider enum of the postgres database","enum":["authorize","self_handled","stripe"],"example":"stripe","isRequired":true,"uniqueKey":"payment.payment_provider","typeLabel":"enum\u003cstring>"},"unpaid_invoices_info":{"type":"array","items":{"type":"object","description":"Information about the charges that have not been paid yet","required":["currency","total_unpaid","payment_threshold","unpaid_invoices"],"properties":{"currency":{"type":"string","description":"A supported currency\n\nThe format for parsing and reading is the lowercased\nISO 4217 currency code (e.g. \"usd\")","enum":["usd","eur","gbp","brl","ars"],"isRequired":true,"uniqueKey":"payment.unpaid_invoices_info.items.[INDEX].currency","typeLabel":"enum\u003cstring>"},"payment_threshold":{"type":"string","description":"The configured stored maximum allowed unpaid amount. This limit is not enforced on Wingback\nside, but may be used as indicator by the user of the Entitlement API","isRequired":true,"uniqueKey":"payment.unpaid_invoices_info.items.[INDEX].payment_threshold","typeLabel":"string"},"total_unpaid":{"type":"string","description":"Total sum of unpaid charges","isRequired":true,"uniqueKey":"payment.unpaid_invoices_info.items.[INDEX].total_unpaid","typeLabel":"string"},"unpaid_invoices":{"type":"array","items":{"type":"object","description":"Reduced information about the invoice specific for Entitlement endpoint","required":["id","status","amount","due_date"],"properties":{"amount":{"type":"string","description":"Total amount of the invoice","isRequired":true,"uniqueKey":"payment.unpaid_invoices_info.items.[INDEX].unpaid_invoices.items.[INDEX].amount","typeLabel":"string"},"due_date":{"type":"string","format":"date-time","description":"Due date of the invoice","isRequired":true,"uniqueKey":"payment.unpaid_invoices_info.items.[INDEX].unpaid_invoices.items.[INDEX].due_date","typeLabel":"string\u003cdate-time>"},"id":{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","isRequired":true,"uniqueKey":"payment.unpaid_invoices_info.items.[INDEX].unpaid_invoices.items.[INDEX].id","typeLabel":"string"},"status":{"type":"string","description":"Status of the invoice:\n* PendingValidation - Invoice awaits manual review\n* ReadyForPayment - invoice can be paid\n* Paid - invoice was paid","enum":["pending_validation","ready_for_payment","paid"],"isRequired":true,"uniqueKey":"payment.unpaid_invoices_info.items.[INDEX].unpaid_invoices.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"payment.unpaid_invoices_info.items.[INDEX].unpaid_invoices.items.[INDEX]","typeLabel":"object"},"description":"List of unpaid invoices","isRequired":true,"uniqueKey":"payment.unpaid_invoices_info.items.[INDEX].unpaid_invoices","typeLabel":"object[]"}},"uniqueKey":"payment.unpaid_invoices_info.items.[INDEX]","typeLabel":"object"},"description":"List of unpaid invoices","isRequired":true,"uniqueKey":"payment.unpaid_invoices_info","typeLabel":"object[]"},"wallet_balance":{"type":"string","description":"Status of the customer's wallet with the same currency as the current contract","isRequired":true,"uniqueKey":"payment.wallet_balance","typeLabel":"string"},"wallet_balances":{"type":"array","items":{"type":"object","description":"Customer's virtual wallet and its balance","required":["id","wb_customer_id","customer_id","currency","balance"],"properties":{"balance":{"type":"string","description":"Wallet balance","isRequired":true,"uniqueKey":"payment.wallet_balances.items.[INDEX].balance","typeLabel":"string"},"currency":{"type":"string","description":"A supported currency\n\nThe format for parsing and reading is the lowercased\nISO 4217 currency code (e.g. \"usd\")","enum":["usd","eur","gbp","brl","ars"],"isRequired":true,"uniqueKey":"payment.wallet_balances.items.[INDEX].currency","typeLabel":"enum\u003cstring>"},"customer_id":{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","isRequired":true,"uniqueKey":"payment.wallet_balances.items.[INDEX].customer_id","typeLabel":"string"},"id":{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","isRequired":true,"uniqueKey":"payment.wallet_balances.items.[INDEX].id","typeLabel":"string"},"wb_customer_id":{"type":"string","description":"Unique identifier of an object. Consists of object class prefix and a UUID","example":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","isRequired":true,"uniqueKey":"payment.wallet_balances.items.[INDEX].wb_customer_id","typeLabel":"string"}},"uniqueKey":"payment.wallet_balances.items.[INDEX]","typeLabel":"object"},"description":"List of all customer wallets and their balances","isRequired":true,"uniqueKey":"payment.wallet_balances","typeLabel":"object[]"},"next_payment_due":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the nearest invoice will be due","uniqueKey":"payment.next_payment_due.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the nearest invoice will be due","uniqueKey":"payment.next_payment_due.oneOf.1","typeLabel":"null"}],"uniqueKey":"payment.next_payment_due","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"payment","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"contract":{"contract_id":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","status":"active"},"customer":{"status":"active"},"payment":{"payment_provider":"stripe","unpaid_invoices_info":[{"currency":"usd","payment_threshold":"\u003cstring>","total_unpaid":"\u003cstring>","unpaid_invoices":[{"amount":"\u003cstring>","due_date":"2023-11-07T05:31:56Z","id":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","status":"pending_validation"}]}],"wallet_balance":"\u003cstring>","wallet_balances":[{"balance":"\u003cstring>","currency":"usd","customer_id":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","id":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670","wb_customer_id":"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"}],"next_payment_due":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"9f90a79f-fd4e-413f-a613-b0a554f15fc2":{"api-key":{"type":"apiKey","in":"header","name":"wb-key","scopes":[]}},"aab1a1e3-a2a4-4755-ab39-e941d8aab106":{"wb_user_cookie":{"type":"apiKey","in":"cookie","name":"app-session","scopes":[]}}},"servers":{"a4003425-b8cc-41a9-b3c3-854191252b9c":{"url":"http://127.0.0.1:8080","description":"Local server"},"bc411509-c143-4d72-a409-c7938d980f87":{"url":"https://api.app.test.wingback.com","description":"Testing server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"wb-key","scopes":[]},"schema":{"title":"wb-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api-key","name":"wb-key"}],"title":"api-key"},{"schemes":[{"scheme":{"type":"apiKey","in":"cookie","name":"app-session","scopes":[]},"schema":{"title":"app-session","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"wb_user_cookie","name":"app-session"}],"title":"wb_user_cookie"}]},"originalFileLocation":"openapi.json"},"subdomain":"wingback","siteName":"Wingback","title":"Get Billing Entitlements - Wingback","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T22:42:18.097Z","originalFileLocation":"dev/api-reference/entitlement/get_c_entitlement_customerid_billing.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=\"Retrieve current plan, payment cycle, payment status and account status for a customer\">\u003cmeta data-mint-head name=\"application-name\" content=\"Wingback\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wingback/UnON2ZxPucVjTp_q/_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/wingback/UnON2ZxPucVjTp_q/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wingback/UnON2ZxPucVjTp_q/_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/wingback/UnON2ZxPucVjTp_q/_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/wingback/UnON2ZxPucVjTp_q/_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/wingback/UnON2ZxPucVjTp_q/_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/wingback/UnON2ZxPucVjTp_q/_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/wingback/UnON2ZxPucVjTp_q/_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/wingback/UnON2ZxPucVjTp_q/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Billing Entitlements - Wingback\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve current plan, payment cycle, payment status and account status for a customer\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Wingback\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs-int.wingback.com/dev/api-reference/entitlement/get_c_entitlement_customerid_billing\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wingback.mintlify.app/_mintlify/api/og/v2?division=Entitlements\u0026amp;title=Get+Billing+Entitlements\u0026amp;description=Retrieve+current+plan%2C+payment+cycle%2C+payment+status+and+account+status+for+a+customer\u0026amp;theme=b99535fc2fd6236ca0523fc2\u0026amp;signature=69e069798a59c804c31f3f665b9662c131d6b371130871269b6d19d29f839176\">\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 Billing Entitlements - Wingback\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve current plan, payment cycle, payment status and account status for a customer\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wingback.mintlify.app/_mintlify/api/og/v2?division=Entitlements\u0026amp;title=Get+Billing+Entitlements\u0026amp;description=Retrieve+current+plan%2C+payment+cycle%2C+payment+status+and+account+status+for+a+customer\u0026amp;theme=b99535fc2fd6236ca0523fc2\u0026amp;signature=69e069798a59c804c31f3f665b9662c131d6b371130871269b6d19d29f839176\">\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/wingback/UnON2ZxPucVjTp_q/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Wingback\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#EF3B4D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs-int.wingback.com/dev/api-reference/entitlement/get_c_entitlement_customerid_billing\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/dev/api-reference/entitlement/get_c_entitlement_customerid_billing.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs-int.wingback.com/#organization\",\"name\":\"Wingback\",\"url\":\"https://docs-int.wingback.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wingback/GadBRdJt85xVxME0/media/logo/light.svg?fit=max\u0026auto=format\u0026n=GadBRdJt85xVxME0\u0026q=85\u0026s=93b61d8945910151ec8df39c2b469c8e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs-int.wingback.com#website\",\"name\":\"Wingback\",\"url\":\"https://docs-int.wingback.com\",\"publisher\":{\"@id\":\"https://docs-int.wingback.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs-int.wingback.com/dev/api-reference/entitlement/get_c_entitlement_customerid_billing#webpage\",\"url\":\"https://docs-int.wingback.com/dev/api-reference/entitlement/get_c_entitlement_customerid_billing\",\"name\":\"Get Billing Entitlements\",\"description\":\"Retrieve current plan, payment cycle, payment status and account status for a customer\",\"dateModified\":\"2026-01-06T22:42:18.097Z\",\"isPartOf\":{\"@id\":\"https://docs-int.wingback.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs-int.wingback.com/dev/api-reference/entitlement/get_c_entitlement_customerid_billing#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs-int.wingback.com/dev/api-reference/entitlement/get_c_entitlement_customerid_billing#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs-int.wingback.com/dev/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Entitlements\",\"item\":\"https://docs-int.wingback.com/dev/api-reference/entitlement/get_c_entitlement_customerid_access\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Billing Entitlements\",\"item\":\"https://docs-int.wingback.com/dev/api-reference/entitlement/get_c_entitlement_customerid_billing\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs-int.wingback.com/dev/api-reference/entitlement/get_c_entitlement_customerid_billing#apireference\",\"headline\":\"Get Billing Entitlements\",\"name\":\"Get Billing Entitlements\",\"description\":\"Retrieve current plan, payment cycle, payment status and account status for a customer\",\"url\":\"https://docs-int.wingback.com/dev/api-reference/entitlement/get_c_entitlement_customerid_billing\",\"mainEntityOfPage\":{\"@id\":\"https://docs-int.wingback.com/dev/api-reference/entitlement/get_c_entitlement_customerid_billing#webpage\"},\"dateModified\":\"2026-01-06T22:42:18.097Z\",\"publisher\":{\"@id\":\"https://docs-int.wingback.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs-int.wingback.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Wingback\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Wingback","nav":{"global":null,"tabs":[{"tab":"User Guides","pages":[{"title":"User Guides","href":"/user/welcome"}]},{"tab":"User Manuals","pages":[{"title":"User Manuals","href":"/manual/introduction"}]},{"tab":"SGI Fundamentals","pages":[{"title":"SGI Fundamentals","href":"/fundamentals/vocab/introduction"}]},{"tab":"Developer Documentation","groups":[{"group":"Welcome","pages":[{"title":"Introduction","href":"/dev/welcome"}]},{"group":"Guides","pages":[{"title":"Working with Features and Entitlements","href":"/dev/guides/features-entitlements"},{"title":"Integrating Wingback into your Signup Flow","href":"/dev/guides/integrate-wingback-signup-flow"},{"title":"Billing Portal Integration","href":"/dev/guides/billing-portal"},{"title":"Adding a Dynamic Pricing Page to Your Website","href":"/dev/guides/pricing-page"},{"title":"Metering Usage","href":"/dev/guides/metering"},{"title":"Webhooks","href":"/dev/guides/webhooks"}]},{"group":"Wingback.js","pages":[{"title":"Introduction","href":"/dev/wingback-js/introduction"},{"title":"Pricing Pages","href":"/dev/wingback-js/pricing"}]},{"group":"Advanced","pages":[{"title":"Variable Invoicing Schedules","href":"/dev/advanced/variable-invoicing-schedules"}]},{"group":"API Reference","pages":[{"title":"Introduction","href":"/dev/api-reference/introduction"},{"group":"Customer","pages":[{"title":"Create New Customer","openapi":"POST /v1/c/customer","href":"/dev/api-reference/customer/post_c_customer"},{"title":"Get Customer","openapi":"GET /v1/c/customer/{customer_id}","href":"/dev/api-reference/customer/get_c_customer_customerid"},{"title":"Search for Customers","openapi":"GET /v1/c/customer","href":"/dev/api-reference/customer/get_c_customer"},{"title":"Activate Customer","openapi":"POST /v1/c/customer/{customer_id}/activate","href":"/dev/api-reference/customer/post_c_customer_customerid_activate"},{"title":"Freeze/Inactivate Customer","openapi":"POST /v1/c/customer/{customer_id}/inactivate","href":"/dev/api-reference/customer/post_c_customer_customerid_inactivate"},{"title":"Add Address","openapi":"POST /v1/c/customer/{customer_id}/address","href":"/dev/api-reference/customer/post_c_customer_customerid_address"},{"title":"Get Address","openapi":"GET /v1/c/customer/{customer_id}/address","href":"/dev/api-reference/customer/get_c_customer_customerid_address"},{"title":"Delete Address","openapi":"DELETE /v1/c/customer/{customer_id}/address","href":"/dev/api-reference/customer/delete_c_customer_customerid_address"}]},{"group":"Contract","pages":[{"title":"Subscribe Customer to a Plan","openapi":"POST /v1/c/contract","href":"/dev/api-reference/contract/post_c_contract"},{"title":"Retrieve Contract Details","openapi":"GET /v1/c/contract/{contract_id}","href":"/dev/api-reference/contract/get_c_contract_contractid"},{"title":"Upgrade/Change Plan","openapi":"POST /v1/c/contract/{contract_id}/upgrade","href":"/dev/api-reference/contract/post_c_contract_contractid_upgrade"},{"title":"Estimate Upgrade Costss","openapi":"POST /v1/c/contract/{contract_id}/upgrade_estimate","href":"/dev/api-reference/contract/post_c_contract_contractid_upgrade_estimate"}]},{"group":"Billing Portal","pages":[{"title":"Login a Customer to the Self-Serve Portal","openapi":"POST /v1/c/customer/authenticate","href":"/dev/api-reference/billing-portal/post_c_customer_authenticate"}]},{"group":"Entitlements","pages":[{"title":"Get Access Entitlements","openapi":"GET /v1/c/entitlement/{customer_id}/access","description":"Retrieve a list of all features a customer currently has access to.","href":"/dev/api-reference/entitlement/get_c_entitlement_customerid_access"},{"title":"Get Billing Entitlements","openapi":"GET /v1/c/entitlement/{customer_id}/billing","href":"/dev/api-reference/entitlement/get_c_entitlement_customerid_billing"}]},{"group":"Usage","pages":[{"title":"Report Single Event","openapi":"POST /v1/c/usage","description":"Increment the usage counters for a specific feature and customer within the current billing period.","href":"/dev/api-reference/usage/post_c_usage"},{"title":"Bulk Usage Upload","openapi":"POST /v1/c/usage/bulk","href":"/dev/api-reference/usage/post_c_usage_bulk"}]},{"group":"Payment","pages":[{"title":"Create Payment Session","openapi":"POST /v1/c/customer/{customer_id}/payment/session","href":"/dev/api-reference/payment/post_c_customer_customerid_payment_session"},{"title":"Add Payment Method","openapi":"POST /v1/c/customer/{customer_id}/payment/method","href":"/dev/api-reference/payment/post_c_customer_customerid_payment_method"},{"title":"List saved Payment Methods","openapi":"GET /v1/c/customer/{customer_id}/payment/method","href":"/dev/api-reference/payment/get_c_customer_customerid_payment_method"},{"title":"Get Saved Payment Method","openapi":"GET /v1/c/customer/{customer_id}/payment/method/{method_id}","href":"/dev/api-reference/payment/get_c_customer_customerid_payment_method_methodid"},{"title":"List saved Payment Methods","openapi":"GET /v1/c/customer/{customer_id}/payment/method","href":"/dev/api-reference/payment/get_c_customer_customerid_payment_method_selection"},{"title":"Set Default Payment Method","openapi":"POST /v1/c/customer/{customer_id}/payment/method_selection","href":"/dev/api-reference/payment/post_c_customer_customerid_payment_method_selection"}]},{"group":"Balance","pages":[{"title":"Get Current Customer Balance","openapi":"GET /v1/c/customer/{customer_id}/balance","href":"/dev/api-reference/balance/get_c_customer_customerid_balance"}]},{"group":"Virtual Wallets (Credits)","pages":[{"title":"Get Virtual Balances","openapi":"GET /v1/c/customer/{customer_id}/virtual-wallet/","href":"/dev/api-reference/virtual-wallet/get_c_customer_customerid_virtual-wallet"},{"title":"Add Virtual Credits","openapi":"POST /v1/c/virtual-wallet-transaction","href":"/dev/api-reference/virtual-wallet/post_c_virtual-wallet-transaction"}]},{"group":"Invoices","pages":[{"title":"List Invoices","openapi":"GET /v1/c/invoice","href":"/dev/api-reference/invoice/get_c_invoice"},{"title":"Get Invoice","openapi":"GET /v1/c/invoice/{invoice_id}","href":"/dev/api-reference/invoice/get_c_invoice_invoiceid"},{"title":"Configure Global Invoicing Preferences","openapi":"POST /v1/c/preferences/invoicing","href":"/dev/api-reference/invoice/post_c_preferences_invoicing"},{"title":"Manually Trigger Invoice Generation","openapi":"POST /v1/c/invoice","href":"/dev/api-reference/invoice/post_c_invoice"}]}]}]}]},"basePath":"","title":"Get Billing Entitlements - Wingback","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}