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

# Read the prepaid credit balance

`GET /credits`

## Request

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

Epovest is prepaid: measurement debits a credit balance. Credits never expire, and reading
stays open: an account reads its whole series whenever it comes back, however long it has
been idle, and spends the balance it already has. `suggested_topups` carries three amounts
derived from the monthly pace of the account, worth one, three and six months of it: take one
of these when the person leaves the amount to you.

## Response `200`

The balance, the reservations, and the amounts derived from the pace.

- Credits
  - `currency` string, required: The wallet currency of the account.
  - `balance_minor` integer, required: The gross balance.
  - `available_minor` integer, required: What the account can spend now, net of reservations.
  - `held_minor` integer, required
  - `holds` object[], required: Credits reserved by surveys in progress. A reservation is captured when its survey completes, or released.
    - `amount_minor` integer
    - `reason` string, nullable
    - `created_at` string, date-time
  - `expires_at` unknown, required
  - `min_topup_minor` integer, required: The floor a top-up has to clear.
  - `monthly_estimate_minor` integer, required: What the account has set up to consume in a month: its trackers in draft, running or out of credit, plus the corroborations it monitors. `0` when nothing is set up yet.
  - `suggested_topups` object[], required: Three amounts derived from that pace, worth one, three and six months of it, rounded and never under the floor. Take one of these when the person leaves the amount to you.
    - `amount_minor` integer
    - `amount` string: The same amount in major units.
    - `covers_months` integer: The runway it buys.

## Other responses

- `401`: `unauthenticated`: missing, unknown or revoked key.
- `403`: `insufficient_scope`: the credential may not do this, either because the key lacks the scope, or, on a one-click connection, because the person lacks the role the action needs (manager, or owner to start, pause and top up). On that path, read it as "this person may not do this" and tell them which role the action needs.
- `429`: `rate_limited`: 120 requests per minute per credential, sliding window. Retry after `Retry-After` seconds.
- `503`: `service_unavailable`: a backend is unreachable; retry later.

---

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