---
title: "The prepaid key’s balance and recent ledger entries. Free."
method: GET
path: "/balance"
---

# The prepaid key’s balance and recent ledger entries. Free.

`GET /balance`

## Request

- Base URL: `https://app.difficat.com/api/v1`
- URL: `https://app.difficat.com/api/v1/balance`
- Auth: HTTP bearer

## Response `200`

OK

- BalanceResponse
  - `keyId` string, required
  - `balance` string, required: Spendable prepaid money, decimal USD, for any key.
  - `currency` 'USD', required
  - `allowance` object: Pro account’s key only: the current period’s included captured pages, shared with the web app; a live pair is 2, a pair against a snapshot 1.
    - `includedPages` integer, required
    - `pagesUsed` integer, required
    - `resetsAt` string, date-time, required
  - `overage` object: Pro account’s key only: overage priced this period and the cap, decimal USD.
    - `amount` string, required
    - `capUsd` string, required
  - `recent` object[], required: The last 20 ledger entries, newest first.
    - `at` string, date-time, required
    - `type` 'topup' | 'debit' | 'reversal' | 'overage', required
    - `amount` string, required
    - `kind` 'discover' | 'screenshot' | 'job'
    - `jobId` string
    - `surface` 'web' | 'api': An account key’s draw: spent in the web app or on the API.

## Other responses

- `401`: No key, or an unknown one

---

[API](https://skmtc.dev/difficat/apis/difficat-agent-api.md) · [All operations](https://skmtc.dev/difficat/apis/difficat-agent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/difficat/apis/difficat-agent-api/revisions/49c291e77659?raw)