---
title: "Top-up allowance (balance cap and rolling 30-day cap)"
method: GET
path: "/v1/accounts/{id}/topup-allowance"
tags: ["Accounts"]
---

# Top-up allowance (balance cap and rolling 30-day cap)

`GET /v1/accounts/{id}/topup-allowance`

## Request

- Base URL: `https://api.honkio.ca`
- URL: `https://api.honkio.ca/v1/accounts/{id}/topup-allowance`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Requires `account:r`.

## Path parameters

- `id` string, required

## Response `200`

How much may be added now. Amounts are CAD cents.

- object: How much may be added now. Amounts are CAD cents.
  - `max_topup_now_cents` integer, required: The largest top-up accepted right now: the smaller of the two headrooms.
  - `headroom_balance_cents` integer, required: Room left under the balance cap.
  - `headroom_30d_cents` integer, required: Room left under the rolling 30-day cap.
  - `max_balance_cents` integer, required
  - `max_30d_cents` integer, required
  - `balance_cents` integer, required
  - `topped_up_30d_cents` integer, required

## Other responses

- `401`: Missing, invalid, revoked or expired API key.
- `402`: The account has no balance, or a LIVE key was used before the first top-up.
- `403`: FORBIDDEN: the id is not the calling key's account, or the key lacks the permission this operation requires.
- `404`: NOT_FOUND: no such resource on this account.
- `429`: Rate limit reached: 100 requests per second per account, or a route-specific limit (Retry-After set where one applies).
- `500`: Unexpected server error.

---

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