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

# Get account usage

`GET /usage`

## Request

- Base URL: `https://api.crevio.co/v1`
- URL: `https://api.crevio.co/v1/usage`
- Auth: API key in header `Authorization`

Returns the authenticated account's credit balance (and how much of it comes from the plan, top-ups and bonuses), plan status and price, a forecast of whether the balance lasts until the billing cycle ends at the current spend rate, and credit spend for a window (the current billing cycle unless `start_time`/`end_time` say otherwise) broken down by operation, by day, and by the chats and scheduled tasks that spent the most.

## Query parameters

- `start_time` string, date-time
- `end_time` string, date-time

## Response `200`

Account usage

- Usage
  - `object` string, required
  - `plan` union, required: ID by default, full object when expanded
    - string
    - UsagePlan
      - `name` string, nullable, required
      - `status` string, required
      - `is_paid` boolean, required
      - `on_trial` boolean, required
      - `trial_ends_at` string, nullable, required
      - `renews_at` string, nullable, required
      - `price` number, nullable, required
      - `currency` string, nullable, required
      - `interval` string, nullable, required
      - `has_payment_method` boolean, required
  - `credits` union, required: ID by default, full object when expanded
    - string
    - UsageCreditBalance
      - `balance` number, required
      - `plan_credits` number, required
      - `top_up_credits` number, required
      - `bonus_credits` number, required
      - `monthly_allowance` number, nullable, required
      - `limit_reached` boolean, required
      - `auto_top_up` boolean, required
  - `spend` union, required: ID by default, full object when expanded
    - string
    - UsageSpend
      - `period_start` string, required
      - `period_end` string, required
      - `time_zone` string, required
      - `total_credits` number, required
      - `today_credits` number, required
      - `by_operation` UsageOperationSpend[], required
        - `operation` string, required
        - `description` string, nullable, required
        - `credits` number, required
      - `by_day` UsageDaySpend[], required
        - `date` string, required
        - `credits` number, required
      - `by_chat` UsageChatSpend[], required
        - `type` string, required
        - `id` string, required
        - `title` string, nullable, required
        - `credits` number, required
        - `runs` number, nullable, required
        - `last_charged_at` string, required
  - `forecast` union, required: ID by default, full object when expanded
    - string
    - UsageForecast
      - `burn_rate_per_day` number, required
      - `runs_out_at` string, nullable, required
      - `projected_balance_at_period_end` number, required
      - `will_run_out` boolean, required

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Forbidden
- `429`: Rate limit exceeded — 600 requests per minute per credential. Retry after the number of seconds in `Retry-After`.
- `500`: Internal server error

---

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