Skip to Content

The LimitIncident type of the TypeScript SDK, which accounts.listLimitIncidents take or answer.

type LimitIncident = {
  accountId: string
  axis: string
  direction: ('send' | 'recv' | 'forward' | 'storage' | 'mint')
  firstAt: number
  id: string
  ledgerId?: string
  level?: (80 | 90)
  limit: number | null
  notifiedAt: number | null
  resolvedAt: number | null
  scope: ('mailbox' | 'account' | 'domain')
  scopeId: string | null
  shadow: boolean
}

Fields

FieldTypeDescription
accountIdstringThe account the limit belongs to
axisstringThe axis that refused (e.g. msgs_per_day, msgs_per_hour, bytes_day, mailbox_creates_day)
direction('send' | 'recv' | 'forward' | 'storage' | 'mint')The limit family
firstAtnumberWhen the episode opened (ms since epoch)
idstringIncident ULID
ledgerIdstringOptional. Originating ledger, present only on operator near rows when known. Account near rows measure this ledger's enforced shard slice, not aggregate account usage at 80% or 90% of the full displayed plan cap
level(80 | 90)Optional. Present only on a NEAR episode (operator-facing, and only when asked for): the per-cent level of limit that a check which PASSED left the count at or above, 80 or 90. Absent on an at-limit episode; an account's own feed lists only those. A near row is never noticed (notifiedAt stays null) and settles like any other: resolvedAt is stamped once a check has found the count back below the level and an hour has gone by without it rising again, on the store's next wake point
limitnumber | nullThe number in force when it fired
notifiedAtnumber | nullWhen the tenant notice was CLAIMED for delivery into the notice mailbox — stamped before the local delivery, so a delivery cut short between the two leaves a stamp with no mail in rare cases (null = not noticed: shadow, no notice mailbox, inside the per-axis-per-scope daily floor, or a delivery that failed outright — which releases the stamp)
resolvedAtnumber | nullWhen the episode ENDED: the instant a check last passed, stamped once the refusing store's reopen floor (one hour) has elapsed without another refusal, on its next wake point. Near rows also expire at firstAt plus seven days, even if a retired ledger never wakes again. null = still open or awaiting settlement
scope('mailbox' | 'account' | 'domain')Which scope's limit fired
scopeIdstring | nullThe scope's identity when narrower than the account: a mailbox ULID, or — for the receive allowance's door-charged subjects — list:<address> (a group judged at the weight of its fan-out) or wh:<address> (a webhook route); a domain for the forwarding family. A console must not assume a mailbox scope links to /mailboxes/:id
shadowbooleanTrue for a would-refuse under a LOG_ONLY flag (operator-facing only)

Used by

MethodWhat it does
accounts.listLimitIncidentsList an account's limit incidents

On this page