---
title: "Retrieve account usage"
method: GET
path: "/usage"
tags: ["Usage"]
---

# Retrieve account usage

`GET /usage`

## Request

- Base URL: `https://api.cavuno.com/v1`
- URL: `https://api.cavuno.com/v1/usage`
- Auth: HTTP bearer

Retrieves actionable product capacity and Builder credit usage for your Board. Unlimited capacities use null limit and remaining. Plan details live on GET /billing/subscription.

## Response `200`

Successful response.

- Usage
  - `object` 'usage', required: String representing the object's type. Objects of the same type share the same value.
  - `capacities` UsageCapacity[], required: Typed product capacities for active jobs, confirmed subscribers, and team seats.
    - `key` 'active_jobs' | 'confirmed_subscribers' | 'team_seats', required: Stable capacity key matching the dashboard: active_jobs, confirmed_subscribers, or team_seats.
    - `used` integer, required: Current usage for this capacity. Never negative.
    - `limit` integer, nullable, required: Effective plan or override cap. Null when the capacity is unlimited.
    - `remaining` integer, nullable, required: Slots remaining before the limit. Null when unlimited; never negative when finite.
  - `builderCredits` BuilderCreditUsage, required: Builder credit usage in tenths of a credit for the current day and billing period, plus spendable granted credits.
    - `daily` object, required
      - `periodKey` string, required
      - `usedTenths` integer, required
      - `limitTenths` integer, nullable, required
      - `remainingTenths` integer, nullable, required
    - `monthly` object, required
      - `periodKey` string, required
      - `usedTenths` integer, required
      - `limitTenths` integer, nullable, required
      - `remainingTenths` integer, nullable, required
      - `resetsAtMs` integer, required
    - `grantedTenths` integer, required

## Other responses

- `default`: An error. Every non-2xx response uses the same envelope; see the Errors section of the introduction.

## Changes

- **2026-10-19** `c34152c38176`: 1 info
  - added the optional property `error/upgrade` to the response with the `default` status

[Operation history](https://skmtc.dev/cavuno/apis/cavuno-v1-rest-api/changes/usage/get.md)

---

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