Introducing the Better Auth Chargebee plugin: Use it to handle subscriptions, billing, and auth seamlessly.Try now
ChargebeeAPI

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.

Each alert status tracks:

  • alarm_status: The current state — within_limit (usage is below the threshold) or in_alarm (usage has breached the threshold).
  • 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 usage 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's usage is within the configured threshold or has breached it.

Enum Values
within_limit

Usage is below the configured threshold. The alert has not been triggered for this subscription.

in_alarm

Usage has reached or exceeded the configured threshold. The alert has been triggered for this subscription.

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.