---
title: "Update subscription custom fields"
method: PUT
path: "/v1/subscriptions/{subscriptionNumber}/customFields"
tags: ["Orders"]
---

# Update subscription custom fields

`PUT /v1/subscriptions/{subscriptionNumber}/customFields`

**Note:** This operation is only available if you have the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature enabled. If you are an existing Zuora <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Subscribe_and_Amend" target="_blank">Subscribe and Amend</a> customer, we recommend you enable <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/A_Overview_of_Orders_Harmonization" target="_blank">Orders Harmonization</a> to access the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders/AA_Overview_of_Orders/A_Overview_of_Orders" target="_blank">Orders</a> feature. With Orders, you can access both existing functions for subscription and billing management and the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Subscriptions/Orders_Harmonization/P_FAQ_about_Orders_Harmonization#New+features+through+Orders" target="_blank">new features</a> on Zuora Billing.

Updates the custom fields of a specified subscription.

## Path parameters

- `subscriptionNumber` 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

- PUTSubscriptionPatchRequestType
  - `customFields` SubscriptionObjectCustomFields — Container for custom fields of a Subscription object.
  - `ratePlans` object[]
    - `charges` object[]
      - `chargeId` string — Use either this field or the `chargeNumber` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify a specific charge segment of a charge. See <a href="https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges" target="_blank">Segmented rate plan charges</a> for more information about charge segments.
      - `chargeNumber` string — Use either this field or the `chargeId` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify the last charge segment of a charge. See <a href="https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges" target="_blank">Segmented rate plan charges</a> for more information about charge segments.
      - `customFields` RatePlanChargeObjectCustomFields — Container for custom fields of a Rate Plan Charge object.
    - `customFields` OrdersRatePlanObjectCustomFields — Container for custom fields of the Rate Plan object. The custom fields of the Rate Plan object are used when rate plans are subscribed.
    - `ratePlanId` string — The rate plan id in any version of the subscription. This will be linked to the only one rate plan in the current version.

## 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/702f3caf3985/schema)