younifyd
Menu

List Alert Statuses For A Subscription

List alert statuses for a subscription

GET/subscriptions/{subscription-id}/alert_statuses

Use it in a workflow

  1. Add a step and choose the Chargebee connector.
  2. Pick the List Alert Statuses For A Subscription action (under Chargebee API).
  3. Fill in the fields below, then reference the result from later steps as {{listAlertStatusesForASubscription.response.data}}.

Request

Path parameters

subscription-idstringrequired

Query parameters

limitinteger (int32)

optional, integer Maximum number of results to return. **Example →** *limit = 10*

Default 10

offsetstring

<dfn class="text-muted"><p class="mb-2">optional, string</p></dfn> <p class="mb-2">Pagination cursor returned by a previous list call. Use the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code> value from the previous response.</p>

alarm_statusobject

optional, enumerated string filter Filter by [alarm_status](/docs/api/alert_statuses/alert-status-object#alarm_status) to find alerts in a specific runtime state. **Example →** *alarm_status\[is\] = "in_alarm"*

isstring

\* \`within_limit\` - WITHIN_LIMIT \* \`in_alarm\` - IN_ALARM

One ofwithin_limitin_alarm

alert_idobject

optional, string filter Filter by [alert_id](/docs/api/alert_statuses/alert-status-object#alert_id) to find the status for a specific alert. **Example →** *alert_id\[is\] = "alert___dev__3Nl7purV3LwbKYH"*

instring

Headers

chargebee-request-origin-devicestring

The device from which the customer has made the request

chargebee-request-origin-userstring (email)

The email address of your customer/user. Use this when the email address has only ASCII characters.

chargebee-request-origin-user-encodedstring (email)

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

chargebee-request-origin-ipstring

The IP address of the customer where the request originated

chargebee-business-entity-idstring

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

Response

Returns 200 with an object. Read it in later steps with {{listAlertStatusesForASubscription.response.data.<field>}}.

listarray<object>
alert_statusobjectrequired4 fields

<div class="api-description"><span featureId="cb-ubb"></span><p class="mb-2">An alert status represents the runtime evaluation of an <a href="/docs/api/alerts">alert</a> for a specific <a href="/docs/api/subscriptions">subscription</a>. While the <a href="/docs/api/alerts/alert-object">alert</a> resource defines the threshold rule, the alert status tells you whether a subscription is currently <code>within_limit</code> or <code>in_alarm</code> for that rule.</p><p class="mb-2">Each alert status tracks:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed"><code>alarm_status</code>: The current state — <code>within_limit</code> (usage is below the threshold) or <code>in_alarm</code> (usage has breached the threshold).</li> <li class="text-base leading-relaxed"><code>alarm_triggered_at</code>: The timestamp when the alert last entered the <code>in_alarm</code> state. This is <code>null</code> if the alert has never been triggered for this subscription.</li> </ul><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong> 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 <a href="/docs/api/alerts">Alerts</a> API.</p></div></div>

next_offsetstring

<p class="mb-2">Returned only if more results are available. Pass this value as <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code> in the next request to fetch the next page.</p>

json
{
  "list": null,
  "next_offset": null
}

Need more? See the Chargebee guide for connection setup and behaviour shared by every action.