# List subscriptions

`GET /v1/admin/billing/subscriptions`

URL: https://docs.spacerun.co/docs/platform/reference/billing-subscriptions/listBillingSubscriptions

- **Operation ID:** `listBillingSubscriptions`
- **Tags:** Billing subscriptions
- **Base URL:** `http://localhost:8787`

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

**Authentication:** staff Bearer JWT with permission `billing.read`.

## Authentication

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

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `page` | query | `integer` | no | Default: `1`. Min: 1 |
| `per_page` | query | `integer` | no | Default: `25`. Min: 1. Max: 100 |
| `status` | query | `string` | no | One of: `"incomplete"`, `"incomplete_expired"`, `"trialing"`, `"active"`, `"past_due"`, `"canceled"`, `"unpaid"`, `"paused"` |

## Responses

### 200

Subscriptions page.

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

Schema: `object`

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | `(object (BillingSubscription))[]` | yes | - |
| `data[].id` | `string<uuid>` | yes | - |
| `data[].user_id` | `string<uuid>` | yes | - |
| `data[].status` | `string` | yes | One of: `"incomplete"`, `"incomplete_expired"`, `"trialing"`, `"active"`, `"past_due"`, `"canceled"`, `"unpaid"`, `"paused"` |
| `data[].stripe_subscription_id` | `string` | yes | - |
| `data[].stripe_price_id` | `string \| null` | yes | - |
| `data[].current_period_start` | `string<date-time>` | yes | - |
| `data[].current_period_end` | `string<date-time>` | yes | - |
| `data[].cancel_at_period_end` | `boolean` | yes | - |
| `data[].created_at` | `string<date-time>` | yes | - |
| `data[].product_key` | `string` | yes | - |
| `data[].product_name` | `string` | yes | - |
| `meta` | `object` | yes | - |
| `meta.page` | `integer` | yes | Min: 1 |
| `meta.per_page` | `integer` | yes | Min: 1. Max: 100 |
| `meta.total` | `integer` | yes | Min: 0 |

## 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": "billing.read"
  }
}
```

### 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 GET 'http://localhost:8787/v1/admin/billing/subscriptions' \
  -H "Authorization: Bearer $ACCESS_TOKEN"
```

### 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/subscriptions", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
  },
});
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();
```