Get Account
Retrieve a consolidated overview of the authenticated account, including plan, usage, subscription, and billing details.
Retrieve a consolidated overview of the account that owns the API key making the request. The response includes identity information, the current plan, usage against limits, subscription state, and billing details.
Scope: account.read
Response
user_idintegeroptionalUnique identifier of the account.
namestringoptionalAccount display name.
emailstringoptionalAccount email address.
current_planobjectoptionalDetails of the plan the account is subscribed to (id, name, quantity).
usagearrayoptionalExactly three usage entries (see below). Each has name, quantity, used, and available. A quantity of -1 indicates unlimited (in which case available is also -1).
subscriptionobjectoptionalSubscription summary including status, billing period, and next invoice total.
billing_informationobjectoptionalBilling details on file for the account.
Usage entries
The usage array always contains exactly three entries, in this order:
name | Description |
|---|---|
Hourly Outbound Usage | Outbound emails sent in the current hour vs. the hourly limit. |
Monthly Outbound Usage | Outbound emails sent this month vs. the monthly limit. |
Monthly Inbound Usage | Inbound emails received this month vs. the monthly receiving limit. |
Each entry is { name, quantity, used, available }. A quantity of -1 indicates unlimited (in which case available is also -1).
Sample Response
{
"data": {
"user_id": 12345,
"name": "Jane Doe",
"email": "[email protected]",
"current_plan": {
"id": 3,
"name": "Pro",
"quantity": 100000
},
"usage": [
{
"name": "Hourly Outbound Usage",
"quantity": 1000,
"used": 42,
"available": 958
},
{
"name": "Monthly Outbound Usage",
"quantity": 100000,
"used": 5000,
"available": 95000
},
{
"name": "Monthly Inbound Usage",
"quantity": 50000,
"used": 1200,
"available": 48800
}
],
"subscription": {
"status": "active",
"current_period_start": "2026-06-01T00:00:00Z",
"current_period_end": "2026-07-01T00:00:00Z",
"cancel_at_period_end": false,
"next_invoice_total": 25.0
},
"billing_information": {
"name": "Jane Doe",
"company_name": "Example Inc",
"billing_email": "[email protected]",
"country_code": "US"
}
}
}