Alert
List alerts
This endpoint returns a list of alerts within Orb.
The request must specify one of customer_id, external_customer_id, or subscription_id.
If querying by subscription_id, the endpoint will return the subscription level alerts as well as the plan level alerts associated with the subscription.
The list of alerts is ordered starting from the most recently created alert. This endpoint follows Orb's standardized pagination format.
get/alerts
Query parameters
limitinteger
The number of items to fetch. Defaults to 20.
cursorstring nullable
Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.
customer_idstring nullable
Fetch alerts scoped to this customer_id
external_customer_idstring nullable
Fetch alerts scoped to this external_customer_id
subscription_idstring nullable
Fetch alerts scoped to this subscription_id
created_at[gte]string date-time nullable
created_at[gt]string date-time nullable
created_at[lt]string date-time nullable
created_at[lte]string date-time nullable
Response
OK
Example response
{
"data": [
{
"id": "XuxCbt7x9L82yyeF",
"plan": {
"id": "m2t5akQeh2obwxeU",
"external_plan_id": "m2t5akQeh2obwxeU",
"name": "Example plan"
},
"subscription": {
"id": "VDGsT23osdLb84KD"
}
}
]
}