---
title: "Get the balance"
method: GET
path: "/v1/billing/wallet"
tags: ["Billing"]
---

# Get the balance

`GET /v1/billing/wallet`

## Request

- Base URL: `https://api.rumoro.dev`
- URL: `https://api.rumoro.dev/v1/billing/wallet`
- Auth: HTTP bearer

Returns every detail of the prepaid balance. That covers the ledger total, pending mention charges, the effective balance used for pausing, the daily spend and days left, running and paused keywords, the cost of a day and of resuming, the welcome credit, the latest top-up, the top-up limits and the auto-recharge settings. `GET /v1/usage` gives a shorter version.

## Response `200`

Wallet balance, daily spend and pause state

- Wallet
  - `balanceCents` integer, required: The ledger balance, all credits minus all settled debits.
  - `pendingCents` integer, required: Cost of mentions matched after the last daily settlement. Not debited yet.
  - `effectiveBalanceCents` integer, required: balanceCents minus pendingCents. Pausing at zero and the check before adding keywords both use this number.
  - `burnPerDayCents` integer, required: Mean daily debit across the past 7 days, or the workspace's lifetime if shorter.
  - `daysLeft` integer, nullable, required: effectiveBalanceCents over burnPerDayCents, rounded down. Null when burnPerDayCents is 0.
  - `stopped` boolean, required: True when tracking is paused because the balance ran out. It resumes after a top-up that covers one day of every keyword.
  - `lowBalance` boolean, required: True when tracking is running and the effective balance is 20 percent of the last credit or less. The low-balance email uses the same rule.
  - `activeKeywords` integer, required: Keywords that are not muted.
  - `autoMutedKeywords` integer, required: Keywords muted for low balance. A top-up restarts them.
  - `nextDayCents` integer, required: Next day's cost for the running keywords. Tracking stops if the effective balance drops below it.
  - `resumeCostCents` integer, required: Daily cost of every keyword, running or paused. Tracking restarts once the effective balance reaches this amount.
  - `signupCredit` object, nullable, required: Welcome credit given to this workspace. Null when the user already got it in another workspace.
    - `amountCents` integer, required: Whole US cents.
    - `grantedAt` string, required: UTC time in ISO 8601.
  - `lastTopUpAt` string, nullable, required: Latest paid top-up time, or null if there is none.
  - `billingConfigured` boolean, required: Whether top-ups work here. false when Polar isn't configured, which hides the top-up button.
  - `minTopUpCents` integer, required: The minimum top-up at checkout.
  - `maxTopUpCents` integer, required: The maximum for one top-up.
  - `defaultTopUpCents` integer, required: The amount the checkout starts with.
  - `currency` 'USD', required: All amounts here are in US cents.
  - `autoRecharge` object, required
    - `available` boolean, required: Whether saved-card charging works on this deployment. The setting is hidden when false.
    - `enabled` boolean, required: When true, the saved card is charged automatically if the balance gets low.
    - `thresholdCents` integer, required: The card is charged when the effective balance falls below this.
    - `amountCents` integer, required: The amount each automatic charge adds, within the same limits as a manual top-up.
    - `lastRunAt` string, nullable, required: Time of the latest successful automatic charge.
    - `lastError` string, nullable, required: Error of the last failed automatic charge, cleared by a successful one.

## Other responses

- `401`: The credential is missing or not valid

---

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