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

# Get credit balance

`GET /credits`

## Request

- Base URL: `https://api.bankstatemently.com/v1`
- URL: `https://api.bankstatemently.com/v1/credits`
- Auth: API key in header `X-API-Key`

Returns the current credit balance for the authenticated user. Recommended: call this before large uploads to ensure sufficient credits. 1 credit = 1 page. Rate limit: 120 requests per minute.

## Response `200`

Current credit balance.

- object
  - `balance` integer, required: Current remaining credits. 1 credit = 1 page.
  - `limit` integer, nullable, required: Plan allowance. 10 for free, plan-specific for paid. null when the plan has no monthly allowance (e.g. enterprise).
  - `planId` 'free' | 'pro' | 'business', required: Current plan identifier.
  - `creditsExpireAt` string, date-time, nullable, required: When current plan credits reset, or null for plans without expiry.

## Other responses

- `401`: Authentication failed, API key revoked, or API key expired.
- `429`: Too many requests. Wait the number of seconds indicated by the `Retry-After` header.
- `500`: An unexpected server error occurred.

---

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