---
title: "Get usage"
method: GET
path: "/v1/usage"
tags: ["Accounts"]
---

# Get usage

`GET /v1/usage`

Returns account profile, usage totals, current scraper pricing, and current-month cost estimates.

## Response `200`

Account usage loaded.

- AccountUsageResponse — Account usage response optimized for agents and billing views.
  - `profile` AccountProfileResponse, required — Authenticated account profile.
    - `accountId` string, required
    - `email` string, email, required
    - `provider` 'github' | 'google' | 'email', required
    - `plan` 'unpaid' | 'plus' | 'pro' | 'max', required
    - `displayName` string, nullable, required
  - `usage` AccountOverviewUsage, required — Current account usage totals.
    - `meters` AccountUsageMeters, required — Rolling account usage-meter windows keyed by stable meter name.
      - `hour` object, required — Rolling one-hour account usage meters.
      - `day` object, required — Rolling 24-hour account usage meters.
      - `week` object, required — Rolling seven-day account usage meters.
      - `twoWeeks` object, required — Rolling 14-day account usage meters.
      - `month` object, required — Rolling 30-day account usage meters.
      - `quarter` object, required — Rolling 90-day account usage meters.
  - `pricing` PlanPricing, required — Customer-visible scraper subscription pricing and monthly balance.
    - `subscriptionUsdCentsPerMonth` integer, required — Monthly subscription price in USD cents.
    - `planBalanceUsdCentsPerMonth` integer, required — Paid account balance granted by the monthly subscription, in USD cents.
    - `bonusBalanceUsdCentsPerMonth` integer, required — Bonus account balance granted above the paid plan balance, in USD cents.
    - `includedBalanceUsdCentsPerMonth` integer, required — Total monthly account balance granted by the plan, in USD cents.
    - `paidOveragesEnabled` boolean, required — Whether paid usage above available balance is enabled.
  - `billingEstimate` UsageCostEstimate, required — Conservative current-month scraper cost estimate for agent planning.
    - `currency` string, required
    - `plan` 'unpaid' | 'plus' | 'pro' | 'max', required
    - `paidOveragesEnabled` boolean, required
    - `subscriptionUsdMicrosPerMonth` integer, required
    - `planBalanceUsdCentsPerMonth` integer, required
    - `bonusBalanceUsdCentsPerMonth` integer, required
    - `includedBalanceUsdCentsPerMonth` integer, required
    - `topUpBalanceUsdMicros` integer, required
    - `topUpMinimumUsdCents` integer, required
    - `topUpMaximumUsdCents` integer, required
    - `topUpExpiresAfterInactiveDays` integer, required
    - `autoTopUpEnabled` boolean, required
    - `autoTopUpThresholdUsdCents` integer, required
    - `autoTopUpAmountUsdCents` integer, required
    - `autoTopUpMonthlyLimitUsdCents` integer, required
    - `currentMonthBonusBalanceUsedUsdMicros` integer, required
    - `currentMonthPlanBalanceUsedUsdMicros` integer, required
    - `currentMonthTopUpBalanceUsedUsdMicros` integer, required
    - `currentMonthOverageUsdMicros` integer, required
    - `estimatedMonthlyTotalUsdMicros` integer, required
    - `lineItems` UsageCostLineItem[], required
      - `product` string, required
      - `meter` string, required
      - `currentMonthUsed` integer, required
      - `includedPerMonth` integer, nullable, required
      - `billableAmount` integer, required
      - `usageUnit` string, required
      - `billingUnit` string, required
      - `billingUnitSize` integer, required
      - `priceUsdMicrosPerBillingUnit` integer, nullable, required
      - `estimatedUsdMicros` integer, required
      - `estimateBasis` string, required
      - `rounding` string, required
    - `nextActions` string[], required

## Other responses

- `400` — Bad request.
- `401` — Unauthorized.
- `429` — Too many requests.
- `500` — Internal server error.

## Changes

- **2026-07-02** `c7b37eaf7c38` — 5 breaking, 33 info
  - removed the required property `balanceUsdMicros` from the response with the `200` status
  - removed the required property `billingEstimate/lineItems/items/label` from the response with the `200` status
  - removed the required property `billingEstimate/lineItems/items/quantity` from the response with the `200` status
  - removed the required property `billingEstimate/lineItems/items/unitUsdMicros` from the response with the `200` status
  - …34 more
- **2026-06-05** `3985c6090c91` — 37 breaking, 4 warning, 80 info
  - the response property `checkout_url` became nullable for the status `400`
  - the response property `checkout_url` became nullable for the status `401`
  - the response property `checkout_url` became nullable for the status `429`
  - the response property `checkout_url` became nullable for the status `500`
  - …117 more
- **2026-06-01** `80ee119de8db` — 5 info
  - added the optional property `usage/meters/day/object_storage_egress_bytes` to the response with the `200` status
  - added the optional property `usage/meters/month/object_storage_egress_bytes` to the response with the `200` status
  - added the required property `limits/objectStorageEgressBytesPerMonth` to the response with the `200` status
  - added the required property `pricing/objectStorage/egressOverageUsdMicrosPerTb` to the response with the `200` status
  - …1 more
- …earlier changes not shown

[Full history](https://skmtc.dev/tovuk/apis/tovuk-api/changes/v1/usage/get.md)

---

[API](https://skmtc.dev/tovuk/apis/tovuk-api.md) · [All operations](https://skmtc.dev/tovuk/apis/tovuk-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tovuk/tovuk-api/revisions/ef06c3a9c42b/schema)
