Skip to Content

The Account type of the TypeScript SDK, which accounts.get and accounts.restore take or answer.

type Account = {
  activityDay: string | null
  addressCreatesPerDay: number | null
  billingTier: ('free' | 'pro')
  createdAt: number
  deletedAt: number | null
  domainCreatesPerDay: number | null
  forwardMsgsPerDay: number | null
  id: string
  mailboxCreatesPerDay: number | null
  mailboxSendMsgsPerDay: number | null
  mailboxSendMsgsPerHour: number | null
  mailboxSendRcptsPerDay: number | null
  mailboxSendRcptsPerHour: number | null
  maxMailTemplates: number | null
  maxMailboxes: number | null
  name: string
  noticeLanguage: string | null
  noticeMailboxId: string | null
  plan: string | null
  purgeAt: number | null
  purgedAt: number | null
  recoverySelfService: boolean
  recvBytesPerDay: number | null
  recvMsgsPerDay: number | null
  retentionDays: number | null
  semantic: boolean
  sendHold: ('disabled' | 'paused') | null
  sendMsgsPerDay: number | null
  sendMsgsPerHour: number | null
  sendRcptsPerDay: number | null
  sendRcptsPerHour: number | null
  storageLimitBytes: number | null
  vanityHosts: boolean
  verificationToken: string | null
  verifiedRecipientsOnly: boolean
}

Fields

FieldTypeDescription
activityDaystring | nullThe UTC date (YYYY-MM-DD) of the latest recorded client activity of any identity in this account, the dormancy signal; null means no recorded activity. Show it as returned, not converted to a local timezone
addressCreatesPerDaynumber | nullAddresses (routes) this account may CREATE per rolling day (null = platform default, 0 = unlimited)
billingTier('free' | 'pro')What the billing tool sold this account (system-written, PUT /accounts/:accountId/billing-tier). Not a limit: Pro's numbers are stamped only once the account is also vetted (plan = trusted); an unvetted Pro account keeps the untrusted numbers until an operator vets it
createdAtnumberCreation timestamp in epoch seconds
deletedAtnumber | nullSoft-deletion timestamp in epoch seconds, or null if active
domainCreatesPerDaynumber | nullDomains this account may onboard per rolling day (null = platform default, 0 = unlimited)
forwardMsgsPerDaynumber | nullInbound-driven egress per rolling day — mail leaving because a route was configured, with no local sender to charge (null = platform default, 0 = unlimited). Ledger is per DOMAIN, so N domains get N x this; never spends the send allowance
idstringUnique account ULID
mailboxCreatesPerDaynumber | nullMailboxes this account may CREATE per rolling day (null = platform default, 0 = unlimited) — a churn bound, not a ceiling; maxMailboxes is the ceiling
mailboxSendMsgsPerDaynumber | nullThe MAILBOX DEFAULT: messages each of this account's mailboxes may send per day when it has no override of its own (null = the platform default, 0 = unlimited)
mailboxSendMsgsPerHournumber | nullThe MAILBOX DEFAULT's burst window: messages each mailbox may send per hour when it has no override of its own (null = the platform default, 0 = unlimited)
mailboxSendRcptsPerDaynumber | nullThe MAILBOX DEFAULT: recipients each mailbox may send to per day when it has no override of its own (null = the platform default, 0 = unlimited)
mailboxSendRcptsPerHournumber | nullThe MAILBOX DEFAULT's burst window: recipients each mailbox may send to per hour when it has no override of its own (null = the platform default, 0 = unlimited)
maxMailTemplatesnumber | nullStored mail templates this account may hold (null = the platform default, MAX_MAIL_TEMPLATES_DEFAULT; 0 = unlimited)
maxMailboxesnumber | nullMaximum allowed mailboxes (null = the platform default, MAX_MAILBOXES_DEFAULT)
namestringAccount name
noticeLanguagestring | nullThe language platform mail to a recipient with no identity here is written in (BCP 47, lowercased; null = English)
noticeMailboxIdstring | nullMailbox that receives limit notices as local postmaster mail (null = console-only)
planstring | nullThe service-class label last applied via POST /accounts/:accountId/plan (display/billing only — enforcement reads the limit columns; null = no plan recorded)
purgeAtnumber | nullScheduled permanent purge timestamp in epoch seconds, or null
purgedAtnumber | nullPermanent purge completion timestamp in epoch seconds, or null
recoverySelfServicebooleanTrue if mailbox users in this account may recover their own password (recovery codes, and the recovery address once it ships). False is the admin_only policy: existing addresses and codes are KEPT and refused, and resets come from an admin. Written by the tenant via PUT /accounts/:accountId/recovery-policy
recvBytesPerDaynumber | nullDaily inbound byte allowance across the account (null = platform default, 0 = unlimited)
recvMsgsPerDaynumber | nullDaily inbound message allowance across the account (null = platform default, 0 = unlimited); a backstop — over it inbound is deferred, never bounced
retentionDaysnumber | nullThe account DEFAULT time-based retention window in days, applied to every mailbox with no window of its own (null = none, the default). Outside the plan system
semanticbooleanTrue if this account's mailboxes may enable SEMANTIC search (the plan gate for embedding). System-written only. Clearing it is refused 409 semantic_mailboxes_opted_in while any mailbox is opted in — paid with vectors does not become free; the tenant opts out (which deletes the embeddings) or the account is deleted (which wipes them). Once none is opted in, clearing stops new opt-ins and darkens the semantic read routes (409 semantic_not_enabled)
sendHold('disabled' | 'paused') | nullOperator enforcement over every mailbox on every domain this account owns: 'disabled' = permanent stop, 'paused' = reversible hold, null = neither
sendMsgsPerDaynumber | nullDaily outbound message limit (null = platform default, 0 = unlimited)
sendMsgsPerHournumber | nullHourly (burst) outbound message limit (null = platform default, 0 = unlimited)
sendRcptsPerDaynumber | nullDaily outbound recipient limit (null = platform default, 0 = unlimited)
sendRcptsPerHournumber | nullHourly (burst) outbound recipient limit (null = platform default, 0 = unlimited)
storageLimitBytesnumber | nullAccount storage limit in bytes (null = platform default, 0 = unlimited)
vanityHostsbooleanTrue if account is permitted to configure custom vanity hostnames
verificationTokenstring | nullDNS TXT verification token for claiming domains
verifiedRecipientsOnlybooleanTrue while the account may send only to its VERIFIED RECIPIENTS (GET /accounts/:accountId/verified-recipients): addresses on its own domains, and outside addresses whose owners confirmed them; any other outside recipient is refused 403 recipient_not_verified, that recipient alone. Stamped by the vetting label (untrusted on, trusted off; system-written, POST /accounts/:accountId/plan); false for an account never vetted either way

Used by

MethodWhat it does
accounts.getGet account details
accounts.restoreRestore deleted account

On this page