GET
/
alerts
curl --request GET \
  --url https://api.withorb.com/v1/alerts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "XuxCbt7x9L82yyeF",
      "type": "\"usage_exceeded\", \"cost_exceeded\", \"credit_balance_depleted\", credit_balance_recovered\", or \"credit_balance_dropped\"",
      "created_at": "2023-11-07T05:31:56Z",
      "enabled": true,
      "thresholds": [
        {
          "value": 123
        }
      ],
      "customer": {
        "id": "<string>",
        "external_customer_id": "<string>"
      },
      "plan": {
        "id": "m2t5akQeh2obwxeU",
        "external_plan_id": "m2t5akQeh2obwxeU",
        "name": "Example plan",
        "plan_version": "<string>"
      },
      "subscription": {
        "id": "VDGsT23osdLb84KD"
      },
      "metric": {
        "id": "<string>"
      },
      "currency": "<string>"
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Query Parameters

​
limit
integer
default:
20

The number of items to fetch. Defaults to 20.

Required range: 1 < x < 100
​
cursor
string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

​
customer_id
string | null

Fetch alerts scoped to this customer_id

​
external_customer_id
string | null

Fetch alerts scoped to this external_customer_id

​
subscription_id
string | null

Fetch alerts scoped to this subscription_id

​
created_at[gte]
string | null
​
created_at[gt]
string | null
​
created_at[lt]
string | null
​
created_at[lte]
string | null

Response

200
application/json
OK
​
data
object[]
required

Alerts within Orb monitor spending, usage, or credit balance and trigger webhooks when a threshold is exceeded.

Alerts created through the API can be scoped to either customers or subscriptions.

​
pagination_metadata
object
required

Was this page helpful?

Cached usage responsesCreate customer alert