---
title: "Get usage and balance"
method: GET
path: "/v1/usage"
tags: ["Usage"]
---

# Get usage and balance

`GET /v1/usage`

## Request

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

Shows whether tracking is stopped or the balance is low. Also returns the prepaid balance (ledger total, pending mention charges, and the effective balance that decides pausing), daily spend and days left, running and paused keywords, and matches today and over 30 days. Pricing is $0.008 per matched mention, relevant or not, and $5 a month per active keyword, charged daily.

## Response `200`

A summary of usage

- UsageSummary
  - `balance` object, required: The prepaid balance.
    - `cents` 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.
    - `effectiveCents` integer, required: cents minus pendingCents. Pausing at zero and the check before adding keywords both use this number.
    - `currency` 'USD', required
  - `burn` object, required: How quickly the balance is being spent.
    - `perDayCents` integer, required: Mean daily debit across the past 7 days, or the workspace's lifetime if shorter.
    - `daysLeft` integer, nullable, required: effectiveCents over perDayCents, rounded down. Null when perDayCents is 0.
  - `keywords` object, required: Keyword counts compared with the balance.
    - `active` integer, required: Keywords that are not muted. These are charged each day.
    - `paused` integer, required: Keywords paused because the balance ran out. A top-up resumes them.
    - `capped` integer, required: Keywords that are not muted but reached their monthly mention cap. They are still charged each day and are not matched until the next month or until the cap is raised.
    - `limit` integer, required: Keywords the workspace may run now. 0 if the balance can't cover one more keyword-day, otherwise the self-serve maximum.
    - `dayCents` integer, required: Daily cost of the active keywords.
  - `mentions` object, required: Matched mentions, which are billed along with keyword-days.
    - `today` integer, required: Count of matches since midnight UTC, relevant or not.
    - `last30d` integer, required: Match count for the past 30 days.
  - `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 20 percent or less of the last credit remains (effective balance) and tracking is on.
  - `lastTopUpAt` string, nullable, required: Latest paid top-up time, or null if there is none.

## Other responses

- `401`: The API key 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)