---
title: "The account's BalanceView: plan, exact balance and the agent spend policy (no key limits)"
method: GET
path: "/v1/account/billing/balance"
---

# The account's BalanceView: plan, exact balance and the agent spend policy (no key limits)

`GET /v1/account/billing/balance`

## Request

- Base URL: `https://api.roveapi.com`
- URL: `https://api.roveapi.com/v1/account/billing/balance`
- Auth: API key in cookie `rove_session`

## Response `200`

Successful response (Cache-Control: no-store)

- object
  - `credits_remaining` integer, required: floor(credits_remaining_millicredits / 1000).
  - `credits_remaining_millicredits` integer, required
  - `plan` string, required
  - `livemode` boolean, required: false for a test key: its purchases are simulated and count only against test-mode spend.
  - `credit_unit` object, required
    - `credits_per_usd` integer, required
    - `millicredits_per_credit` integer, required
  - `supervised_millicredits_per_minute` integer, required: What a supervised session started now would snapshot.
  - `purchasing` object, required
    - `allowed` boolean, required
    - `reason` 'agent_purchasing_off' | 'key_not_granted', nullable, required
    - `owner_action_url` string, nullable, required: Where the account owner can allow this, when not allowed.
    - `payment_modes` string[], required
    - `packs_within_limits` string[], required: Catalogue pack ids that fit every limit right now.
    - `limits` object, nullable, required
      - `per_purchase_max_cents` integer, required
      - `period` 'day' | 'week' | 'month', required
      - `period_max_cents` integer, required
      - `period_committed_cents` integer, required: Agent and auto top-up purchases this period that reserve or spent their amount (same livemode).
      - `key_period_max_cents` integer, nullable, required: null on the owner route (no key).
      - `key_period_committed_cents` integer, required
      - `period_resets_at` string, date-time, required
  - `auto_topup` object, nullable, required: The account's auto top-up; null until the owner first configures it.
    - `state` 'off' | 'armed' | 'in_flight' | 'paused', required
    - `threshold_credits` integer, required
    - `blocked_until` string, date-time, nullable, required
    - `pause_reason` string, nullable, required

## Other responses

- `401`: RFC 7807 owner-session-required: sign in at owner_action_url
- `403`: RFC 7807 owner-origin-refused (mutations only)
- `429`: RFC 7807 purchase-rate-limited: 120 billing reads per minute per account; Retry-After
- `503`: RFC 7807 billing-unavailable; Retry-After: 30, retry same_key

---

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