AccountSendUsage
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
| Field | Type | Description |
|---|---|---|
accountId | string | Account ULID |
burstWindowSeconds | number | Width of one burst bucket in seconds (3600); the burst figures cover two of them |
creates | AccountSendUsageCreates | |
send | AccountSendUsageSend | |
sendHold | ('disabled' | 'paused') | null | The account's own hold: 'disabled' = permanent stop, 'paused' = reversible hold, null = neither |
windowSeconds | number | Duration of the rate-limit window in seconds (e.g. 86400) |
Used by
| Method | What it does |
|---|---|
accounts.getSendUsage | Get account send rate limit usage |