# Update a customer

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

Changes a customer's email, name, business name, declared type, language, billing address or metadata. Send
only the fields to change; `null` removes an optional one. `billingAddress` and `metadata` are replaced as a
whole.

The type is inferred again (spec §13.1). Tax IDs have their own operations (`customers.tax_ids.add`,
`customers.tax_ids.delete`), and the locked tax country changes only through payments (spec §9.3). A changed
billing address is used as evidence at the next checkout; it doesn't change where past sales were taxed.

Emits `customer.updated` with the old values in `previous_attributes` (nothing when nothing changed).

## At a glance

- **REST:** `PATCH /api/v1/customers/{id}`
- **MCP tool:** `customers_update`
- **Operation ID:** `customers.update`
- **Scope:** Brand
- **Permission:** `customers: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 `customers:write` scope
- **Since:** M4

## Request

### Path parameters

| Field | Type       | Description                  |
| ----- | ---------- | ---------------------------- |
| `id`  | `cus_…` ID | The customer's ID (`cus_…`). |

### Body

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

| Field            | Type                                       | Required | Description                                                                                                                                                                                                       |
| ---------------- | ------------------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `email`          | string                                     | No       |                                                                                                                                                                                                                   |
| `name`           | string or null                             | No       | null removes it.                                                                                                                                                                                                  |
| `businessName`   | string or null                             | No       | null removes it.                                                                                                                                                                                                  |
| `type`           | one of `individual`, `business`, `unknown` | No       | What you say the customer is: `individual`, `business` (needs `businessName` or a tax ID) or `unknown`. The stored `type` is inferred: a tax ID that isn't rejected makes the customer a `business` (spec §13.1). |
| `locale`         | string or null                             | No       | null removes it.                                                                                                                                                                                                  |
| `billingAddress` | object or null                             | No       | Replaces the address; null removes it.                                                                                                                                                                            |
| `metadata`       | object                                     | No       | Replaces the metadata (send `{}` to clear it).                                                                                                                                                                    |

## Response

`200 OK` with a JSON object:

| Field                                      | Type                                                                  | Description                                                                                                                                                                                              |
| ------------------------------------------ | --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`                                       | `cus_…` ID                                                            |                                                                                                                                                                                                          |
| `object`                                   | `"customer"`                                                          |                                                                                                                                                                                                          |
| `livemode`                                 | boolean                                                               |                                                                                                                                                                                                          |
| `entityId`                                 | `ent_…` ID                                                            |                                                                                                                                                                                                          |
| `brandId`                                  | `brd_…` ID                                                            |                                                                                                                                                                                                          |
| `email`                                    | string                                                                |                                                                                                                                                                                                          |
| `name`                                     | string or null                                                        |                                                                                                                                                                                                          |
| `businessName`                             | string or null                                                        |                                                                                                                                                                                                          |
| `locale`                                   | string or null                                                        |                                                                                                                                                                                                          |
| `type`                                     | one of `individual`, `business`, `unknown`                            | Inferred (spec §13.1): `business` with a tax ID that isn't rejected, or with a business name when declared a business. Tax is decided per sale: only a `valid` tax ID makes a sale business-to-business. |
| `declaredType`                             | one of `individual`, `business`, `unknown`                            | What you declared.                                                                                                                                                                                       |
| `billingAddress`                           | object or null                                                        |                                                                                                                                                                                                          |
| `taxIds`                                   | array of object                                                       |                                                                                                                                                                                                          |
| `taxIds[].id`                              | string                                                                | Identifies the tax ID on the customer: its canonical number, e.g. `ATU12345678`.                                                                                                                         |
| `taxIds[].type`                            | string                                                                | `eu_vat`, `gb_vat`, `ch_uid`/`ch_vat`, `no_org`/`no_vat`, `us_ein`, or another type (unverified).                                                                                                        |
| `taxIds[].value`                           | string                                                                | The number as given.                                                                                                                                                                                     |
| `taxIds[].country`                         | string                                                                |                                                                                                                                                                                                          |
| `taxIds[].number`                          | string or null                                                        | The canonical number (null for types Ownrecord can't check).                                                                                                                                             |
| `taxIds[].verification`                    | object                                                                | The latest check (spec §9.4).                                                                                                                                                                            |
| `taxIds[].verification.status`             | one of `valid`, `invalid`, `unavailable`, `format_only`, `unverified` | `valid`, `invalid`, `unavailable` (the register couldn't answer), `format_only` (no register: format and checksum) or `unverified` (a type Ownrecord can't check).                                       |
| `taxIds[].verification.source`             | string                                                                | Who decided: VIES, HMRC, CH_UID, FORMAT (format and checksum only) or NONE.                                                                                                                              |
| `taxIds[].verification.reason`             | string or null                                                        | Why, e.g. `not_registered` or `service_unavailable`.                                                                                                                                                     |
| `taxIds[].verification.checkedAt`          | date-time                                                             |                                                                                                                                                                                                          |
| `taxIds[].verification.consultationNumber` | string or null                                                        | The register's proof of the check (VIES request identifier, HMRC consultation number).                                                                                                                   |
| `taxIds[].verification.simulated`          | boolean                                                               | A fixture answer (development and test environments), not a register's.                                                                                                                                  |
| `taxIds[].history`                         | array of object                                                       | Earlier checks, newest first (at most 10).                                                                                                                                                               |
| `taxIds[].history[].status`                | one of `valid`, `invalid`, `unavailable`, `format_only`, `unverified` | `valid`, `invalid`, `unavailable` (the register couldn't answer), `format_only` (no register: format and checksum) or `unverified` (a type Ownrecord can't check).                                       |
| `taxIds[].history[].source`                | string                                                                | Who decided: VIES, HMRC, CH_UID, FORMAT (format and checksum only) or NONE.                                                                                                                              |
| `taxIds[].history[].reason`                | string or null                                                        | Why, e.g. `not_registered` or `service_unavailable`.                                                                                                                                                     |
| `taxIds[].history[].checkedAt`             | date-time                                                             |                                                                                                                                                                                                          |
| `taxIds[].history[].consultationNumber`    | string or null                                                        | The register's proof of the check (VIES request identifier, HMRC consultation number).                                                                                                                   |
| `taxIds[].history[].simulated`             | boolean                                                               | A fixture answer (development and test environments), not a register's.                                                                                                                                  |
| `taxIds[].addedAt`                         | date-time                                                             |                                                                                                                                                                                                          |
| `taxCountryLocked`                         | object or null                                                        | Where the customer's purchases are taxed (spec §9.3): set at the first successful payment, moved only when a top-up's evidence resolves to another country.                                              |
| `taxExempt`                                | object or null                                                        | Tax exemption (spec §9.5). Not applied yet: exemption certificates come in a later release.                                                                                                              |
| `processorRefs`                            | array of object                                                       | The customer at each payment processor used (set by checkout).                                                                                                                                           |
| `processorRefs[].processorConnectionId`    | `pcon_…` ID                                                           |                                                                                                                                                                                                          |
| `processorRefs[].customerRef`              | string                                                                |                                                                                                                                                                                                          |
| `risk`                                     | object                                                                |                                                                                                                                                                                                          |
| `risk.level`                               | one of `normal`, `elevated`, `blocked`                                |                                                                                                                                                                                                          |
| `risk.reasons`                             | array of string                                                       |                                                                                                                                                                                                          |
| `risk.firstPaymentAt`                      | date-time or null                                                     |                                                                                                                                                                                                          |
| `risk.totalPaid`                           | money                                                                 |                                                                                                                                                                                                          |
| `portalLastLoginAt`                        | date-time or null                                                     |                                                                                                                                                                                                          |
| `testClockId`                              | `clk_…` ID or null                                                    | Test mode: the test clock the customer was created on (spec §16.13).                                                                                                                                     |
| `metadata`                                 | object                                                                |                                                                                                                                                                                                          |
| `createdAt`                                | date-time                                                             |                                                                                                                                                                                                          |
| `updatedAt`                                | date-time                                                             |                                                                                                                                                                                                          |
| `deletedAt`                                | date-time or null                                                     | When the customer was deleted (soft delete); null while active.                                                                                                                                          |

## Examples

### Set the language and the full address

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

{
  "locale": "de-DE",
  "billingAddress": {
    "line1": "Torstraße 5",
    "city": "Berlin",
    "postalCode": "10119",
    "country": "DE"
  }
}
```

Response (`200`):

```json
{
  "id": "cus_01m4ty3c2b5qx7mhd9k8w6s0ab",
  "object": "customer",
  "livemode": false,
  "entityId": "ent_01m4tx5nj8emwbyf7y9vcf47x2",
  "brandId": "brd_01m4tx5nj8emwbyf7y9vcf47x4",
  "email": "ana@example.com",
  "name": "Ana Schmidt",
  "businessName": null,
  "locale": "de-DE",
  "type": "individual",
  "declaredType": "individual",
  "billingAddress": {
    "line1": "Torstraße 5",
    "line2": null,
    "city": "Berlin",
    "postalCode": "10119",
    "region": null,
    "country": "DE"
  },
  "taxIds": [],
  "taxCountryLocked": {
    "country": "DE",
    "subdivision": null,
    "lockedAt": "2026-10-14T09:30:00.000Z",
    "evidenceSetId": "evs_01m4ty3c2b5qx7mhd9k8w6s0ac"
  },
  "taxExempt": null,
  "processorRefs": [
    {
      "processorConnectionId": "pcon_01m4ty3c2b5qx7mhd9k8w6s0af",
      "customerRef": "cus_QxY12AbC"
    }
  ],
  "risk": {
    "level": "normal",
    "reasons": [],
    "firstPaymentAt": "2026-10-14T09:30:00.000Z",
    "totalPaid": {
      "amount": "119000000",
      "currency": "EUR"
    }
  },
  "portalLastLoginAt": null,
  "testClockId": null,
  "metadata": {},
  "createdAt": "2026-10-14T09:00:00.000Z",
  "updatedAt": "2026-10-14T09:30:00.000Z",
  "deletedAt": null
}
```

## Errors

| Code                                                                                         | HTTP status | When                                                                                                                       | What to do                                                                                                                                                                  |
| -------------------------------------------------------------------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`validation_failed`](https://ownrecord.io/docs/reference/errors.md#validation_failed)       | 400         | Nothing to change, a field is malformed, or the customer would be a declared business without a business name or a tax ID. | Fix the fields listed in `details.issues` and send the request again.                                                                                                       |
| [`resource_not_found`](https://ownrecord.io/docs/reference/errors.md#resource_not_found)     | 404         | This brand has no such customer in this mode (customers belong to one brand and one mode).                                 | Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.                                                                        |
| [`customer_deleted`](https://ownrecord.io/docs/reference/errors.md#customer_deleted)         | 400         | The customer was deleted.                                                                                                  | Create a new customer for this buyer. Deleted customers stay readable for the records they belong to, but can't be changed.                                                 |
| [`customer_email_taken`](https://ownrecord.io/docs/reference/errors.md#customer_email_taken) | 409         | Another active customer of the brand has the new email address in this mode.                                               | Use the existing customer (`details.customer_id`, or `customers.list` with `email`), or give this customer another address. A deleted customer's address can be used again. |
| [`version_conflict`](https://ownrecord.io/docs/reference/errors.md#version_conflict)         | 409         | The customer changed at the same moment; retry.                                                                            | Fetch the object again and retry the change.                                                                                                                                |
| [`scope_required`](https://ownrecord.io/docs/reference/errors.md#scope_required)             | 400         | The request names no brand (an org or entity key without `Ownrecord-Brand`).                                               | Call the operation with credentials or a target at its level: an organization, a legal entity, a brand or the platform (`details.required_scope`).                          |
| [`livemode_not_allowed`](https://ownrecord.io/docs/reference/errors.md#livemode_not_allowed) | 403         | You have no live-mode access, so you can't act on live customers.                                                          | Use test mode, or credentials for the target's mode. Developers need live access granted by an organization owner or admin.                                                 |
| [`permission_denied`](https://ownrecord.io/docs/reference/errors.md#permission_denied)       | 403         | You can't change this brand's customers (`customers:write`: owners, admins and support).                                   | 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), [`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).
