Skip to Content

The SendUsage type of the TypeScript SDK, which domains.getForwardUsage and mailboxes.getSendUsage take or answer.

type SendUsage = {
  burstWindowSeconds: number
  messages: number
  messagesHour: number
  msgsPerDay: number | null
  msgsPerHour: number | null
  rcptsPerDay: number | null
  rcptsPerHour: number | null
  recipients: number
  recipientsHour: number
  sendHold: ('disabled' | 'paused') | null
  windowSeconds: number
}

Fields

FieldTypeDescription
burstWindowSecondsnumberWidth of one burst bucket in seconds (3600); the burst figures cover two of them
messagesnumberNumber of distinct messages sent in the rolling 24-hour window, plus each accepted list post whose fan-out is still being delivered: the count the daily limit is checked against
messagesHournumberDistinct messages in the BURST window — the current hourly bucket plus the previous one, so a burst stays visible for up to an hour after it ended
msgsPerDaynumber | nullConfigured daily message limit (null = unlimited or unenforced)
msgsPerHournumber | nullConfigured hourly (burst) message limit (null = unlimited or unenforced)
rcptsPerDaynumber | nullConfigured daily recipient limit (null = unlimited or unenforced)
rcptsPerHournumber | nullConfigured hourly (burst) recipient limit (null = unlimited or unenforced)
recipientsnumberTotal recipient count sent to in the rolling 24-hour window, plus the recipients an accepted list post still holds for its fan-out: the count the daily limit is checked against
recipientsHournumberRecipients in the BURST window (current + previous hourly bucket)
sendHold('disabled' | 'paused') | nullThe mailbox's own hold: 'disabled' = permanent stop, 'paused' = reversible hold, null = neither
windowSecondsnumberDuration of the rate-limit window in seconds (e.g. 86400 for 24h)

Used by

MethodWhat it does
domains.getForwardUsageGet domain forwarding rate limit usage
mailboxes.getSendUsageGet outbound send rate limit usage

On this page