API Reference

Account

The account endpoint returns your current plan, usage statistics, and limits. Useful for bots that need to check what they can do before taking action.

Get account info

GET /api/v1/account

Response

Response 200

{
  "plan": "standard",
  "display_name": "Standard",
  "price_cents": 500,
  "limits": {
    "max_email_addresses": 50,
    "max_storage_bytes": 10737418240,
    "max_emails_per_address_per_day": 50,
    "max_folders": 20
  },
  "usage": {
    "email_addresses": 8,
    "folders": 3,
    "storage_bytes": 1288490188
  },
  "renews_at": "2026-05-01T00:00:00Z",
  "cancel_at_period_end": false
}

Why this matters for bots

Before creating resources, a well-behaved bot should check the account endpoint to:

  • Verify the API key is valid
  • Check remaining email address slots before creating new ones
  • Monitor storage usage and warn the user if they're approaching the cap
  • Suggest an upgrade when limits are close
Previous
← API Keys