Welcome to Zuora Product Documentation

Explore our rich library of product information

Update custom fields on subscription version

This referece article lists all the fields associated with the Update Custom Fields on Subscription Version data dictionary.

Note: Fields with an asterisk mark indicate mandatory fields.
ObjectField NameValueRequired to UpdateDescription
SubscriptionIsNewSubscriptionTrue or FalseThis field is required when updating custom fields on a specifc version of Subscription.Indicator Column marking the start of a new object
SubscriptionSubscription Number*string <string>Required for updating the custom fields.The subscription number to be updated.
SubscriptionVersion*string <string>Required for updating the custom fields.The subscription version to be updated.
Rate PlanIsNewRatePlanTrue or FalseThis field is required when updating custom fields on a rate plan charge.Indicator Column marking the start of a new object.
Rate PlanRate Plans Rate Plan Id*stringThis field is required when updating custom fields on a rate plan charge.The rate plan id in any version of the subscription. This will be linked to the only one rate plan in the current version.
Rate Plan ChargeIsNewRatePlanRatePlanChargeTrue or FalseThis field is required when updating custom fields on a rate plan charge.Indicator Column marking the start of a new object.
Rate Plan ChargeRate Plans Charge Charge Id*stringThis field is required when updating custom fields on a rate plan charge.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.
Rate Plan ChargeRate Plans Charge Charge Number*stringThis field is required when updating custom fields on a rate plan charge.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.