---
title: "What this account has used this period"
method: GET
path: "/v1/me/usage"
tags: ["Account"]
---

# What this account has used this period

`GET /v1/me/usage`

## Request

- Base URL: `https://api.locio.com.au`
- URL: `https://api.locio.com.au/v1/me/usage`
- Auth: API key in cookie `locio_session`

Nobody should learn their usage from an invoice, so the reset date is part of the answer.

## Response `200`

Usage against the plan.

- object
  - `data` Usage
    - `plan` string
    - `limit` integer
    - `used` integer
    - `remaining` integer
    - `since` string, date-time
    - `resets` string, date-time
    - `burst` integer: Requests a second.
    - `keys` object[]
      - `id` integer
      - `name` string
      - `hint` string
      - `units` integer

## Other responses

- `401`: No key, or not a valid one. Revoked and unknown keys answer the same way.
- `402`: The quota for this billing period is spent. `X-Quota-Reset` says when it returns; the billing portal is how to raise it sooner.
- `429`: Too many requests a second for this plan. `RateLimit-Limit` says the rate and `Retry-After` says how long to wait; this is a rate, not a quota, so it clears in a second.

---

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