Get Credits
This workspace’s credit balance in this region, what it buys, and what a top-up costs.
Readable by every role: a VIEWER can start a web call, so a VIEWER must be able to see why one was refused.
This is also where credit the control plane could not deliver lands. Anything it has issued for this workspace here — a purchase, a signup grant, a reversal — that this region has not written yet is applied before the balance is read. That is the backstop for a failed push, and it is a reconcile on demand rather than a timer: the moment someone cares is the moment this page loads, whether they arrived from the payment processor or from the “out of credits” banner. It costs nothing when there is nothing to apply, which is almost always.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
A top-up to report the payment processor's own status for.
Response
Successful Response
This region's balance for the workspace, what it buys, and top-up prices.
Per region, because the balance is a data-plane table. A caller reading this is reading the balance of whichever region's API they called, and the dashboard labels it with that region's name — a bare number is what makes a customer with $50 in one region and $0 in another think the money vanished.
"USD"pending, paid, failed, cancelled, refunded