Skip to Content

The AccountSendUsageSend type of the TypeScript SDK, part of AccountSendUsage.

type AccountSendUsageSend = {
  messages: number
  messagesHour: number
  msgsPerDay: number | null
  msgsPerHour: number | null
  rcptsPerDay: number | null
  rcptsPerHour: number | null
  recipients: number
  recipientsHour: number
}

Fields

FieldTypeDescription
messagesnumberDistinct 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 (current + previous hourly bucket), summed across the account's ledger shards
msgsPerDaynumber | nullConfigured daily message limit (null = unenforced)
msgsPerHournumber | nullConfigured hourly (burst) message limit (null = unenforced)
rcptsPerDaynumber | nullConfigured daily recipient limit (null = unenforced)
rcptsPerHournumber | nullConfigured hourly (burst) recipient limit (null = unenforced)
recipientsnumberTotal recipients 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)

Used in

AccountSendUsage.

On this page