# Grant or adjust credits

`POST /v1/admin/billing/credits/grant`

URL: https://docs.spacerun.co/docs/platform/reference/billing-credits/grantBillingCredits

- **Operation ID:** `grantBillingCredits`
- **Tags:** Billing credits
- **Base URL:** `http://localhost:8787`

Adds a gift (positive) or adjustment (positive or negative, no tier) ledger entry for a user. Gifts to a tier require that tier to be playable. `expiresAt` accepts an ISO instant, `never`, or null for the site default. Gifts queue a notification email (failures are ignored). Audited by the database function; publishes a dashboard event.

**Workflow:** [Integration guide](https://docs.spacerun.co/docs/platform/guides/billing-checkout).

**Authentication:** staff Bearer JWT with permission `credits.grant`.

## Authentication

- **Auth:** staff Bearer JWT (`Authorization: Bearer <access_token>`) with the permissions below.
- **Required permissions:** `credits.grant`

## Request body

Required: yes.

Content type: `application/json`

Schema: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `userId` | `string<uuid>` | yes | - |
| `amount` | `integer` | yes | - |
| `entryType` | `string` | no | One of: `"gift"`, `"adjustment"`. Default: `"gift"` |
| `reason` | `string` | yes | Min length: 1. Max length: 500 |
| `tierKey` | `string \| null` | no | Min length: 1. Max length: 64 |
| `expiresAt` | `string<date-time> \| string \| any \| null` | no | - |

## Responses

### 201

Entry created.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (BillingGrantCreditsResult)`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ledgerId` | `string` | no | - |

## Errors

### 400

Request validation failed.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ValidationErrorBody)`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | `boolean` | yes | One of: `false` |
| `error` | `object` | yes | - |
| `error.name` | `string` | yes | One of: `"ZodError"` |
| `error.issues` | `object[]` | yes | - |
| `error.issues[].code` | `string` | yes | - |
| `error.issues[].path` | `(string \| number)[]` | yes | - |
| `error.issues[].message` | `string` | yes | - |

**Request validation**

```json
{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}
```

### 401

Missing, malformed, expired or wrong-audience Bearer token (`missing_token`, `invalid_token`, `invalid_audience`).

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `error` | `string` | yes | Stable machine-readable error code, e.g. `forbidden`, `not_found`. |
| `details` | `any` | no | Optional structured context. For 403 it is `{ perm }`. |

**Error response**

```json
{
  "error": "missing_token"
}
```

### 403

Authenticated but lacking the required permission. `details.perm` lists the accepted permission keys.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "forbidden",
  "details": {
    "perm": "credits.grant"
  }
}
```

### 404

`not_found`: user does not exist.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "not_found"
}
```

### 409

`conflict`.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "conflict"
}
```

### 422

`tier_not_playable` (details `{ tierKey }`), `expires_in_past`, or `invalid_request`.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "tier_not_playable"
}
```

### 500

Unexpected server error (`internal`). No details are returned.

- Header `x-request-id`: Request identifier; quote it when reporting an error.
Content type: `application/json`

Schema: `object (ErrorBody)`, fields as described above.

**Error response**

```json
{
  "error": "internal"
}
```

## Examples

### curl

```bash
curl -X POST 'http://localhost:8787/v1/admin/billing/credits/grant' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"userId":"3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90","amount":1,"entryType":"gift","reason":"example","tierKey":"example","expiresAt":"2026-01-15T12:00:00.000Z"}'
```

### TypeScript

```ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/billing/credits/grant", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "userId": "3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90",
    "amount": 1,
    "entryType": "gift",
    "reason": "example",
    "tierKey": "example",
    "expiresAt": "2026-01-15T12:00:00.000Z"
  }),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();
```