Skip to Content

The AccountLimitInForce type of the TypeScript SDK, part of AccountLimitsLimits.

type AccountLimitInForce = {
  agreed: boolean
  enforcement: ('enforced' | 'log_only' | 'off')
  limit: number | null
  value: number | null
}

Fields

FieldTypeDescription
agreedbooleanTrue if this number is the account's AGREED LIMIT: an operator set it on this account with PATCH /accounts/:accountId, and no plan stamp (vet, revoke, billing-tier change) replaces it. An agreement of the platform default (value null) is an agreement too. While the account is unvetted, the stamped value is the stricter of the agreement and the unvetted number, so value can be lower than what was agreed
enforcement('enforced' | 'log_only' | 'off')Configured behavior of this threshold: enforced = exceeding it can trigger refusal; log_only = measured and logged without refusing; off = no threshold applies (limit is null). SEND_LIMITS_LOG_ONLY shadows the eight send/mailbox-send limits, the three creation limits and forwarding; RECV_LIMITS_LOG_ONLY shadows both receive limits; STORAGE_LIMITS_LOG_ONLY shadows the account storage pool. Only the exact flag value true enables shadow mode. maxMailboxes and maxMailTemplates remain enforced when finite. This describes limit configuration, not transient ledger health or other refusal checks
limitnumber | nullThe resolved threshold used by the limit's check: the account's own number, or the platform default when the account stores none. Shadow mode preserves this number; enforcement says whether exceeding it can trigger refusal. null = no threshold applies on this axis: the account stores 0 (explicitly unlimited), or it stores null and the platform default is blank or 0, or (mailboxCreatesPerDay, addressCreatesPerDay, domainCreatesPerDay, forwardMsgsPerDay) the deployment has that limit switched off, which makes any account number inert. value says which
valuenumber | nullThe account's stored number, as GET /accounts/:accountId reports it: null = the account follows the platform default, 0 = explicitly unlimited (except maxMailboxes, which has no such spelling), n = the account's own number. With limit it tells the causes of a null limit apart: value 0 = the account is unlimited; value null = the platform sets no bound; value n with a null limit = the deployment has the limit switched off

Used in

AccountLimitsLimits.

On this page