---
title: "Update order custom fields"
method: PUT
path: "/v1/orders/{orderNumber}/customFields"
tags: ["Orders"]
---

# Update order custom fields

`PUT /v1/orders/{orderNumber}/customFields`

**Note:** This feature is only available if you have the [Order Metrics](https://docs.zuora.com?resourceId=billing-order-metrics) feature enabled. As of Zuora Billing Release 284, Orders is generally available and the Order Metrics feature is no longer available as a standalone feature. If you are an existing Subscribe and Amend customer and want Order Metrics only, you must turn on [Orders Harmonization](https://docs.zuora.com?resourceId=billing-orders-harmonization). You can still keep the existing Subscribe and Amend API integrations to create and manage subscriptions.

**Note:** To update the custom fields of an order line item, you must use the "Update an order line item" or "Update order line items" operation.

Updates the custom fields of a specified order.

## Path parameters

- `orderNumber` string, string, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Request body

- PUTOrderPatchRequestType
  - `customFields` OrderObjectCustomFields — Container for custom fields of an Order object.
  - `subscriptions` object[]
    - `orderActions` object[]
      - `customFields` OrderActionObjectCustomFields — Container for custom fields of an Order Action object.
      - `orderActionId` string — The Id of the order action in the order. You can provide either the `sequence` or the `orderActionId` field to specify which order action to update. You cannot use then both at the same time.
      - `sequence` integer — The sequence number of the order action in the order. You can provide either the `sequence` or the `orderActionId` field to specify which order action to update. You cannot use then both at the same time.
    - `subscriptionNumber` string

## Response `200`

OK

- CommonResponse
  - `processId` string — The ID of the process that handles the operation.
  - `reasons` object[] — The container of the error code and message. This field is available only if the `success` field is `false`.
    - `code` string — The error code of response.
    - `message` string — The detail information of the error response
  - `requestId` string, uuid — Unique identifier of the request.
  - `success` boolean — Indicates whether the call succeeded.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)