Skip to main content
GET
Read a Domain's remaining budget per bucket

Authorizations

X-API-Key
string
header
required

Path Parameters

tenancy_id
string
required

Response

Successful Response

Live remaining provider budget for one Five9 Domain, by bucket and window.

This is a PROJECTION of the quota ledger, not a reservation. A value here is not a guarantee that a call will be accepted: budget is spent by every credential sharing this Domain, and other systems can spend the same Domain's provider budget outside this platform entirely. Read it to show a customer how much room is left and to explain why work is pacing — never as a client-side gate before submitting work. The platform's own dispatcher is the only component that decides whether a call may proceed, and it decides at the moment of the call.

buckets is keyed by the provider's operation-type name (for example Upload), and as_of is when the underlying counters were read; it is null for a Domain that has never dispatched.

tenancy_id
string
required
buckets
Buckets · object
required
as_of
string<date-time> | null