---
title: "Get the organization's credit balance"
method: GET
path: "/api/organizations/credits"
tags: ["Credits"]
---

# Get the organization's credit balance

`GET /api/organizations/credits`

## Request

- Base URL: `https://aximo.autify.com`
- URL: `https://aximo.autify.com/api/organizations/credits`
- Auth: API key in header `x-api-key`
- TypeScript: <https://skmtc.dev/autify/apis/aximo-api/docs/api/organizations/credits/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the organization's credits for the current period: how many were
granted, how many are used, and how many remain. These are the same figures
the Credits page in Aximo shows. Read it before a run to warn when the
balance is low, instead of learning it from a run refused with `403`.

Figures are in the organization's credit unit, named by `creditUnit`. The
two units are not interchangeable, and nothing converts between them.

An organization whose contract has expired, or a request from outside the
organization's IP allowlist, is refused with `403` before the balance is read.

## Response `200`

The organization's credit balance.

- object
  - `creditUnit` 'legacy' | 'platform', required: The unit every figure is in. `platform` for an organization on Autify Platform credits, `legacy` otherwise.
  - `granted` number, required: Credits available this period, used plus remaining.
  - `used` number, required: Credits used this period.
  - `remaining` number, required: Credits left in the balance. Never negative. Does not include on-demand credits, so it can be `0` while runs still start; check `onDemandRemaining` and `blocked`.
  - `onDemandRemaining` number, required: On-demand credits still available this period once `remaining` is used up. `0` when on-demand is off.
  - `metered` boolean, required: Whether this deployment enforces credits. When `false`, runs are never refused for credits and the figures can be ignored.
  - `blocked` boolean, required: Whether starting a session or run right now would be refused with `403` and reason `insufficient_credits`.

## Other responses

- `401`: Missing or invalid API key.
- `403`: The organization's contract has expired, the request comes from outside the organization's IP allowlist, or the API key's user is banned or no longer a member.
- `429`: Rate limit exceeded — e.g. the daily session limit was reached for the organization, or too many API requests were sent in a short window (retry after the number of seconds in the `Retry-After` header).
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/autify/apis/aximo-api.md) - [All operations](https://skmtc.dev/autify/apis/aximo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/autify/apis/aximo-api/revisions/590722011284?raw)