Skip to main content

SubscriptionHealthStatus

The possible health statuses of a subscription or one of its health checks.

enum SubscriptionHealthStatus {
  AT_RISK
  BROKEN
  HEALTHY
  RECOVERED
  UNHEALTHY
  UNKNOWN
}

Values​

SubscriptionHealthStatus.AT_RISK​

A problem was found that may stop the subscription generating orders, such as too few scheduled orders.

SubscriptionHealthStatus.BROKEN​

A problem was found that stops the subscription generating or processing orders.

SubscriptionHealthStatus.HEALTHY​

No problems were found.

SubscriptionHealthStatus.RECOVERED​

The subscription had flagged orders that have since been processed.

SubscriptionHealthStatus.UNHEALTHY​

A problem was found that needs attention, such as several orders due at once.

SubscriptionHealthStatus.UNKNOWN​

The subscription's health hasn't been checked yet.

Member Of​

searchSubscriptions query ● Subscription object ● SubscriptionFilter input ● SubscriptionHealthCheck object ● subscriptionPagination query