Skip to main content
GET
/
health
Fetch the health status of the Service Provider.
curl --request GET \
  --url https://rest.taxes.provider.com/api/v1/health \
  --header 'Authorization: <api-key>'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

The json of all the parameters specified in authentication configuration of tax app will be sent by Chargebee.

Headers

​
merchant_id
string

Merchant's domain name will be sent by Chargebee

​
trace_id
string

Unique id of the request will be sent by Chargebee

Response

Service is healthy.

​
status
enum<string>
required

The status of a specific component reported by the Service Adapter.

Available options:
UP,
DOWN,
WARN
​
components
object[]
required

List of health status details for each component reported by the Service Adapter.

​
time
string<date-time>
required

The timestamp of the health status reported by the Service Adapter.

​
version
string
Minimum length: 1
​
description
string

The description of the health status returned by the Service Adapter.

Maximum length: 250