Skip to main content
GET
Fetch the health status of the Service Provider.

Authorizations

Authorization
string
header
required

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 string length: 1
description
string

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

Maximum string length: 250