---
title: "Map an external Product/Price to a workspace plan"
description: "POST /admin/v1/billing-connections/{connectionId}/product-mappings — Map an external Product/Price to 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.

# Map an external Product/Price to a workspace plan

## Endpoint

```http
POST /admin/v1/billing-connections/{connectionId}/product-mappings
```

Operation ID: `createBillingProductMapping`

## 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 |
| -------------- | -------- | -------- | -------- | ----------- |
| `connectionId` | path     | Yes      | `string` | —           |

### application/json body

Required: **Yes**

Type: `CreateProductMappingDto`

| Field               | Required | Type      | Description |
| ------------------- | -------- | --------- | ----------- |
| `externalProductId` | Yes      | `string`  | —           |
| `externalPriceId`   | No       | `string`  | —           |
| `planId`            | Yes      | `string`  | —           |
| `checkoutEnabled`   | No       | `boolean` | —           |

## Responses

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

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: `IdResponseDto`

| Field | Required | Type     | Description |
| ----- | -------- | -------- | ----------- |
| `id`  | Yes      | `string` | —           |

## Examples

### TypeScript Management SDK

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

```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.createBillingProductMapping({
  path: {
    connectionId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  },
  body: {
    externalProductId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
    planId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
  },
});
```

### Fetch

```ts
const response = await fetch(
  'https://nexus.microvoid.io/admin/v1/billing-connections/533c4e1e-2823-4349-86b9-d6f1a869a2ca/product-mappings',
  {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${process.env.NEXUS_MANAGEMENT_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      externalProductId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
      planId: '533c4e1e-2823-4349-86b9-d6f1a869a2ca',
    }),
  },
);

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

### curl

```bash
curl --request POST \
  "https://nexus.microvoid.io/admin/v1/billing-connections/533c4e1e-2823-4349-86b9-d6f1a869a2ca/product-mappings" \
  --header "Authorization: Bearer ${NEXUS_MANAGEMENT_KEY}" \
  --header "Content-Type: application/json" \
  --data "{\"externalProductId\":\"533c4e1e-2823-4349-86b9-d6f1a869a2ca\",\"planId\":\"533c4e1e-2823-4349-86b9-d6f1a869a2ca\"}"
```

## Related guide

- [Time boundaries](/docs/give-users-access/time-boundaries)
- [API Reference overview](/api-reference)

Source: https://nexus.microvoid.io/api-reference/admin/billing/create-billing-product-mapping/index.mdx