Skip to Content

The AccountSendUsage type of the TypeScript SDK, which accounts.getSendUsage take or answer.

type AccountSendUsage = {
  accountId: string
  burstWindowSeconds: number
  creates: AccountSendUsageCreates
  send: AccountSendUsageSend
  sendHold: ('disabled' | 'paused') | null
  windowSeconds: number
}

Fields

FieldTypeDescription
accountIdstringAccount ULID
burstWindowSecondsnumberWidth of one burst bucket in seconds (3600); the burst figures cover two of them
createsAccountSendUsageCreates
sendAccountSendUsageSend
sendHold('disabled' | 'paused') | nullThe account's own hold: 'disabled' = permanent stop, 'paused' = reversible hold, null = neither
windowSecondsnumberDuration of the rate-limit window in seconds (e.g. 86400)

Used by

MethodWhat it does
accounts.getSendUsageGet account send rate limit usage

On this page