# Redeem an offer

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

Apply an offer code to your account. Promotional credit enters the wallet immediately. A discount, trial or capacity boost applies to the next eligible purchase.

`POST /v1/organization/billing/modify`

## Parameters

- `code` (string, required): The offer code.
- `organization` (string): Organization name or ID. A credential, named resource or sole membership can select the organization for you.

## Returns

- `data` (object, always present): A redeemed offer.
  - `credit_micros` (integer): Promotional credit added to the wallet now, in millionths of a dollar. May be omitted.
  - `effect` (string, always present): Benefit granted by the offer.
  - `expires_at` (string (date-time)): When the resulting credit expires, if it has an expiry. May be omitted.
  - `offer` (string, always present): Offer that was redeemed.
  - `waiting_for_purchase` (boolean, always present): Whether the offer is saved but waits for a qualifying purchase.

## 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

- API key permission: `billing redeem`.

## Examples

```sh tab="heaven CLI"
heaven billing redeem CODE
  [--organization ORGANIZATION]
```

```sh tab="SSH"
ssh cli@heaven.dev billing redeem CODE
  [--organization ORGANIZATION]
```

```sh tab="cURL"
curl https://heaven.dev/v1/organization/billing/modify \
  -H "Authorization: Bearer $HEAVEN_API_KEY" \
  --json '{"action": "redeem", "code": "WELCOME"}'
```

```json tab="MCP"
{ "tool": "billing_redeem",
  "arguments": { "code": "WELCOME" } }
```

Response:

```json title="Response excerpt"
{
  "version": 1,
  "data": {
    "credit_micros": 10000000,
    "effect": "$10.00 of credit, expiring after 1440h0m0s",
    "expires_at": "2027-01-15T12:00:00Z",
    "offer": "welcome",
    "waiting_for_purchase": false
  }
}
```
