# Set the egress cap

URL: https://heaven.dev/docs/reference/billing/egress-cap
Updated: 2026-11-21

Set, remove or reset the monthly egress spending cap. At the cap, internet egress is limited to 5 Mbit/s per pool until the month ends or the cap increases.

`POST /v1/organization/billing/modify`

## Parameters

- `amount` (string): Monthly egress spending cap in dollars, zero or more.
- `off` (boolean): Turn off the monthly egress cap.
- `default` (boolean): Use the total monthly cost of your plans as the egress cap.
- `organization` (string): Organization name or ID. A credential, named resource or sole membership can select the organization for you.

## Returns

- `data` (object, always present): The account's monthly internet egress and egress cap.
  - `allowance_bytes` (integer, always present): Internet egress included for the month, in bytes.
  - `cap` (string, always present): Egress cap setting: `default`, `amount` or `off`.
  - `cap_micros` (integer): Monthly cap in millionths of a dollar. Absent when the cap is off. May be omitted.
  - `charged_micros` (integer, always present): Egress charged so far this month, in millionths of a dollar.
  - `charging` (boolean, always present): Whether egress overage is currently billed.
  - `month` (string (date-time), always present): Month being measured.
  - `not_charged_bytes` (integer): Overage bytes not charged while the wallet was past its grace period. May be omitted.
  - `over_bytes` (integer, always present): Usage above the included allowance, in bytes.
  - `projected_bytes` (integer, always present): Estimated monthly egress based on use so far, in bytes.
  - `slowed` (boolean, always present): Whether the account's internet egress is currently slowed because of its egress cap, its spending cap or its wallet state.
  - `used_bytes` (integer, always present): Internet egress used this month, in bytes.
  - `would_charge_micros` (integer): What overage would cost if charging were enabled, in millionths of a dollar. May be omitted.

## Errors

Each code is explained in full at https://heaven.dev/docs/reference/errors.

| Code | Status | What happened |
|---|---:|---|
| `invalid` | 400 | An input is missing or invalid. |
| `unauthenticated` | 401 | The credential is missing, invalid, expired or revoked. |
| `denied` | 403 | The caller lacks permission for this action. |
| `not_found` | 404 | The resource is absent or inaccessible to this caller. |
| `conflict` | 409 | The request conflicts with the current resource state or an earlier request. |
| `over_capacity` | 409 | The request exceeds a resource or credential allowance. |
| `access_list_full` | 409 | The change would exceed the access-list allowance. |
| `payment_required` | 402 | Payment or credit is required. |
| `rate_limited` | 429 | The caller's request rate exceeds its limit. |
| `busy` | 429 | Too much work is in progress to accept this request. |
| `unknown` | 503 | The outcome is unconfirmed; a change may have happened. |
| `unavailable` | 503 | The service or requested feature is unavailable. |

## Notes

- CLI: `heaven login` with `HEAVEN_API_KEY` unset. MCP: Heaven sign-in. cURL: `HEAVEN_SIGN_IN_KEY` from approved device sign-in (`POST /v1/auth/create`).
- A key limited to a command list cannot run this command.
- **Amount:** Limit monthly egress charges to the chosen amount. Required: `amount`. Optional: `organization`.
- **Off:** Remove the limit on monthly egress charges. Required: `off`. Optional: `organization`.
- **Default:** Set the egress cap to the cost of the month's plans. Required: `default`. Optional: `organization`.

## Examples

```sh tab="heaven CLI"
heaven billing egress-cap
  [--amount DOLLARS]
  [--off]
  [--default]
  [--organization ORGANIZATION]
```

```sh tab="SSH"
ssh cli@heaven.dev billing egress-cap
  [--amount DOLLARS]
  [--off]
  [--default]
  [--organization ORGANIZATION]
```

```sh tab="cURL"
curl https://heaven.dev/v1/organization/billing/modify \
  -H "Authorization: Bearer $HEAVEN_SIGN_IN_KEY" \
  --json '{"action": "egress-cap", "amount": "50"}'
```

```json tab="MCP"
{ "tool": "billing_egress-cap",
  "arguments": { "amount": "50" } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "allowance_bytes": 242000000000,
    "cap": "amount",
    "cap_micros": 50000000,
    "charged_micros": 0,
    "charging": true,
    "month": "2026-11-01T00:00:00Z",
    "over_bytes": 0,
    "projected_bytes": 0,
    "slowed": false,
    "used_bytes": 0
  }
}
```
