Get Credit Holds
GET /usage/holds
Credits currently RESERVED against work in flight.
This is the difference GET /usage reports but cannot explain: a hold
subtracts from available_credits without appearing in the transaction
ledger, because nothing has been spent yet. An operation that reserves
credits up front and settles later shows up here in between.
A balance that looks lower than the ledger says is almost always this.
The org is the authenticated key’s own. There is no customer parameter on this route.
Authorizations
Parameters
Header Parameters
Responses
200
Successful Response
object
An OPEN envelope around one report’s answer.
The app wraps every one of these reports in {success, data, meta}, where
meta carries the cache state, the window and - on the agency reports -
failed_org_ids, the orgs that contributed NOTHING to the totals above.
That field is the difference between “this client sent no email” and “we
could not query this client”, so it is forwarded rather than flattened
away.
Open on purpose: data is dict | list in the app and its contents grow
with the product. A closed model would turn every new metric into a
silently dropped one.
object
object
Whether there are more pages
Items per page
Current page number (1-indexed)
Total number of items
422
Validation Error