Skip to the documentation
API

List the billing alerts

What the billing banner of the app would say now, most urgent first.

GET/billing/alerts

Runs the real call on your workspace.

GET /billing/alerts

What the billing banner of the app would say now, most urgent first.

Example

Needs billing:read. kind is payment_failed, pay_as_you_go_paused, sending_paused, spend_limit_reached, ai_used_up, plan_ending, sends_nearly_used, spend_nearly_reached or upcoming_charge, and target says whether it is about the plan or the usage. An empty list means there is nothing to say.

curl
curl "$OE/billing/alerts" -H "$AUTH"
Response
{  "object": "list",  "data": [    {      "object": "billing_alert",      "id": "upcoming_charge:plan:2026-11-01T09:00:00.000Z",      "kind": "upcoming_charge",      "severity": "info",      "target": "billing",      "planName": "Business",      "at": "2026-11-01T09:00:00.000Z",      "cents": 10000,      "currency": "usd",      "used": null,      "limit": null,      "payAsYouGo": false    }  ]}

An alert keeps its id while the same thing is true, so one somebody dismissed can stay dismissed.

Only the owner of the workspace reaches billing: an API key, or an access token the owner connected with every address. A member’s token is a 403 owner_only, and a key or token limited to particular addresses or domains is a 422 capability_unsupported.

Reference