---
title: "Get quota and limits for the current billing period"
method: GET
path: "/api/v1/usage"
tags: ["Account"]
---

# Get quota and limits for the current billing period

`GET /api/v1/usage`

## Request

- Base URL: `https://curlshot.com`
- URL: `https://curlshot.com/api/v1/usage`
- Auth: one of:
  - API key in query parameter `access_key`
  - API key in header `X-Access-Key`
  - HTTP bearer

Free to call; it does not use a screenshot.

## Response `200`

Current usage.

- Usage
  - `plan` object
    - `slug` string
    - `name` string
  - `period` object
    - `start` string, date-time
    - `end` string, date-time
  - `quota` integer, required: Screenshots included in this period.
  - `used` integer, required
  - `remaining` integer, required
  - `bonus_remaining` integer: Bonus screenshots left (referrals, promotions).
  - `overage_used` integer: Opt-in overage screenshots taken this period (0 when overage is off).
  - `overage_remaining` integer: Opt-in overage screenshots still allowed this period: the monthly cap the account owner set, limited by the prepaid balance (0 when off).
  - `rate_limit_per_minute` integer
  - `concurrency` integer: Renders that may run at the same time.
  - `full_page_max_height` integer: Tallest full-page capture on this plan, in page pixels.
  - `full_page_max_scale` number: Largest device_scale_factor of a full-page capture on this plan.
  - `video_max_seconds` number: Longest video (format mp4, webm, gif) on this plan, in seconds; 0 when the plan has no video capture.

## Other responses

- `401`: `access_key_required`: An access key is required. Pass `access_key` or the `X-Access-Key` header. `access_key_invalid`: The access key is not valid or has been revoked.
- `403`: `signature_required`: This access key only accepts signed requests. Add a `signature` parameter. `signature_invalid`: The request signature does not match. `request_expired`: This request has expired: its `expires` time is in the past. Create a new link with a later `expires`.
- `429`: `rate_limited`: Too many requests. Slow down and retry after the indicated delay.
- `503`: `service_unavailable`: The service is temporarily unavailable. Retry in a moment.

---

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