# at.happyproto.server.listPlans

> Published by [happyproto.at](https://lexicon.garden/identity/did:plc:mo7vq4jbioxwafy5zkcc3eux)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.server.listPlans)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.server.listPlans/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.server.listPlans/examples)

## Definitions

### `at.happyproto.server.listPlans`

**Type**: `query`

The plans a new or changed instance can use. Customers only.

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `plans` | `array` | Yes |  |

#### Errors

- **AuthRequired**: This endpoint requires an authenticated caller.
- **Forbidden**: The caller is not a HappyProto customer, or the provisioner refused them.
- **InvalidRequest**: The provisioner refused the request as malformed. Not expected from this read; declared because every provisioner refusal is mapped the same way.
- **NotFound**: Passed through from the provisioner.
- **InvalidSlug**: Passed through from the provisioner.
- **SlugTaken**: Passed through from the provisioner.
- **NotEntitled**: Passed through from the provisioner.
- **InstanceLimit**: Passed through from the provisioner.
- **NoCapacity**: Passed through from the provisioner.
- **OperationInProgress**: Passed through from the provisioner.
- **Upstream**: The provisioner is unreachable, not configured, or answered with an error it does not explain to callers.

### `at.happyproto.server.listPlans#plan`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cpuMillis` | `integer` | Yes | Thousandths of a CPU core. |
| `diskGb` | `integer` | Yes |  |
| `id` | `string` | Yes |  |
| `memoryMb` | `integer` | Yes |  |
| `name` | `string` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "The plans a new or changed instance can use. Customers only.",
      "errors": [
        {
          "description": "This endpoint requires an authenticated caller.",
          "name": "AuthRequired"
        },
        {
          "description": "The caller is not a HappyProto customer, or the provisioner refused them.",
          "name": "Forbidden"
        },
        {
          "description": "The provisioner refused the request as malformed. Not expected from this read; declared because every provisioner refusal is mapped the same way.",
          "name": "InvalidRequest"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "NotFound"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "InvalidSlug"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "SlugTaken"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "NotEntitled"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "InstanceLimit"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "NoCapacity"
        },
        {
          "description": "Passed through from the provisioner.",
          "name": "OperationInProgress"
        },
        {
          "description": "The provisioner is unreachable, not configured, or answered with an error it does not explain to callers.",
          "name": "Upstream"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "plans": {
              "items": {
                "ref": "#plan",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "plans"
          ],
          "type": "object"
        }
      },
      "type": "query"
    },
    "plan": {
      "properties": {
        "cpuMillis": {
          "description": "Thousandths of a CPU core.",
          "type": "integer"
        },
        "diskGb": {
          "type": "integer"
        },
        "id": {
          "type": "string"
        },
        "memoryMb": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "memoryMb",
        "cpuMillis",
        "diskGb"
      ],
      "type": "object"
    }
  },
  "id": "at.happyproto.server.listPlans",
  "lexicon": 1
}
```