AccountLimits
The AccountLimits type of the TypeScript SDK, which accounts.getLimits take or answer.
type AccountLimits = {
accountId: string
billingTier: ('free' | 'pro')
limits: AccountLimitsLimits
plan: string | null
}Fields
| Field | Type | Description |
|---|---|---|
accountId | string | Account ULID |
billingTier | ('free' | 'pro') | What the billing tool sold this account. Not a limit: Pro's numbers are stamped only once the account is also vetted (plan = trusted) |
limits | AccountLimitsLimits | Every plan limit, keyed by its field name on GET and PATCH /accounts/:accountId, which describe what each bounds. Each NULL value follows its platform default: send* the ACCOUNT_SEND_* vars; mailboxSend* (the default for a mailbox with no override of its own, which comes first) the per-mailbox SEND_* vars; recvMsgsPerDay/recvBytesPerDay ACCOUNT_RECV_*; storageLimitBytes ACCOUNT_STORAGE_LIMIT_BYTES; maxMailboxes MAX_MAILBOXES_DEFAULT (no API stores 0 for it: positive or null; a row holding 0 anyway is a ceiling of zero, reported as limit 0, enforced, not as unlimited); mailboxCreatesPerDay, addressCreatesPerDay, domainCreatesPerDay MAX_{MAILBOX,ADDRESS,DOMAIN}_CREATES_PER_DAY and forwardMsgsPerDay FORWARD_MSGS_PER_DAY, each of which is also the limit's on switch; maxMailTemplates MAX_MAIL_TEMPLATES_DEFAULT, where a blank default is the built-in 50, so its limit is null only when unlimited. forwardMsgsPerDay is counted per domain: N domains get N x this |
plan | string | null | The account's vetting label (untrusted, trusted, or a tooling tier's name; null = no plan recorded). Display only: the limits below describe the resolved thresholds and their enforcement state |
Used by
| Method | What it does |
|---|---|
accounts.getLimits | Get an account's limits and enforcement state |