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

# Get the credit balance

`GET /credits/balance`

## Request

- Base URL: `https://api.invoicedataextraction.com/v1`
- URL: `https://api.invoicedataextraction.com/v1/credits/balance`
- Auth: HTTP bearer

The account's total credit balance and the credits reserved by extractions in
progress. The usable balance is `credits_balance` minus `credits_reserved`. Costs
nothing, so it is the call to verify a new key with.

Rate limit: 60 requests per minute per API key.

## Response `200`

The balance.

- CreditsBalanceResponse
  - `success` true, required
  - `credits_balance` integer, required: Total balance, paid and free credits together.
  - `credits_reserved` integer, required: Held by extractions in progress; up to this much is deducted when they complete.

## Other responses

- `401`: `UNAUTHENTICATED`, `API_KEY_EXPIRED` or `API_KEY_REVOKED`.
- `429`: `RATE_LIMITED`: wait `details.retry_after_seconds` (also the `Retry-After` header), then retry.
- `500`: `INTERNAL_ERROR`: retry after a short delay.

---

[API](https://skmtc.dev/invoicedataextraction/apis/invoice-data-extraction-api.md) · [All operations](https://skmtc.dev/invoicedataextraction/apis/invoice-data-extraction-api/llms.txt) · [OpenAPI document](https://skmtc.dev/invoicedataextraction/apis/invoice-data-extraction-api/revisions/16d920350483?raw)