# Update a product

> The products.update operation: PATCH /api/v1/products/{id} in the REST API and the products_update tool in the MCP server.

Changes a product's name, description, tax category, kind, entitlements, `lifetimeEntitlements`, pricing-table
hints, images or metadata. Send only the fields to change; `null` clears an optional value. `entitlements`,
`images` and `metadata` replace the whole list or map. Customers' entitlements are recomputed after a change of
`entitlements` or `lifetimeEntitlements`.

A new tax category applies to future sales; issued invoices keep theirs. `active: false` archives the product
(as products.archive) and `active: true` reactivates it.

## At a glance

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

## Request

### Path parameters

| Field | Type        | Description |
| ----- | ----------- | ----------- |
| `id`  | `prod_…` ID |             |

### Body

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

| Field                       | Type                                                                                                   | Required | Description                                                                                  |
| --------------------------- | ------------------------------------------------------------------------------------------------------ | -------- | -------------------------------------------------------------------------------------------- |
| `name`                      | string                                                                                                 | No       |                                                                                              |
| `description`               | string or null                                                                                         | No       |                                                                                              |
| `taxCategoryId`             | one of 9 values, e.g. `electronically_supplied_service`, `saas`, `ebook` (all in the OpenAPI document) | No       | The product's tax category (spec §7.2), e.g. `saas` or `electronically_supplied_service`.    |
| `kind`                      | one of `standard`, `plan`                                                                              | No       | `plan` products appear on the brand's pricing table; `standard` ones don't.                  |
| `entitlements`              | array of object                                                                                        | No       | Feature values the product grants (spec §36.1), each feature once.                           |
| `entitlements[].featureKey` | string                                                                                                 | Yes      | The feature's key, e.g. `seats.max`.                                                         |
| `entitlements[].value`      | boolean or number or string                                                                            | Yes      | true/false for a boolean feature, a whole number for a limit, one of the values for an enum. |
| `lifetimeEntitlements`      | boolean                                                                                                | No       | true: a one-time purchase grants the entitlements for good. Buyers' entitlements follow.     |
| `displayOrder`              | integer (0 to 10000) or null                                                                           | No       |                                                                                              |
| `highlighted`               | boolean                                                                                                | No       |                                                                                              |
| `images`                    | array of string                                                                                        | No       | Image URLs (https). On updates the whole list is replaced.                                   |
| `metadata`                  | object                                                                                                 | No       | Your own key-value pairs (at most 50 keys). On updates the whole set is replaced.            |
| `active`                    | boolean                                                                                                | No       | false archives the product, true reactivates it.                                             |

## Response

`200 OK` with a JSON object:

| Field                       | Type                                                                                                   | Description                                                                       |
| --------------------------- | ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- |
| `id`                        | `prod_…` ID                                                                                            |                                                                                   |
| `object`                    | `"product"`                                                                                            |                                                                                   |
| `brandId`                   | `brd_…` ID                                                                                             |                                                                                   |
| `livemode`                  | boolean                                                                                                |                                                                                   |
| `name`                      | string                                                                                                 |                                                                                   |
| `description`               | string or null                                                                                         |                                                                                   |
| `taxCategoryId`             | one of 9 values, e.g. `electronically_supplied_service`, `saas`, `ebook` (all in the OpenAPI document) |                                                                                   |
| `kind`                      | one of `standard`, `plan`                                                                              |                                                                                   |
| `entitlements`              | array of object                                                                                        |                                                                                   |
| `entitlements[].featureKey` | string                                                                                                 |                                                                                   |
| `entitlements[].value`      | boolean or number or string                                                                            |                                                                                   |
| `lifetimeEntitlements`      | boolean                                                                                                | A one-time purchase of the product grants its entitlements for good (spec §36.1). |
| `displayOrder`              | integer or null                                                                                        |                                                                                   |
| `highlighted`               | boolean                                                                                                |                                                                                   |
| `active`                    | boolean                                                                                                |                                                                                   |
| `images`                    | array of string                                                                                        |                                                                                   |
| `metadata`                  | object                                                                                                 |                                                                                   |
| `createdAt`                 | date-time                                                                                              |                                                                                   |
| `updatedAt`                 | date-time                                                                                              |                                                                                   |

## Examples

### Raise the seat limit

```http
PATCH /api/v1/products/prod_01m4tx5nj8emwbyf7y9vcf47y0
Authorization: Bearer or_test_…
Content-Type: application/json

{
  "entitlements": [
    {
      "featureKey": "seats.max",
      "value": 25
    },
    {
      "featureKey": "feature.export",
      "value": true
    }
  ]
}
```

Response (`200`):

```json
{
  "id": "prod_01m4tx5nj8emwbyf7y9vcf47y0",
  "object": "product",
  "brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4",
  "livemode": false,
  "name": "Pro",
  "description": "For growing teams.",
  "taxCategoryId": "saas",
  "kind": "plan",
  "entitlements": [
    {
      "featureKey": "seats.max",
      "value": 25
    },
    {
      "featureKey": "feature.export",
      "value": true
    }
  ],
  "lifetimeEntitlements": false,
  "displayOrder": 2,
  "highlighted": true,
  "active": true,
  "images": [],
  "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         | No field to change was sent, or one is malformed.                   | Fix the fields listed in `details.issues` and send the request again.                                                           |
| [`feature_not_found`](https://ownrecord.io/docs/reference/errors.md#feature_not_found)                 | 400         | An entitlement names a feature the brand doesn't have in this mode. | Create the feature first (`features.create`), or fix the feature key.                                                           |
| [`entitlement_value_invalid`](https://ownrecord.io/docs/reference/errors.md#entitlement_value_invalid) | 400         | An entitlement value doesn't fit its feature's type.                | Use true or false for boolean features, a whole number of 0 or more for limits, and one of the listed values for enum features. |
| [`resource_not_found`](https://ownrecord.io/docs/reference/errors.md#resource_not_found)               | 404         | No product 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         | The product 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_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).
