Account and keys
Get the account
Plan, billing status, inbox limits, and whether sending is turned on.
Billing ids and other internal fields are never returned.
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Authorization |
string | Required | Bearer followed by your API key. |
Response
200 OK.
| Name | Type | Description |
|---|---|---|
plan |
string | trial or pro. |
status |
string | Billing status, such as trialing, active, past_due, or canceled. |
trialEndsAt |
string | null | When the trial ends. null on Pro. |
pastDueGraceEndsAt |
string | null | When a failed payment stops access. Only set while status is past_due. |
inboxLimit |
number | Most inboxes the plan allows. |
slots |
object | null | paid, inUse, paused, and free inbox slots. null when billing is briefly unreachable. |
sendEnabled |
boolean | Whether approve-in-chat sending is on. Defaults to false. |
createdAt |
string | null | ISO time the account was created. |
Errors
Any route can also return 401 for a bad key, 402 when the trial ended or payment failed, and 429 when you send too many requests. See Errors.