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

# Get usage and balance

`GET /v1/usage`

## Request

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

The prepaid balance (ledger, pending mention charges, and the effective balance the stop rule reads), the daily burn and the days it buys, the keywords the wallet runs and pauses, the matches recorded today and over 30 days, and whether tracking is stopped or the balance is low. Every matched mention bills ($0.008), relevant or not; every active keyword bills $5 a month, charged daily.

## Response `200`

The usage summary

- UsageSummary
  - `balance` object, required: The prepaid wallet.
    - `cents` integer, required: Ledger balance: every credit minus every settled debit.
    - `pendingCents` integer, required: Mentions and comments billed since the last daily settlement, priced but not yet debited.
    - `effectiveCents` integer, required: cents minus pendingCents: what the stop rule and the keyword gate look at.
    - `currency` 'USD', required
  - `burn` object, required: How fast the balance goes.
    - `perDayCents` integer, required: Average daily debit over the last 7 days (or since the workspace was created).
    - `daysLeft` integer, nullable, required: effectiveCents divided by perDayCents; null when nothing is burning.
  - `keywords` object, required: Keywords against the wallet.
    - `active` integer, required: Unmuted keywords, the ones charged daily.
    - `paused` integer, required: Keywords the wallet paused for lack of balance; a top-up resumes them.
    - `capped` integer, required: Unmuted keywords at their monthly mention cap: still charged daily, not matched until the month turns or the cap is raised.
    - `limit` integer, required: How many keywords the workspace may run right now: the self-serve ceiling when the balance covers one more keyword-day, else 0.
    - `dayCents` integer, required: What one more day of the active keywords costs.
  - `mentions` object, required: Matched mentions, the other thing that bills.
    - `today` integer, required: Matches recorded today (UTC), relevant or not: every one bills.
    - `last30d` integer, required: Matches recorded in the last 30 days.
  - `stopped` boolean, required: The wallet paused tracking; a top-up that covers a day of every keyword resumes it.
  - `lowBalance` boolean, required: Running, and the effective balance is at or under 20 percent of the last credit.
  - `lastTopUpAt` string, nullable, required: Newest paid top-up; null before the first.

## Other responses

- `401`: Missing or invalid API key

---

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