Skip to main content

Alert types

Evaluation mechanics

Fetching current alert state

Use the fetch‑alert endpoint to retrieve the serialized balance_alert_status.
The object lists each threshold alongside a boolean indicating whether it is currently in alert.

Practical considerations

  • If the balance drops below and then quickly rises above a threshold, Orb may emit only the final (recovered) state. Rely on balance_alert_status serialized on the alert for the ground‑truth snapshot.
  • A depleted balance on the ledger can lead to immediate overage charges depending on plan configuration if usage continues. In order to resolve this, you can:
    • Manually add and backdate a credit block will cover existing overages.
    • Alternatively, enable top‑ups to automate this workflow; you can think of a top‑up as a material side effect of a balance alert. Note that top-ups also execute with the same tight SLAs as balance alerts, so will typically operate very quickly.