Introducing OpenTelemetry for Chargebee SDKs — trace every API call in any telemetry tool.
Chargebeechargebee API

Alert statuses

An alert status represents the runtime evaluation of an alert for a specific subscription. While the alert resource defines the threshold rule, the alert status tells you whether a subscription is currently within_limit or in_alarm for that rule. Statuses are tracked for every alert type — usage_exceeded and spend_exceeded.

Each alert status tracks:

  • alarm_status: The current state — within_limit (the subscription is within the configured threshold) or in_alarm (the threshold has been breached).
  • alarm_triggered_at: The timestamp when the alert last entered the in_alarm state. This is null if the alert has never been triggered for this subscription.

Note: Alert statuses are computed by Chargebee based on billing data and the alert configuration. They are read-only — you cannot create or update an alert status directly. To change the threshold rule, use the Alerts API.

Sample Alert statusJSON

API Index URL

https://[site].chargebee.com/api/v2/alert_statuses

Alert statuses attributes

alert_id
required, string, max chars=50

The identifier of the alert configuration that this status corresponds to.

subscription_id
required, string, max chars=50

The identifier of the subscription that this status is evaluated for.

alarm_status
required, enumerated string

The current runtime state of the alert for this subscription. Indicates whether the subscription is within the configured threshold or has breached it.

Enum Values
within_limit

The subscription is within the configured threshold.

in_alarm

The configured threshold has been breached and the alert has been triggered for this subscription. For usage_exceeded and spend_exceeded alerts, this means the measured value has reached or exceeded the threshold.

alarm_triggered_at
optional, timestamp(UTC) in seconds

Timestamp (UTC, in seconds) indicating when the alert last entered the in_alarm state for this subscription. null if the alert has never been triggered.