The description of the health status returned by the Service Adapter.
Maximum string length: 250
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Chargebee Partner docs","colors":{"primary":"#ff3300","light":"#ff3300","dark":"#01283a"},"logo":{"light":"https://mintcdn.com/cb/t_llHYxnCXjWsl_M/logo/light.svg?fit=max\u0026auto=format\u0026n=t_llHYxnCXjWsl_M\u0026q=85\u0026s=ea8284652978e0e228b6e8490b85f386","dark":"https://mintcdn.com/cb/t_llHYxnCXjWsl_M/logo/dark.svg?fit=max\u0026auto=format\u0026n=t_llHYxnCXjWsl_M\u0026q=85\u0026s=ec5bfa91e37e3d17f52113436b5fa3c4"},"favicon":"https://mintcdn.com/cb/5NA3_g6K23tnaaEn/logo/favicon.png?fit=max\u0026auto=format\u0026n=5NA3_g6K23tnaaEn\u0026q=85\u0026s=f9754a80dbaca6ded2263ed1f98043a0","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl"],"prefill":true}},"background":{},"navbar":{"links":[{"href":"mailto:support@chargebee.com","label":"Support"}]},"integrations":{"ga4":{"measurementId":"G‑EJ2MQ2ENV4"}},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cb","hasAudioNarration":false,"actualSubdomain":"cb","customDomains":["spidocs.chargebee.com"],"gitSource":{"type":"github","owner":"chargebee","repo":"cb-partner-spi","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aed672b197e48bb5f92b9a1","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":41},{"language":"default","tag":"Tax SPI","count":16},{"language":"default","tag":"Einvoicing SPI","count":14},{"language":"default","tag":"Tax Registration Number Validation SPI","count":9},{"language":"default","tag":"Tax Registration Number Validation","count":5},{"language":"default","tag":"CreditNote","count":4},{"language":"default","tag":"Invoice","count":4},{"language":"default","tag":"Health","count":3},{"language":"default","tag":"Authentication","count":3},{"language":"default","tag":"Authorization","count":3}]},"assistantConfig":{},"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":"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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider","slug":"/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider","pageMetadata":{"openapi":"get /health","title":"Fetch the health status of the Service Provider.","description":"This endpoint is used to fetch the health status of the Service Provider.","href":"/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider"},"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: \"This endpoint is used to fetch the health status of the Service Provider.\"\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":{"openapi":"get /health","title":"Fetch the health status of the Service Provider.","description":"This endpoint is used to fetch the health status of the Service Provider.","href":"/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"This endpoint is used to fetch the health status of the Service Provider.","operationId":"fetchHealth","parameters":["32dad142-1d1f-4556-acdf-bdc6f830d53f","72ff8c95-6979-4fe9-a037-f2f297f4763f"],"responses":{"200":"67b8b9b1-af1c-451a-a6ff-22a57ec68621","429":"eb761f33-fa81-4e87-9d60-e2cf0cfe70a5","500":"38d3b2eb-81e4-4052-a92c-6f0623ebd350","503":"0d37fa21-5e3c-49d2-be20-9b5d98fade80"},"summary":"Fetch the health status of the Service Provider.","tags":["Health"],"x-accepts":"application/json","method":"get","type":"path","servers":["d4e8961d-07b7-4e1a-b0c5-0b6bbe82dc44","1872f517-eb3d-495f-a47d-0201ba038077"],"security":["1be7715d-498a-43d8-9821-6e1994b12760"],"path":"/health","baseUrlOptions":["https://api.example.com","https://sandbox.example.com"],"title":"Fetch the health status of the Service Provider.","codeSamples":[],"requestExampleLanguages":["bash"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"32dad142-1d1f-4556-acdf-bdc6f830d53f":{"description":"Merchant's domain name will be sent by Chargebee","in":"header","name":"merchant_id","required":false,"schema":{"type":"string","isRequired":false,"description":"Merchant's domain name will be sent by Chargebee","uniqueKey":"","typeLabel":"string"}},"72ff8c95-6979-4fe9-a037-f2f297f4763f":{"description":"Unique id of the request will be sent by Chargebee","in":"header","name":"trace_id","required":false,"schema":{"type":"string","isRequired":false,"description":"Unique id of the request will be sent by Chargebee","uniqueKey":"","typeLabel":"string"}}},"responses":{"67b8b9b1-af1c-451a-a6ff-22a57ec68621":{"content":{"application/json":{"example":{"status":"UP","version":"1.0.0","description":"The service is healthy.","components":[{"id":"app-db-memory","name":"Application Database","type":"DATABASE","status":"UP"},{"id":"adapter-server","name":"Adapter API Server","type":"ADAPTER","status":"UP"},{"id":"service-server","name":"API Server","type":"API","status":"UP"}],"time":"2022-11-01T05:12:08.131Z"},"schema":{"example":{"components":[{"endpoints":["endpoints","endpoints"],"name":"name","description":"description","id":"id","type":"OTHER","status":null},{"endpoints":["endpoints","endpoints"],"name":"name","description":"description","id":"id","type":"OTHER","status":null}],"description":"description","time":"2000-01-23T04:56:07.000Z","version":"version","status":null},"properties":{"status":{"description":"The status of a specific component reported by the Service Adapter.","enum":["UP","DOWN","WARN"],"type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"components":{"description":"List of health status details for each component reported by the Service Adapter.","items":{"description":"The health status details of a specific component reported by the Service Adapter.","example":{"endpoints":["endpoints","endpoints"],"name":"name","description":"description","id":"id","type":"OTHER","status":null},"properties":{"id":{"description":"The id of the component.","maxLength":50,"type":"string","isRequired":true,"uniqueKey":"components.items.[INDEX].id","typeLabel":"string"},"name":{"description":"The name of the component.","maxLength":150,"type":"string","isRequired":true,"uniqueKey":"components.items.[INDEX].name","typeLabel":"string"},"type":{"description":"The type of component affected when `status` is `WARN` or `DOWN`. The possible values are:\n- `ADAPTER`: The reported status is for the Service Adapter.\n- `API`: The reported status is for the Service Provider.\n- `DATABASE`: The reported status is for a database dependency of the Service Provider.\n- `SYSTEM`: The reported status is for any other known system component such as cache or gateway.\n- `OTHER`: The reported status is either for a component that does not belong to the types described above or the source of the issue is unknown.\n","enum":["OTHER","SYSTEM","API","ADAPTER","DATABASE"],"type":"string","isRequired":true,"uniqueKey":"components.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"status":{"description":"The status of a specific component reported by the Service Adapter.","enum":["UP","DOWN","WARN"],"type":"string","isRequired":true,"uniqueKey":"components.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"description":{"description":"The detailed status of the component.","maxLength":250,"type":"string","uniqueKey":"components.items.[INDEX].description","typeLabel":"string"},"endpoints":{"description":"When the `status` of the component is not `UP`, then the list of endpoints affected.","items":{"type":"string","uniqueKey":"components.items.[INDEX].endpoints.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"components.items.[INDEX].endpoints","typeLabel":"string[]"}},"required":["id","name","status","type"],"type":"object","uniqueKey":"components.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"components","typeLabel":"object[]"},"time":{"description":"The timestamp of the health status reported by the Service Adapter.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"time","typeLabel":"string\u003cdate-time>"},"version":{"minLength":1,"type":"string","uniqueKey":"version","typeLabel":"string"},"description":{"description":"The description of the health status returned by the Service Adapter.","maxLength":250,"type":"string","uniqueKey":"description","typeLabel":"string"}},"required":["components","status","time"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"UP","version":"1.0.0","description":"The service is healthy.","components":[{"id":"app-db-memory","name":"Application Database","type":"DATABASE","status":"UP"},{"id":"adapter-server","name":"Adapter API Server","type":"ADAPTER","status":"UP"},{"id":"service-server","name":"API Server","type":"API","status":"UP"}],"time":"2022-11-01T05:12:08.131Z"}}},"exampleType":"examples"}},"description":"Service is healthy.","exampleType":"examples"},"eb761f33-fa81-4e87-9d60-e2cf0cfe70a5":{"description":"Too many requests.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"38d3b2eb-81e4-4052-a92c-6f0623ebd350":{"content":{"application/json":{"example":{"message":"Unexpected error during processing the request."},"schema":{"additionalProperties":false,"description":"The basic error response containing the error message and the help documentation link.","properties":{"message":{"description":"The description of the error with details about it's cause.","example":"Invalid Credentials","maxLength":250,"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"helpUrl":{"description":"The link to the documentation for more information about the error and the corrective action.","example":"https://apidocs.chargebee.com#Authentication","format":"uri","type":"string","uniqueKey":"helpUrl","typeLabel":"string\u003curi>"}},"required":["message"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Unexpected error during processing the request."}}},"exampleType":"examples"}},"description":"Unexpected error while processing request.","exampleType":"examples"},"0d37fa21-5e3c-49d2-be20-9b5d98fade80":{"content":{"application/json":{"example":{"status":"DOWN","version":"1.0.0","description":"The service is unhealthy. Several components are down.","components":[{"id":"app-db-memory","name":"Application Database Memory Usage","type":"DATABASE","status":"UP"},{"id":"adapter-server","name":"Adapter API Server","type":"ADAPTER","status":"DOWN"},{"id":"service-server","name":"API Server","type":"API","status":"DOWN"}],"time":"2022-11-01T05:12:08.131Z"},"schema":{"example":{"components":[{"endpoints":["endpoints","endpoints"],"name":"name","description":"description","id":"id","type":"OTHER","status":null},{"endpoints":["endpoints","endpoints"],"name":"name","description":"description","id":"id","type":"OTHER","status":null}],"description":"description","time":"2000-01-23T04:56:07.000Z","version":"version","status":null},"properties":{"status":{"description":"The status of a specific component reported by the Service Adapter.","enum":["UP","DOWN","WARN"],"type":"string","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"components":{"description":"List of health status details for each component reported by the Service Adapter.","items":{"description":"The health status details of a specific component reported by the Service Adapter.","example":{"endpoints":["endpoints","endpoints"],"name":"name","description":"description","id":"id","type":"OTHER","status":null},"properties":{"id":{"description":"The id of the component.","maxLength":50,"type":"string","isRequired":true,"uniqueKey":"components.items.[INDEX].id","typeLabel":"string"},"name":{"description":"The name of the component.","maxLength":150,"type":"string","isRequired":true,"uniqueKey":"components.items.[INDEX].name","typeLabel":"string"},"type":{"description":"The type of component affected when `status` is `WARN` or `DOWN`. The possible values are:\n- `ADAPTER`: The reported status is for the Service Adapter.\n- `API`: The reported status is for the Service Provider.\n- `DATABASE`: The reported status is for a database dependency of the Service Provider.\n- `SYSTEM`: The reported status is for any other known system component such as cache or gateway.\n- `OTHER`: The reported status is either for a component that does not belong to the types described above or the source of the issue is unknown.\n","enum":["OTHER","SYSTEM","API","ADAPTER","DATABASE"],"type":"string","isRequired":true,"uniqueKey":"components.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"status":{"description":"The status of a specific component reported by the Service Adapter.","enum":["UP","DOWN","WARN"],"type":"string","isRequired":true,"uniqueKey":"components.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"description":{"description":"The detailed status of the component.","maxLength":250,"type":"string","uniqueKey":"components.items.[INDEX].description","typeLabel":"string"},"endpoints":{"description":"When the `status` of the component is not `UP`, then the list of endpoints affected.","items":{"type":"string","uniqueKey":"components.items.[INDEX].endpoints.items.[INDEX]","typeLabel":"string"},"type":"array","uniqueKey":"components.items.[INDEX].endpoints","typeLabel":"string[]"}},"required":["id","name","status","type"],"type":"object","uniqueKey":"components.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"components","typeLabel":"object[]"},"time":{"description":"The timestamp of the health status reported by the Service Adapter.","format":"date-time","type":"string","isRequired":true,"uniqueKey":"time","typeLabel":"string\u003cdate-time>"},"version":{"minLength":1,"type":"string","uniqueKey":"version","typeLabel":"string"},"description":{"description":"The description of the health status returned by the Service Adapter.","maxLength":250,"type":"string","uniqueKey":"description","typeLabel":"string"}},"required":["components","status","time"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"DOWN","version":"1.0.0","description":"The service is unhealthy. Several components are down.","components":[{"id":"app-db-memory","name":"Application Database Memory Usage","type":"DATABASE","status":"UP"},{"id":"adapter-server","name":"Adapter API Server","type":"ADAPTER","status":"DOWN"},{"id":"service-server","name":"API Server","type":"API","status":"DOWN"}],"time":"2022-11-01T05:12:08.131Z"}}},"exampleType":"examples"}},"description":"Service is unhealthy.","exampleType":"examples"}},"security":{"1be7715d-498a-43d8-9821-6e1994b12760":{"ApiKeyAuth":{"in":"header","name":"Authorization","type":"apiKey","scopes":[]}}},"servers":{"d4e8961d-07b7-4e1a-b0c5-0b6bbe82dc44":{"description":"Production server (replace with actual service URL)","url":"https://api.example.com"},"1872f517-eb3d-495f-a47d-0201ba038077":{"description":"Sandbox server for testing","url":"https://sandbox.example.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"in":"header","name":"Authorization","type":"apiKey","scopes":[]},"schema":{"title":"Authorization","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"spec/spi/generated/einvoicing/api/openapi.yaml"},"subdomain":"cb","siteName":"Chargebee Partner docs","title":"Fetch the health status of the Service Provider. - Chargebee Partner docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-14T04:22:01.925Z","originalFileLocation":"api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider.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=\"This endpoint is used to fetch the health status of the Service Provider.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Chargebee Partner docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cb/t3SWCatkguaBu2Q3/_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/cb/t3SWCatkguaBu2Q3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cb/t3SWCatkguaBu2Q3/_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/cb/t3SWCatkguaBu2Q3/_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/cb/t3SWCatkguaBu2Q3/_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/cb/t3SWCatkguaBu2Q3/_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/cb/t3SWCatkguaBu2Q3/_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/cb/t3SWCatkguaBu2Q3/_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/cb/t3SWCatkguaBu2Q3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Fetch the health status of the Service Provider. - Chargebee Partner docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint is used to fetch the health status of the Service Provider.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Chargebee Partner docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://spidocs.chargebee.com/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cb.mintlify.site/_mintlify/api/og/v2?division=Health\u0026amp;title=Fetch+the+health+status+of+the+Service+Provider.\u0026amp;description=This+endpoint+is+used+to+fetch+the+health+status+of+the+Service+Provider.\u0026amp;theme=5c6997a84c8bc4c1bb578bc5\u0026amp;signature=85f7b97ce53612af1c95e351f4125b9c793e74f33e8626104a8dce87da541251\">\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=\"Fetch the health status of the Service Provider. - Chargebee Partner docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint is used to fetch the health status of the Service Provider.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cb.mintlify.site/_mintlify/api/og/v2?division=Health\u0026amp;title=Fetch+the+health+status+of+the+Service+Provider.\u0026amp;description=This+endpoint+is+used+to+fetch+the+health+status+of+the+Service+Provider.\u0026amp;theme=5c6997a84c8bc4c1bb578bc5\u0026amp;signature=85f7b97ce53612af1c95e351f4125b9c793e74f33e8626104a8dce87da541251\">\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/cb/t3SWCatkguaBu2Q3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Chargebee Partner docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff3300\">\u003clink data-mint-head rel=\"canonical\" href=\"https://spidocs.chargebee.com/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://spidocs.chargebee.com/#organization\",\"name\":\"Chargebee Partner docs\",\"url\":\"https://spidocs.chargebee.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cb/t_llHYxnCXjWsl_M/logo/light.svg?fit=max\u0026auto=format\u0026n=t_llHYxnCXjWsl_M\u0026q=85\u0026s=ea8284652978e0e228b6e8490b85f386\"}},{\"@type\":\"WebSite\",\"@id\":\"https://spidocs.chargebee.com#website\",\"name\":\"Chargebee Partner docs\",\"url\":\"https://spidocs.chargebee.com\",\"publisher\":{\"@id\":\"https://spidocs.chargebee.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://spidocs.chargebee.com/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider#webpage\",\"url\":\"https://spidocs.chargebee.com/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider\",\"name\":\"Fetch the health status of the Service Provider.\",\"description\":\"This endpoint is used to fetch the health status of the Service Provider.\",\"dateModified\":\"2025-08-14T04:22:01.925Z\",\"isPartOf\":{\"@id\":\"https://spidocs.chargebee.com#website\"},\"breadcrumb\":{\"@id\":\"https://spidocs.chargebee.com/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://spidocs.chargebee.com/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tax Registration Number Validation SPI\",\"item\":\"https://spidocs.chargebee.com/api-reference/tax-reg-number-validate/docs/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Fetch the health status of the Service Provider.\",\"item\":\"https://spidocs.chargebee.com/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://spidocs.chargebee.com/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider#apireference\",\"headline\":\"Fetch the health status of the Service Provider.\",\"name\":\"Fetch the health status of the Service Provider.\",\"description\":\"This endpoint is used to fetch the health status of the Service Provider.\",\"url\":\"https://spidocs.chargebee.com/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider\",\"mainEntityOfPage\":{\"@id\":\"https://spidocs.chargebee.com/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider#webpage\"},\"dateModified\":\"2025-08-14T04:22:01.925Z\",\"publisher\":{\"@id\":\"https://spidocs.chargebee.com/#organization\"},\"isPartOf\":{\"@id\":\"https://spidocs.chargebee.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Chargebee Partner docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Chargebee Partner docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider.md","siteName":"Chargebee Partner docs","nav":{"global":null,"tabs":[{"tab":"API Reference","groups":[{"group":"Partner SPI","pages":[{"title":"Overview","href":"/api-reference/partner-spi/overview"}]},{"group":"Tax SPI","pages":[{"title":null,"href":"/api-reference/tax-spi/docs/overview"},{"title":null,"href":"/api-reference/tax-spi/docs/authorization"},{"group":"Address","pages":[{"openapi":"post /address/validate","title":"Address validation","href":"/api-reference/tax-spi/endpoints/v1/address-validation"},{"openapi":"post /address/check-taxability","title":"Check taxability","href":"/api-reference/tax-spi/endpoints/v1/check-taxability"}]},{"group":"TaxEstimate","pages":[{"openapi":"post /tax-estimate","title":"Estimate tax","href":"/api-reference/tax-spi/endpoints/v1/estimate-tax"}]},{"group":"Invoice","pages":[{"openapi":"post /invoices","title":"Create Invoice","href":"/api-reference/tax-spi/endpoints/v1/create-invoice"},{"openapi":"get /invoices/{invoiceId}","title":"Retrieve Invoice","href":"/api-reference/tax-spi/endpoints/v1/retrieve-invoice"},{"openapi":"post /invoices/{invoiceId}/commit","title":"Commit Invoice","href":"/api-reference/tax-spi/endpoints/v1/commit-invoice"},{"openapi":"post /invoices/{invoiceId}/void","title":"Void Invoice","href":"/api-reference/tax-spi/endpoints/v1/void-invoice"}]},{"group":"CreditNote","pages":[{"openapi":"post /credit-notes","title":"Create credit note","href":"/api-reference/tax-spi/endpoints/v1/create-credit-note"},{"openapi":"get /credit-notes/{creditNoteId}","title":"Retrieve credit note","href":"/api-reference/tax-spi/endpoints/v1/retrieve-credit-note"},{"openapi":"post /credit-notes/{creditNoteId}/commit","title":"Commit credit note","href":"/api-reference/tax-spi/endpoints/v1/commit-credit-note"},{"openapi":"post /credit-notes/{creditNoteId}/void","title":"Void credit note","href":"/api-reference/tax-spi/endpoints/v1/void-credit-note"}]},{"group":"Authentication","pages":[{"openapi":"post /credentials/validate","title":"Validate credentials","href":"/api-reference/tax-spi/endpoints/v1/validate-credentials"}]},{"group":"Health","pages":[{"openapi":"get /health","title":"Fetch the health status of the Service Provider.","href":"/api-reference/tax-spi/endpoints/v1/fetch-the-health-status-of-the-service-provider"}]},{"title":"Testing with Postman","href":"/api-reference/tax-spi/docs/testing-with-postman"}]},{"group":"Tax Registration Number Validation SPI","pages":[{"title":null,"href":"/api-reference/tax-reg-number-validate/docs/overview"},{"group":"Authentication","pages":[{"openapi":"post /credentials/validate","title":"Validate credentials","description":"This endpoint is used to validate the credentials used to call the Service Provider.","href":"/api-reference/tax-reg-number-validate/endpoints/v1/validate-credentials"}]},{"group":"Health","pages":[{"openapi":"get /health","title":"Fetch the health status of the Service Provider.","href":"/api-reference/tax-reg-number-validate/endpoints/v1/fetch-the-health-status-of-the-service-provider"}]},{"group":"Tax Registration Number Validation","pages":[{"openapi":"post /trn/validate/batch","title":"Validate the tax registration numbers in batch","description":"This endpoint takes the batch of tax registration numbers and validate.","href":"/api-reference/tax-reg-number-validate/endpoints/v1/validate-the-tax-registration-numbers-in-batch"},{"openapi":"post /trn/validate","title":"Validate the tax registration number","href":"/api-reference/tax-reg-number-validate/endpoints/v1/validate-the-tax-registration-number"},{"openapi":"get /trn/validate/{requestId}","title":"Get the response of tax registration number validate request","href":"/api-reference/tax-reg-number-validate/endpoints/v1/get-the-response-of-tax-registration-number-validate-request"},{"openapi":"get /trn/validate/batch/{batchId}","title":"Get the response of batch of tax registration numbers","href":"/api-reference/tax-reg-number-validate/endpoints/v1/get-the-response-of-batch-of-tax-registration-numbers"},{"openapi":"delete /trn/validate/batch/{batchId}","title":"Delete the request of batch of tax registration numbers validation","href":"/api-reference/tax-reg-number-validate/endpoints/v1/delete-the-request-of-batch-of-tax-registration-numbers-validation"}]},{"title":"Testing with Postman","href":"/api-reference/tax-reg-number-validate/docs/testing-with-postman"}]},{"group":"Einvoicing SPI","pages":[{"title":null,"href":"/api-reference/einvoicing-spi/docs/overview"},{"group":"Authorization","pages":[{"title":null,"href":"/api-reference/einvoicing-spi/docs/authorization/overview"},{"title":"Chargebee to Adapter (Header-Based Auth)","href":"/api-reference/einvoicing-spi/docs/authorization/chargebee_to_adapter"},{"title":"Adapter to Chargebee(OAuth 2.0)","href":"/api-reference/einvoicing-spi/docs/authorization/adapter_to_chargebee"}]},{"group":"Activations","pages":[{"openapi":"get /einvoicing/activations","title":"Retrieve a list of Activations.","href":"/api-reference/einvoicing-spi/endpoints/v1/activations/retrieve-a-list-of-activations"},{"openapi":"get /einvoicing/data_input_fields","title":"Retrieves data input fields","href":"/api-reference/einvoicing-spi/endpoints/v1/activations/retrieves-data-input-fields"}]},{"group":"Documents","pages":[{"openapi":"post /einvoicing/documents","title":"Submit a document","href":"/api-reference/einvoicing-spi/endpoints/v1/documents/submit-a-document"},{"openapi":"get /einvoicing/documents/{document_id}/status","title":"Get Document Status","href":"/api-reference/einvoicing-spi/endpoints/v1/documents/get-document-status"},{"openapi":"get /einvoicing/documents/{document_id}/download","title":"Download Document","href":"/api-reference/einvoicing-spi/endpoints/v1/documents/download-document"}]},{"group":"Callbacks","pages":[{"openapi":"post /api/v2/invoices/{document_id}/einvoice_status","title":"Receive document status updates for an invoice","href":"/api-reference/einvoicing-spi/endpoints/v1/callbacks/receive-document-status-updates-for-invoice"},{"openapi":"post /api/v2/credit_notes/{document_id}/einvoice_status","title":"Receive document status updates for a credit note","href":"/api-reference/einvoicing-spi/endpoints/v1/callbacks/receive-document-status-updates-for-credit-note"}]},{"group":"Authentication","pages":[{"openapi":"post /credentials/validate","title":"Validate credentials","href":"/api-reference/common/validate-credentials"}]},{"group":"Health","pages":[{"openapi":"get /health","title":"Fetch the health status of the Service Provider.","href":"/api-reference/common/fetch-the-health-status-of-the-service-provider"}]},{"title":"Testing with Postman","href":"/api-reference/einvoicing-spi/docs/testing-with-postman"}]},{"group":"Troubleshooting","pages":[{"title":null,"href":"/api-reference/troubleshooting"}]}]},{"tab":"App Onboarding","pages":[{"title":"App Onboarding","href":"/app-onboarding/guide"}]}]},"basePath":"","title":"Fetch the health status of the Service Provider. - Chargebee Partner docs","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}