---
title: "Create a workspace plan"
description: "POST /admin/v1/workspaces/{workspaceId}/plans — Create a workspace plan"
---

> Documentation Index
> Fetch the complete documentation index at: https://nexus.microvoid.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a workspace plan

## Endpoint

```http
POST /admin/v1/workspaces/{workspaceId}/plans
```

Operation ID: `createPlan`

## Authentication

Send a Nexus Management Key as `Authorization: Bearer <management-key>`. This credential is control-plane only.

## Idempotency

This operation does not declare an `Idempotency-Key` requirement in the accepted OpenAPI contract.

## Request

### Parameters

| Name          | Location | Required | Schema   | Description |
| ------------- | -------- | -------- | -------- | ----------- |
| `workspaceId` | path     | Yes      | `string` | —           |

### application/json body

Required: **Yes**

Type: `CreateWorkspacePlanDto`

| Field             | Required | Type                     | Description |
| ----------------- | -------- | ------------------------ | ----------- |
| `key`             | Yes      | `string`                 | —           |
| `name`            | Yes      | `string`                 | —           |
| `billingInterval` | Yes      | `string (MONTH \| YEAR)` | —           |

## Responses

| Status | Description | Content type     | Schema             |
| ------ | ----------- | ---------------- | ------------------ |
| `201`  | —           | application/json | `WorkspacePlanDto` |

Only responses explicitly declared by the accepted Admin OpenAPI contract are shown. The current contract does not declare operation-specific error bodies; the SDK preserves any non-success status and body in [`AdminApiError`](/management-sdk/error-handling).

### `201` application/json schema

Type: `WorkspacePlanDto`

| Field             | Required | Type                                   | Description |
| ----------------- | -------- | -------------------------------------- | ----------- |
| `id`              | Yes      | `string`                               | —           |
| `workspaceId`     | Yes      | `string`                               | —           |
| `key`             | Yes      | `string`                               | —           |
| `name`            | Yes      | `string`                               | —           |
| `billingInterval` | Yes      | `string (MONTH \| YEAR)`               | —           |
| `status`          | Yes      | `string (DRAFT \| ACTIVE \| ARCHIVED)` | —           |

## Examples

### TypeScript Management SDK

`NexusAdminClient.createPlan` uses `AdminOperationInput<"createPlan">` and returns `Promise<AdminOperationOutput<"createPlan">>`.

```ts
import { NexusAdminClient } from '@nexus/sdk-typescript';

const nexus = new NexusAdminClient({
  baseUrl: 'https://nexus.microvoid.io',
  managementKey: process.env.NEXUS_MANAGEMENT_KEY,
});

const result = await nexus.createPlan({
  path: {
    workspaceId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  },
  body: {
    key: 'example-key',
    name: 'Production',
    billingInterval: 'MONTH',
  },
});
```

### Fetch

```ts
const response = await fetch(
  'https://nexus.microvoid.io/admin/v1/workspaces/533c4e1e-2823-4349-86b9-d6f1a869a2ca/plans',
  {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${process.env.NEXUS_MANAGEMENT_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      key: 'example-key',
      name: 'Production',
      billingInterval: 'MONTH',
    }),
  },
);

if (!response.ok) throw new Error(`Nexus request failed: ${response.status}`);
```

### curl

```bash
curl --request POST \
  "https://nexus.microvoid.io/admin/v1/workspaces/533c4e1e-2823-4349-86b9-d6f1a869a2ca/plans" \
  --header "Authorization: Bearer ${NEXUS_MANAGEMENT_KEY}" \
  --header "Content-Type: application/json" \
  --data "{\"key\":\"example-key\",\"name\":\"Production\",\"billingInterval\":\"MONTH\"}"
```

## Related guide

- [Workspace plans](/docs/control-plans-and-quota/workspace-plans)
- [API Reference overview](/api-reference)

Source: https://nexus.microvoid.io/api-reference/admin/plans-and-strategies/create-plan/index.mdx