---
title: "Plan, storage and send allowance"
method: GET
path: "/v1/account/usage"
tags: ["account", "billing"]
---

# Plan, storage and send allowance

`GET /v1/account/usage`

## Request

- Base URL: `https://botmail.pro`
- URL: `https://botmail.pro/v1/account/usage`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bm_session`

Scope: any. Pending claim keys allowed.

## Response `200`

Usage and limits.

- Usage
  - `plan` 'free' | 'pro' | 'team' | 'scale', required
  - `kind` 'human' | 'pending', required
  - `status` 'active' | 'receive_only' | 'suspended' | 'deleting', required
  - `limits` Limits, required
    - `plan` 'free' | 'pro' | 'team' | 'scale', required
    - `price_usd` integer, required: Per month.
    - `mailboxes` integer, required
    - `storage_bytes` integer, required
    - `all_domains` boolean, required: Same name on every Botmail domain.
    - `short_names` boolean, required: Names of 4 characters or fewer.
    - `start_new_recipients` integer, required: New recipients per day at the starting trust level.
    - `max_new_recipients` integer, required: Plan ceiling for new recipients per day.
    - `max_total_per_day` integer, required
    - `custom_domains` integer, required
    - `storage_addon_allowed` boolean, required
  - `used_bytes` integer, required
  - `quota_bytes` integer, required
  - `extra_storage_bytes` integer, required
  - `over_quota` boolean, required: New mail is held while true.
  - `mailboxes` object, required
    - `used` integer, required
    - `limit` integer, required
  - `sends_today` Allowance
    - `level` integer, required: Trust level 0-3.
    - `new_recipients_per_day` integer, required
    - `total_per_day` integer, required
    - `new_recipients_used` integer, required
    - `total_used` integer, required

## Other responses

- `401`: Missing or invalid credentials (`unauthorized`, `invalid_token`).

---

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