# Move a lookup key to a price

> The prices.move_lookup_key operation: POST /api/v1/prices/{id}/move_lookup_key in the REST API and the prices_move_lookup_key tool in the MCP server.

Moves a lookup key to this price, taking it from the price that has it (if any) in the same step. Use it when
a new price replaces an old one: integrators that look prices up by key (`prices.list?lookupKey=…`, checkout
sessions) get the new price at once, and nothing references a price ID that changed.

The price must be active and have no other lookup key (remove that first). Moving a key to the price that
already has it changes nothing. Both prices get a `price.updated` event.

## At a glance

- **REST:** `POST /api/v1/prices/{id}/move_lookup_key`
- **MCP tool:** `prices_move_lookup_key`
- **Operation ID:** `prices.move_lookup_key`
- **Scope:** Brand
- **Permission:** `catalog:write`
- **Risk tier:** `write`
- **Dry run:** Supported (send `Ownrecord-Dry-Run: true`)
- **Idempotency:** `Idempotency-Key` required
- **Modes:** Test and live
- **Authentication:** API key with the `catalog:write` scope
- **Since:** M4

## Request

### Path parameters

| Field | Type         | Description                  |
| ----- | ------------ | ---------------------------- |
| `id`  | `price_…` ID | The price that gets the key. |

### Body

A JSON object (`Content-Type: application/json`):

| Field       | Type   | Required | Description                                                                    |
| ----------- | ------ | -------- | ------------------------------------------------------------------------------ |
| `lookupKey` | string | Yes      | A stable name for the price, unique in the brand and mode, e.g. `pro_monthly`. |

## Response

`200 OK` with a JSON object:

| Field          | Type                                          | Description                                                                               |
| -------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `id`           | `price_…` ID                                  |                                                                                           |
| `object`       | `"price"`                                     |                                                                                           |
| `brandId`      | `brd_…` ID                                    |                                                                                           |
| `livemode`     | boolean                                       |                                                                                           |
| `productId`    | `prod_…` ID                                   |                                                                                           |
| `nickname`     | string or null                                |                                                                                           |
| `lookupKey`    | string or null                                |                                                                                           |
| `type`         | one of `one_time`, `recurring`, `credit_pack` |                                                                                           |
| `currency`     | string                                        |                                                                                           |
| `taxBehavior`  | one of `inclusive`, `exclusive`               |                                                                                           |
| `amount`       | money or null                                 | Fixed one-time or credit-pack amount.                                                     |
| `customAmount` | object or null                                | The range a buyer may choose from (custom-amount prices).                                 |
| `creditPack`   | object or null                                |                                                                                           |
| `recurring`    | object or null                                |                                                                                           |
| `active`       | boolean                                       |                                                                                           |
| `used`         | boolean                                       | A checkout session or payment referenced the price: what it charges can no longer change. |
| `usedAt`       | date-time or null                             |                                                                                           |
| `metadata`     | object                                        |                                                                                           |
| `createdAt`    | date-time                                     |                                                                                           |
| `updatedAt`    | date-time                                     |                                                                                           |

## Examples

### Point pro_monthly at the new price

```http
POST /api/v1/prices/price_01m4tx5nj8emwbyf7y9vcf47y3/move_lookup_key
Authorization: Bearer or_test_…
Idempotency-Key: 3f1c9a52-7d0e-4b8f-9a61-0c2d5e8b7f14
Content-Type: application/json

{
  "lookupKey": "pro_monthly"
}
```

Response (`200`):

