> ## Documentation Index
> Fetch the complete documentation index at: https://www.unkey.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Unkey is two separate products. Compute builds, deploys, and runs apps behind a gateway. API Management issues API keys, enforces rate limits, manages identities and permissions, and reports usage. Say which product a page belongs to; a reader can use either without the other.
> Every Unkey API endpoint is an HTTP POST to https://api.unkey.com/v2/{service}.{procedure} with a root key in the Authorization: Bearer header. Root keys are workspace scoped.
> Error codes have the form err:{system}:{category}:{specific} and each has a page at /errors/{system}/{category}/{specific}.
> The word environment means production or preview in Compute. Rate limiting has four meanings on this site; the glossary lists them.

# unkey workspace usage

> Read billable API operations, compute usage, and active keys for a calendar month.

> [!NOTE]
>
> Create a root key with the permissions listed on this page under **Root Keys** in the dashboard sidebar. CLI commands can instead use a session from [unkey login](https://www.unkey.com/docs/platform/cli/login.md) with the required permissions. See [Permission reference](https://www.unkey.com/docs/platform/root-keys/permissions-legacy.md) for every permission.

Get the usage of your workspace for one calendar month (UTC): billable API
operations, compute usage per environment, and active keys per app.

Use this to track usage during the month or to look back at a past
month. The response has no prices. Your invoice is the source of truth.
Compute usage can be up to 15 minutes late, and it can change for up to 7
days.

Send `{}` for the current month to date, or
`{"period": {"year": 2026, "month": 9}}` for a full past month. The month
must start within the last 90 days.

Run without `--period` for the current month. Replace the year and month in the example with a month that starts within the last 90 days.

## Usage

```bash theme={"system"}
unkey workspace usage [flags]
```

## Flags

**--period** `string`

A JSON object. The calendar month (UTC) to read. Omit it for the current month to date. A past month returns the full month. It cannot be in the future, and it must start within the last 90 days, because compute usage is kept for 90 days.

**Properties**

**year** `integer` *required*

The year, for example 2026.

**month** `integer` *required*

The month, from 1 (January) to 12 (December). Range: 1 to 12.

### Shared flags

These flags control authentication, requests, and output. [CLI output and shared flags](https://www.unkey.com/docs/platform/cli/output-and-flags.md) describes them in full.

**--body** `string`

A JSON document sent as the request body instead of building it from the flags above. It is mutually exclusive with the request-building flags, and unknown fields are rejected locally. See [Send a raw body](https://www.unkey.com/docs/platform/cli/output-and-flags.md#send-a-raw-body).

**--root-key** `string`

Root key used for the request. Falls back to `UNKEY_ROOT_KEY`, then stored credentials, including a CLI session. See [CLI authentication](https://www.unkey.com/docs/platform/cli/authentication.md) for the full precedence order.

**--api-url** `string` (default: [https://api.unkey.com](https://api.unkey.com))

Base URL of the API. Falls back to `UNKEY_API_BASE_URL`. You don't normally need to set it.

**--config** `string` (default: \~/.unkey/config.toml)

Path of the TOML config file. Falls back to `UNKEY_CONFIG`. An explicit `--config` takes precedence over a stored CLI session. Browser login stores a session, not a root key in this file. See [CLI authentication](https://www.unkey.com/docs/platform/cli/authentication.md).

**--output** `enum` (default: human)

Use `human` (default) for name-first summary tables and labeled details, or `json` for the unchanged full response envelope, including all fields and pagination. Terminal tables use relative timestamps and may shorten display names and descriptions, but never identifiers, slugs, or credentials. Redirected human output keeps complete values and uses RFC3339 UTC timestamps. Falls back to `UNKEY_OUTPUT`; other values are rejected. `--json` also selects JSON output. Add `--debug` to print the request ID to stderr. See [Output formats](https://www.unkey.com/docs/platform/cli/output-and-flags.md#output-formats).

**--debug** `boolean`

Print the successful response's request ID to stderr, separate from stdout.

**--json** `boolean`

Print the full response as JSON. Takes precedence over a valid `--output` or `UNKEY_OUTPUT` value.

## Required permissions

Your root key must have this permission:

* `unkey:v1:<workspace_id>:usage#read`

See [Root key permissions](https://www.unkey.com/docs/platform/root-keys/permissions.md).

## Examples

```bash theme={"system"}
unkey workspace usage --period='{"year":2026,"month":9}'
```

Send the request body as JSON:

```bash theme={"system"}
unkey workspace usage --body='{}'
```

## API endpoint

The command calls `POST /v2/workspace.getUsage` and prints its response. See the [endpoint definition](https://github.com/unkeyed/unkey/blob/main/svc/api/openapi/spec/paths/v2/workspace/getUsage/index.yaml) for the HTTP contract. Request fields use camelCase in `--body`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.