Usage

Get Subscription Status

Whether this organisation's subscription is active.

Worth checking before anything that spends: a charge against an inactive subscription is refused even when the balance is healthy, so "insufficient credits" is not the only way spending fails.

raise_on_unavailable is set, which is the whole point of answering this as its own route rather than as a boolean somewhere else: without it an unreachable billing service and an authoritatively-inactive subscription both answer false, and those two mean opposite things. Unreachable becomes a 503 here; false means false.

get/usage/subscription

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/usage/subscription
  • 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.