# Gift a credit pack

`POST /v1/admin/billing/credits/gift-pack`

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

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

Grants a credit pack to a user. After DB preflight checks, optionally creates a Stripe invoice first (skipped, with `invoiceSkipped: true`, when Stripe is not configured); no invoice means no grant. Queues a notification email (failures 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`.

**Idempotency:** Required, 1-64 chars of A-Z a-z 0-9 _ -. Reusing it with the same user, pack and quantity does not duplicate the grant or the Stripe invoice.

## Authentication

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

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `idempotency-key` | header | `string` | yes | Min length: 1. Max length: 64. Pattern: `^[A-Za-z0-9_-]+$` |

## Request body

Required: yes.

Content type: `application/json`

Schema: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `userId` | `string<uuid>` | yes | - |
| `productId` | `string<uuid>` | yes | - |
| `quantity` | `integer` | yes | Min: 1. Max: 1000 |
| `reason` | `string` | yes | Min length: 1. Max length: 500 |
| `stripeInvoice` | `boolean` | yes | - |

## Responses

### 201

Pack gifted.

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

Schema: `object (BillingGiftPackResult)`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `ledgerId` | `string` | no | - |
| `stripeInvoiceId` | `string \| null` | yes | - |
| `invoiceSkipped` | `boolean` | yes | - |

## Errors

### 400

Request validation failed. `validation_failed`: missing or malformed `Idempotency-Key` header.

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

Schema: `object (ValidationErrorBody) | object (ErrorBody)`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `(variant 1).success` | `boolean` | yes | One of: `false` |
| `(variant 1).error` | `object` | yes | - |
| `(variant 1).error.name` | `string` | yes | One of: `"ZodError"` |
| `(variant 1).error.issues` | `object[]` | yes | - |
| `(variant 1).error.issues[].code` | `string` | yes | - |
| `(variant 1).error.issues[].path` | `(string \| number)[]` | yes | - |
| `(variant 1).error.issues[].message` | `string` | yes | - |
| `(variant 2).error` | `string` | yes | Stable machine-readable error code, e.g. `forbidden`, `not_found`. |
| `(variant 2).details` | `any` | no | Optional structured context. For 403 it is `{ perm }`. |

**Request validation**

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

**Application error**

```json
{
  "error": "validation_failed"
}
```

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

`credit_pack` or `user`.

- 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": "credit_pack"
}
```

### 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`, `pack_has_no_price`, 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"
}
```

### 502

`stripe_error`: the gift invoice could not be created; nothing was granted.

- 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": "stripe_error"
}
```

## Examples

### curl

```bash
curl -X POST 'http://localhost:8787/v1/admin/billing/credits/gift-pack' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'idempotency-key: 7d0f3c52-9a1e-4b6f-8c2d-5e4a3b2c1d0e' \
  -H 'Content-Type: application/json' \
  --data '{"userId":"3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90","productId":"3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90","quantity":1,"reason":"example","stripeInvoice":false}'
```

### 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/gift-pack", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "idempotency-key": "7d0f3c52-9a1e-4b6f-8c2d-5e4a3b2c1d0e",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "userId": "3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90",
    "productId": "3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90",
    "quantity": 1,
    "reason": "example",
    "stripeInvoice": false
  }),
});
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();
```