# Get credit balance and runway

`GET https://api.endless.app/organizations/{organization_id}/reports/balance`

Source: https://endless.app/docs/api/reports/balance

Get credit balance and runway. Scoped to the organization named by `organization_id`.

## Authentication

- `bearerAuth`: HTTP bearer (JWT)

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `organization_id` | path | string | yes |  |
| `Endless-Api-Version` | header | string | no | Pin the caller to an API major (`1`). Omit to accept the current version. A major this deployment cannot serve is refused with 400 `unsupported_api_version`. |

## Responses

### 200 OK

Content type: `application/json` — object

- `available` (number, required)
- `buckets` (array<object>, required)
  - `type` (string, required)
  - `amount` (number, required)
  - `remaining` (number, required)
  - `expires_at` (string (date-time) | null, required)
- `runway` (object, required)
  - `cycle` (object | null, required)
    - `credits_per_day` (number, required)
    - `runs_out_on` (string (date-time) | null, required)
  - `last_7_days` (object, required)
    - `credits_per_day` (number, required)
    - `runs_out_on` (string (date-time) | null, required)
  - `renewal` (object, required)
    - `renews_on` (string (date-time) | null, required)
    - `credits_per_day` (number | null, required)
- `plan_history` (array<object>, required)
  - `id` (string, required)
  - `source` ("free" | "plan" | "contract" | "trial" | "internal", required)
  - `anchor_at` (string, required)
  - `interval` ("day" | "week" | "month" | "year", required)
  - `interval_count` (number, required)
  - `credits_per_cycle` (number | null, required)
  - `ends_at` (string | null, required)
  - `ended_reason` (string | null, required)
  - `created_at` (string, required)
  - `plan_name` (string | null, required)

### Errors

- `400` (Error): The request is malformed, or failed input validation. `message` names the field and the rule it broke; `data.issues` carries them individually.
- `401` (Error): No bearer token, or a token that failed verification.
- `402` (Error): The workspace has no credits left, or the caller is over a spending limit.
- `403` (Error): Authenticated, but the caller's role in this workspace does not carry the permission this operation needs.
- `404` (Error): No resource with that id, or the caller cannot read it. The two are deliberately one answer, so an id cannot be probed for existence.
- `409` (Error): The request is well-formed, but the resource's current state forbids it — a taken name, a last admin, a limit already reached.
- `429` (Error): The caller has spent its rate-limit window. `Retry-After` says when to come back.
- `500` (Error): The request failed on our side. Safe to retry an idempotent operation with backoff.