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

Update an alert

Idempotency Supported

Updates an existing alert configuration. Use this to change the threshold values or toggle the status between enabled and disabled.

Impacts

Alert status on threshold change

When the threshold is updated for an alert, the alarm_status for all impacted subscriptions is reset to within_limit. The alert is re-evaluated the next time Chargebee processes data relevant to that alert.

Alert status on disable

When the alert status is changed to disabled, all further evaluation stops. No webhooks are fired for this alert while it is disabled. When the alert is re-enabled, the alarm_status is set to within_limit and is re-evaluated when Chargebee next processes relevant data for the alert.

Sample Request

Sample Result[JSON]

URL Format

POST https://[site].chargebee.com/api/v2/alerts/{alert-id}

Input Parameters

status
optional, enumerated string, default=enabled

Set to enabled to activate the alert or disabled to deactivate it.

Enum Values
enabled

The alert is active and will trigger when the threshold is breached.

disabled

The alert is inactive and will not trigger.

threshold
Parameters for threshold
pass parameters as threshold[<param name>]

Returns

Alert object
Resource object representing alert