# accounts.getReceiveUsage

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.

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

It calls `GET /accounts/{accountId}/receive-usage`: [Get account receive allowance usage](/docs/api/accounts/get_AccountReceiveUsageGet) in the API reference.

## Example

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

## Arguments

| Argument | Type | Description |
| --- | --- | --- |
| `accountId` | `string` | Account 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](/docs/sdks/typescript/calling-methods#call-options)).

## Answer

Awaited, it is the API's JSON, [`AccountReceiveUsage`](/docs/sdks/typescript/types/account-receive-usage). It is an [`ApiPromise`](/docs/sdks/typescript/responses): `.withResponse()` gives the same with the `Response` it came in, for its headers.

## Errors

| Status | What it means |
| --- | --- |
| `401` | unauthorized: the bearer credential is missing, malformed, expired, or revoked. Carries a `WWW-Authenticate: Bearer` challenge |
| `404` | Account not found or not accessible to this principal |
| `503` | temporary_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`](/docs/sdks/typescript/errors): 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`](/docs/sdks/typescript/types/account-receive-usage).
