---
title: "Get Subscription Status"
method: GET
path: "/usage/subscription"
tags: ["Usage"]
---

# Get Subscription Status

`GET /usage/subscription`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/usage/subscription`
- Auth: HTTP bearer

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.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseReportPayload
  - `data` ReportPayload, 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.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)