Usage

Get Credit 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.

get/usage/holds

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/usage/holds
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataReportPayload required

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.

Changes

No recorded changes to this operation across all 2 revisions of this API.