---
title: "View the current plan, usage this period, and shared balance"
method: GET
path: "/billing/entitlements"
tags: ["billing"]
---

# View the current plan, usage this period, and shared balance

`GET /billing/entitlements`

## Request

- Base URL: `https://api.mailly.site` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mailly.site/billing/entitlements`
- Auth: HTTP bearer

## Response `200`

Plan and usage

- object
  - `success` boolean, required
  - `entitlements` object, required
    - `plan` object, nullable, required
      - `id` string, required
      - `name` string, required
      - `source` 'subscription' | 'free' | 'grant' | 'enterprise', required
      - `price_usd` number, required
      - `billing_interval` 'month' | 'year', required
      - `status` string, required
      - `period_start` integer, required
      - `period_end` integer, required
      - `subscription_period_end` integer, required
      - `cancel_at_period_end` boolean, required
    - `emails` object, nullable, required
      - `used` integer, required
      - `quota` integer, required
    - `mailboxes` object, required
      - `used` integer, required
      - `limit` integer, required
    - `custom_domains` object, required
      - `used` integer, required
      - `limit` integer, required
    - `usage` object, required
      - `currency` 'USD', required
      - `prepaid_nano` integer, required
      - `email_price_nano` integer, required
      - `email_overage_nano` integer, required
      - `allowance` object, nullable, required
        - `quota_nano` integer, required
        - `remaining_nano` integer, required
        - `period_end` integer, required
    - `model` object, required
      - `billing_enforced` boolean, required
      - `period_start` integer, required
      - `period_cost_nano` integer, required
      - `period_charged_nano` integer, required
      - `executions` object, required
        - `used` integer, required
  - `plans` object[], required
    - `id` string, required
    - `name` string, required
    - `mailboxes` integer, required
    - `custom_domains` integer, required
    - `monthly_emails` integer, required
    - `daily_recipients` integer, nullable, required
    - `price_usd` number, required
    - `billing_interval` 'month' | 'year', required
    - `usage_allowance_nano` integer, required
    - `available` boolean, required
  - `sending` object
    - `status` 'active' | 'paused', required: When paused, all customer sends are rejected with workspace_sending_paused
    - `reason` 'auto_bounce' | 'auto_complaint' | 'manual' | 'null', nullable, required
    - `paused_at` string, nullable, required
    - `daily_limit` object, nullable, required: Rolling 24h recipient limit; sends over it are rejected with workspace_daily_limit_exceeded and not charged
      - `limit` integer, required
      - `used` integer, required
      - `remaining` integer, required
      - `window_hours` 24, required
      - `source` 'new_workspace' | 'override' | 'free_plan', required
      - `applies_until` string, nullable, required

---

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