Orders - update subscription rate plan
This reference article lists all the fields associated with the Orders - Update Subscription Rate Plan data dictionary.
Note: Fields with an asterisk mark indicate mandatory fields.
| Name | Description | Value |
|---|---|---|
| IsNewOrder | Marker Column | TRUE |
| Existing Account Number* | The account number that this order will be created under. | string <= 70 characters |
| Order Date* | The date the order is signed. If the contract effective date field is skipped or its value is left as null, all the order actions under this order will use this order date as the contract effective date. | string <date> |
| IsNewSubscription | Marker Column | IsMarker Column : New object begins |
| Subscriptions Subscription Number* | Subscription number of the subscription. For example, A-S00000001. If you do not set this field, Zuora will generate the subscription number. | string <= 100 characters |
| IsNewSubscriptionOrderAction | Marker Column | IsMarker Column : New object begins |
| Subscriptions Order Actions Change Plan Rate Plan Id* | ID of the rate plan to remove. This can be the latest version or any history version of ID. Note that the removal of a rate plan through the Change Plan order action supports the function of removal before future-dated removals, as in a Remove Product order action. | string |
| Subscriptions Order Actions Change Plan Reset Bcd | Default: false If resetBcd is true then reset the Account BCD to the effective date; if it is false keep the original BCD. | boolean |
| Subscriptions Order Actions Change Plan New Product Rate Plan Product Rate Plan Id* | ID of the product rate plan that the removed rate plan is based on. | string |
| IsNewSubscriptionOrderActioncreateChangePlanratePlanRatePlanCharge | Marker Column | IsMarker Column : New object begins |
| Subscriptions Order Actions Change Plan New Product Rate Plan Charge Overrides Product Rate Plan Charge Id* | Internal identifier of the product rate plan charge that the charge is based on. | string |
| IsNewSubscriptionOrderActionTriggerDate | Marker Column | IsMarker Column : New object begins |
| Subscriptions Order Actions Trigger Dates Name | Name of the trigger date of the order action. Enum: "ContractEffective" "ServiceActivation" "CustomerAcceptance" | string |
| Subscriptions Order Actions Trigger Dates Trigger Date | Trigger date in YYYY-MM-DD format. | string <date> |
| Scheduling Options Scheduled Date | The date for the scheduled order. | string <date> |
| Scheduling Options Scheduled Date Policy | The policy that determines the date for a scheduled order. | SpecificDate |