Usage

Get usage

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.

get/usage

Request

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

Response

Usage for the current month

successboolean

Example response

{
  "success": true,
  "data": {
    "plan": "PRO",
    "mailboxes": 12,
    "domains": 2,
    "sends": {
      "used": 1200,
      "remaining": 8800,
      "limit": 10000
    },
    "campaignSends": {
      "used": 1200,
      "remaining": 8800,
      "limit": 10000
    },
    "batch": {
      "recipientsPerCall": 200
    },
    "freeAddress": {
      "sendsToday": {
        "used": 1200,
        "remaining": 8800,
        "limit": 10000
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.