Skip to Content

Get account receive allowance usage.

Returns the inbound receive allowance's consumption (messages and bytes STORED in the rolling 24-hour window, across every mailbox the account owns), the allowance in force, the per-mailbox fair-share fraction, and the window's heaviest receivers. The allowance is a platform backstop: over it, inbound mail is deferred (429 receiving_rate_limited), never bounced.

openemail.accounts.getReceiveUsage(
  accountId: string,
  options?: CallOptions,
): ApiPromise<AccountReceiveUsage>

It calls GET /accounts/{accountId}/receive-usage: Get account receive allowance usage in the API reference.

Example

const accountReceiveUsage = await openemail.accounts.getReceiveUsage(accountId)

Arguments

ArgumentTypeDescription
accountIdstringAccount ULID identifier. The path's {accountId}.

Options

It takes no options of its own. Every call also takes signal, timeout, retry and headers, which say how that one call is sent (call options).

Answer

Awaited, it is the API's JSON, AccountReceiveUsage. It is an ApiPromise: .withResponse() gives the same with the Response it came in, for its headers.

Errors

StatusWhat it means
401unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a WWW-Authenticate: Bearer challenge
404Account not found or not accessible to this principal
503temporary_failure: the platform's storage could not answer just now; retry after the Retry-After window. Any operation can answer this. A write that got it may have been applied, so retry it with the same idempotency key where it takes one, or read the state back first (see Transient failures in the API description)

A failed call rejects with a RequestError: its status, and its code, the API's error. Decide on the code: one status covers several.

Types

It names these types of the API, each on a page of its own: AccountReceiveUsage.