Skip to main content

Create customer alert by external ID​

This endpoint creates a new alert to monitor a customer's credit balance. There are three types of alerts that can be scoped to customers: credit_balance_depleted, credit_balance_dropped, and credit_balance_recovered. Customers can have a maximum of one of each type of alert per credit balance currency. credit_balance_dropped alerts require a list of thresholds to be provided while credit_balance_depleted and credit_balance_recovered alerts do not require thresholds.

Path Parameters
    external_customer_id string required
Request Body
    type string required

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

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

    thresholds object[] nullable

    The thresholds that define the values at 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.

  • ]
    • currency string required

    The case sensitive currency or custom pricing unit to use for this alert.

Responses

Created

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...