Skip to main content

Enable alert by ID​

This endpoint allows you to enable an alert. To enable a plan-level alert for a specific subscription, you must include the subscription_id. The subscription_id is not required for customer or subscription level alerts.

Path Parameters
    alert_configuration_id string required
Query Parameters
    subscription_id string
Responses

OK

Response Headers
    Schema
      id string required

      Also referred to as alert_id in this documentation.

      type string required

      Possible values: [usage_exceeded, cost_exceeded, credit_balance_depleted, credit_balance_dropped, credit_balance_recovered]

      The type of alert. This must be a valid alert type.

      created_at date-time required

      The creation time of the resource in Orb.

      enabled boolean required

      Whether the alert is enabled or disabled.

      thresholds object[] nullable required

      The thresholds that define the conditions under which the alert will be triggered.

    • Array [
      • value number required

      The value at which an alert will fire. For credit balance alerts, the alert will fire at or below this value. For usage and cost alerts, the alert will fire at or above this value.

    • ]
      • customer object nullable required

      The customer the alert applies to.

      property name* string nullable
      plan object nullable required

      The plan the alert applies to.

      property name* string nullable
      subscription object nullable required

      The subscription the alert applies to.

      property name* string nullable
      metric object nullable required

      The metric the alert applies to.

      property name* string nullable
      currency string nullable required

      The name of the currency the credit balance or invoice cost is denominated in.

    Loading...