```json
{
  "id": "price_01m4tx5nj8emwbyf7y9vcf47y3",
  "object": "price",
  "brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4",
  "livemode": false,
  "productId": "prod_01m4tx5nj8emwbyf7y9vcf47y0",
  "nickname": "Pro monthly, per seat",
  "lookupKey": "pro_monthly",
  "type": "recurring",
  "currency": "EUR",
  "taxBehavior": "inclusive",
  "amount": null,
  "customAmount": null,
  "creditPack": null,
  "recurring": {
    "interval": "month",
    "intervalCount": 1,
    "usageType": "licensed",
    "billingScheme": "tiered",
    "unitAmount": null,
    "tiersMode": "graduated",
    "tiers": [
      {
        "upTo": 10,
        "unitAmountMicros": "12000000",
        "flatAmount": null
      },
      {
        "upTo": "inf",
        "unitAmountMicros": "9000000",
        "flatAmount": null
      }
    ],
    "trialDays": 14,
    "includedCredits": null,
    "metered": null
  },
  "active": true,
  "used": false,
  "usedAt": null,
  "metadata": {},
  "createdAt": "2026-10-13T12:00:00.000Z",
  "updatedAt": "2026-10-14T09:30:00.000Z"
}
```

## Errors

| Code                                                                                                   | HTTP status | When                                               | What to do                                                                                               |
| ------------------------------------------------------------------------------------------------------ | ----------- | -------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| [`validation_failed`](https://ownrecord.io/docs/reference/errors.md#validation_failed)                 | 400         | The lookup key is malformed.                       | Fix the fields listed in `details.issues` and send the request again.                                    |
| [`price_archived`](https://ownrecord.io/docs/reference/errors.md#price_archived)                       | 409         | The price is archived.                             | Reactivate the price first (`active: true`), or use an active price.                                     |
| [`price_lookup_key_conflict`](https://ownrecord.io/docs/reference/errors.md#price_lookup_key_conflict) | 409         | The price already has another lookup key.          | Remove the price's current lookup key first (`lookupKey: null`), or move the key to a price without one. |
| [`resource_not_found`](https://ownrecord.io/docs/reference/errors.md#resource_not_found)               | 404         | No price with this ID is visible to the request.   | Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.     |
| [`version_conflict`](https://ownrecord.io/docs/reference/errors.md#version_conflict)                   | 409         | One of the prices changed at the same time; retry. | Fetch the object again and retry the change.                                                             |
| [`permission_denied`](https://ownrecord.io/docs/reference/errors.md#permission_denied)                 | 403         | You can't change this brand's catalog.             | Ask an organization owner or admin for a role or scope that allows this action.                          |

It can also return these [common errors](https://ownrecord.io/docs/reference.md#common-errors): [`api_version_unsupported`](https://ownrecord.io/docs/reference/errors.md#api_version_unsupported), [`invalid_json`](https://ownrecord.io/docs/reference/errors.md#invalid_json), [`unsupported_media_type`](https://ownrecord.io/docs/reference/errors.md#unsupported_media_type), [`authentication_required`](https://ownrecord.io/docs/reference/errors.md#authentication_required), [`api_key_invalid`](https://ownrecord.io/docs/reference/errors.md#api_key_invalid), [`scope_required`](https://ownrecord.io/docs/reference/errors.md#scope_required), [`idempotency_key_required`](https://ownrecord.io/docs/reference/errors.md#idempotency_key_required), [`idempotency_key_reused`](https://ownrecord.io/docs/reference/errors.md#idempotency_key_reused), [`idempotency_in_progress`](https://ownrecord.io/docs/reference/errors.md#idempotency_in_progress), [`approval_required`](https://ownrecord.io/docs/reference/errors.md#approval_required), [`approval_rejected`](https://ownrecord.io/docs/reference/errors.md#approval_rejected), [`approval_expired`](https://ownrecord.io/docs/reference/errors.md#approval_expired), [`stale_approval`](https://ownrecord.io/docs/reference/errors.md#stale_approval), [`approval_policy_denied`](https://ownrecord.io/docs/reference/errors.md#approval_policy_denied), [`rate_limited`](https://ownrecord.io/docs/reference/errors.md#rate_limited), [`internal_error`](https://ownrecord.io/docs/reference/errors.md#internal_error).