---
title: "Get the credit balance summary"
method: GET
path: "/credits/summary/"
tags: ["credits"]
---

# Get the credit balance summary

`GET /credits/summary/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/credits/summary/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

The global credit meter: available balance, period allowance, refill date, and the low/blocked flags. Cheap to poll; lazily creates the balance with the plan's initial grant on first access.

## Response `200`

Successful Response

- CreditBalanceSummarySchema: The global credit meter: credits left, allowance, period, and flags.
  - `available` number, required: Credits left to spend: the balance, floored at zero, in decimal credits. A running table's hold does not lower it.
  - `balance` number, required: Settled credit balance, in decimal credits.
  - `held` number, required: Credits in-flight runs set aside for their highest possible cost, in decimal credits. Still part of the balance until charged, so it does not lower the credits left.
  - `is_blocked` boolean, required: The balance is empty; credit-consuming work is refused.
  - `is_low` boolean, required: The balance is at or below the low-balance threshold.
  - `period_allowance` number, required: Credits granted each period by the plan, in decimal credits.
  - `period_end` string, date-time, required: When the allowance next refills.
  - `period_start` string, date-time, required: Start of the current grant period.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)