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

# Get usage

`GET /usage`

## Request

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

The plan, how many mailboxes and domains this key can reach, and this month's send quotas. Check it before a large batch. Requires scope `mailboxes:read`, except for a key bound to one mailbox. On a free address, `sends` is the daily allowance and `freeAddress.sendsToday` repeats it.

## Response `200`

Usage for the current month

- object
  - `success` boolean
  - `data` Usage
    - `plan` string
    - `mailboxes` integer: Mailboxes this key can operate
    - `domains` integer
    - `sends` object: The API send quota: what sending from a mailbox and `/emails` draw from
      - `used` integer
      - `remaining` integer
      - `limit` integer
      - `period` 'month' | 'day': `day` when the key can only send from a free address: the quota is then that address's daily allowance
      - `resetsAt` string, date-time: When a daily quota resets (midnight UTC)
    - `campaignSends` object: Campaign sends, metered separately
      - `used` integer
      - `remaining` integer
      - `limit` integer
    - `batch` object: Bulk send (`POST /mailboxes/{address}/send-batch`)
      - `recipientsPerCall` integer: Most recipients one call may carry on this plan
    - `periodStart` string, date-time: Quotas count from here (first of the month, UTC)
    - `resetsAt` string, date-time
    - `freeAddress` object: Present when the key reaches a free shared address
      - `sendsToday` object: The daily allowance (smaller while an agent signup is unclaimed)
        - `used` integer
        - `remaining` integer
        - `limit` integer
        - `resetsAt` string, date-time: Midnight UTC

## Other responses

- `401`: Missing or invalid API key
- `402`: The account's plan does not include the API (`plan_required`)
- `403`: The key lacks the required scope
- `429`: Rate limit exceeded

---

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