Advance multi action orders - data dictionary

This document provides a comprehensive list of fields associated with the Advance Multi-Action data dictionary, and the template allows customization of CSV files.

The Zuora Data Loader Advance Multi Action Template template offers flexibility, allowing you to tailor the CSV file to your specific business requirements.

The following table explains the accounting code data dictionary details. Fields with an asterisk mark (*) indicate mandatory fields.

For easy access, you can download this Data dictionary for Advance Multi Action Orders in a CSV format - Advance Multi Action Orders Data Dictionary.csv


Object	Applicable Actions/Charges	Field Name	Value	Required to Create	Description
Orders	Marker Column	IsNewOrder	True or False	Required when creating new order ,Enter the value as 'True' if applicable; otherwise the value as FALSE,the cell can be left blank	Indicator Column marking the start of a new object
Orders	Orders	Existing Account Number*	string <= 70 characters	Required for creating Order	The account number that this order will be created under.
Orders	Orders	Order Date*	string <date>	Required for creating Order	The date when the order is signed. All the order actions under this order will use this order date as the contract effective date if the contract effective date field is skipped or its value is left as null. Dae format is YYYY-mm-dd
Orders	Orders	Category	string	Optional	Default: "NewSales" Category of the order to indicate a product sale or return. Default value is NewSales. Enum: "NewSales" "Return"
Orders	Orders	Description	string <= 500 characters	Optional	A description of the order.
Orders	Orders	Externally Managed By	string	Optional	An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores. Enum: "Amazon" "Apple" "Google" "Roku"
Orders	Orders	Order Number	string <= 100 characters	Optional	The order number of the new order. If not provided, system will auto-generate a number for this order. Note: Make sure the order number does not contain a slash .
Orders	Orders	Reason Code	string <= 255 characters	Optional	Values of reason code configured in Billing Settings > Configure Reason Codes through Zuora UI. Indicates the reason when a return order line item occurs.
Orders	Orders	Status	string	Optional	The status of the order. The default value is Completed. The following values are supported: Draft: The order is in draft status. Pending: The order is in pending status. Completed: The order is in completed status. Scheduled: The order is in scheduled status and it is only valid if the Scheduled Orders feature is enabled. Executing: The scheduled order is executed by a scheduler and it is only valid if the Scheduled Orders feature is enabled. Failed: The scheduled order has failed. Enum: "Draft" "Pending" "Completed" "Scheduled" "Executing" "Failed"
Array of objects (CreateOrderOrderLineItem)	Marker Column	IsNewOrderLineItem	True or False	Required as 'True' when creating a new order Line Item, otherwise False or can be left blank	The Order Line Items feature is now generally available to all Zuora customers. You need to enable the Orders feature to access the Order Line Items feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on Orders will have the Order Line Items feature enabled by default.
Order	Order Line Item	OLI Accounting Code	string	Optional	The accounting code for the Order Line Item.
Order	Order Line Item	OLI Amount Per Unit	number	Optional	The actual charged amount per unit for the Order Line Item. If you set the inlineDiscountType, inlineDiscountPerUnit, and listPricePerUnit fields, the system will automatically generate the amountPerUnit field. You shall not set the amountPerUnit field by yourself.
Order	Order Line Item	OLI Bill Target Date	string <date>	Optional	The target date for the Order Line Item to be picked up by bill run for billing.
Order	Order Line Item	OLI Bill To	string	Optional	The ID of the bill-to contact of an order line item. Specify an existing contact under the billing account as the bill-to contact of the order line item. The billing account is the order account.
Order	Order Line Item	OLI Billing Rule	string	Optional	Default: "TriggerWithoutFulfillment" The billing rule for the Order Line Item. Enum: "TriggerWithoutFulfillment" "TriggerAsFulfillmentOccurs"
Order	Order Line Item	OLI Deferred Revenue Accounting Code	string	Optional	The deferred revenue accounting code for the Order Line Item.
Order	Order Line Item	OLI Description	string <= 500 characters	Optional	The description of the Order Line Item.
Order	Order Line Item	OLI Exclude Item Billing From Revenue Accounting	boolean	Optional	Default: false The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. Note: This field is only available if you have the Order to Revenue or Zuora Billing - Revenue Integration feature enabled.
Order	Order Line Item	OLI Exclude Item Booking From Revenue Accounting	boolean	Optional	Default: false The flag to exclude Order Line Item from revenue accounting. Note: This field is only available if you have the Order to Revenue or Zuora Billing - Revenue Integration feature enabled.
Order	Order Line Item	OLI Inline Discount Per Unit	number	Optional	Use this field in accordance with the inlineDiscountType field, in the following manner: If the inlineDiscountType field is set as Percentage, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify 5 in this field, the discount percentage is 5%. If the inlineDiscountType field is set as FixedAmount, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify 10 in this field, the discount amount on each unit of the order line item is 10. Once you set the inlineDiscountType, inlineDiscountPerUnit, and listPricePerUnit fields, the system will automatically generate the amountPerUnit field.
Order	Order Line Item	OLI Inline Discount Type	string	Optional	Use this field to specify the inline discount type, which can be Percentage, FixedAmount, or None. The default value is Percentage. Use this field together with the inlineDiscountPerUnit field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item. Once you set the inlineDiscountType, inlineDiscountPerUnit, and listPricePerUnit fields, the system will automatically generate the amountPerUnit field. You shall not set the amountPerUnit field by yourself. Enum: "Percentage" "FixedAmount" "None"
Order	Order Line Item	OLI Item Category	string	Optional	Default: "Sales" The category for the Order Line Item, to indicate a product sale or return. Enum: "Sales" "Return"
Order	Order Line Item	OLI Item Name	string	Optional	The name of the Order Line Item.
Order	Order Line Item	OLI Item Number	string	Optional	The number of the Order Line Item. Use this field to specify a custom item number for your Order Line Item. If you are to use this field, you must set all the item numbers in an order when there are several order line items in the order.
Order	Order Line Item	OLI Item State	string	Optional	The state of an Order Line Item. If you want to generate billing documents for order line items, you must set this field to SentToBilling. For invoice preview, you do not need to set this field. See State transitions for an order, order line item, and fulfillment for more information. Enum: "Executing" "Booked" "SentToBilling" "Complete" "Cancelled"
Order	Order Line Item	OLI Item Type	string	Optional	The type of the Order Line Item. Enum: "Product" "Fee" "Services"
Order	Order Line Item	OLI List Price Per Unit	number	Optional	The list price per unit for the Order Line Item.
Order	Order Line Item	OLI Original Order Line Item Number	string	Optional	The number of the original sale order line item for a return order line item.
Order	Order Line Item	OLI Original Order Number	string	Optional	The number of the original sale order for a return order line item.
Order	Order Line Item	OLI Owner Account Number	string	Optional	Use this field to assign an existing account as the owner of an order line item.
Order	Order Line Item	OLI Product Code	string	Optional	The product code for the Order Line Item.
Order	Order Line Item	OLI Product Rate Plan Charge Id	string	Optional	Id of a Product Rate Plan Charge. Only one-time charges are supported.
Order	Order Line Item	OLI Purchase Order Number	string	Optional	Used by customers to specify the Purchase Order Number provided by the buyer.
Order	Order Line Item	OLI Quantity	number	Optional	The quantity of units, such as the number of authors in a hosted wiki service.
Order	Order Line Item	OLI Recognized Revenue Accounting Code	string	Optional	The recognized revenue accounting code for the Order Line Item.
Order	Order Line Item	OLI Related Subscription Number	string	Optional	string Use this field to relate an order line item to a subscription when you create the order line item. To relate an order line item to a new subscription which is yet to create in the same "Create an order" call, use this field in combination with the subscriptions > subscriptionNumber field in the "Create an order" operation. Specify this field to the same value as that of the subscriptions > subscriptionNumber field when you make the "Create an order" call. To relate an order line item to an existing subscription, specify this field to the subscription number of the existing subscription.
Order	Order Line Item	OLI Revenue Recognition Rule	string	Optional	The Revenue Recognition rule for the Order Line Item
Order	Order Line Item	OLI Sequence Set Id	string <= 200 characters	Optional	Specifies the type of revenue recognition timing. Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the revenue recognition policy configuration in the Zuora Billing UI. Note: This field is only available if you have the Order to Revenue feature enabled. Enum: "Upon Billing Document Posting Date" "Upon Order Activation Date".
Order	Order Line Item	OLI Sold To	string	Optional	Use this field to assign an existing account as the sold-to contact of an order line item, by the following rules: If the ownerAccountNumber field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item. If the ownerAccountNumber field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item. The billing account is the order account.
Order	Order Line Item	OLI Tax Code	string	Optional	The tax code for the Order Line Item.
Order	Order Line Item	OLI Tax Mode	string	Optional	The tax mode for the Order Line Item. Enum: "TaxInclusive" "TaxExclusive"
Order	Order Line Item	OLI Transaction End Date	string <date>	Optional	The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the transactionStartDate field.
Order	Order Line Item	OLI Transaction Start Date	string <date>	Optional	The date a transaction starts. The default value of this field is the order date.
Order	Order Line Item	OLI Unbilled Receivable Accounting Code	string	Optional	The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration.
Order	Order Line Item	OLI Unit of measure	string	Optional	Specifies the units to measure usage.
The container for billing processing options and payment processing options.				Optional
Order	Processing Options			Optional	This field is not supported in draft orders. When you use the "Create an order" operation to create an account, create a subscription, run billing, and collect payment in a single call, if any error occurs during the call, such as a payment processing failure and a tax engine failure, then all the other steps will be rolled back. In this case, neither the invoice will be generated, nor the subscription nor the account will be created. When you use the "Create an order" operation to cancel a subscription with refund and writeOff, if the refund or writeOff fails, cancelSubscription, runBilling, and collectPayment still can succeed. When you use the "Create an order" operation, the collectPayment and refund fields cannot be set to true simultaneously. Otherwise, the order will not be proceeded.
Order	Processing Options	Processing Options Application Priority Order	Array of strings	Optional	The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: CreditMemo, UnappliedPayment. Note: This field is valid only if the applyCredit field is set to true. If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments. If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is ["CreditMemo"], only credit memos are used to apply to invoices.
Order	Processing Options	Processing Options Apply Credit Balance	boolean	Optional	Whether to automatically apply credit memos or unapplied payments, or both to an invoice. If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices. Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement.
Order	Processing Options	Processing Options Collect Payment	boolean	Optional	Indicates if the current request needs to collect payments. This value can not be 'true' when 'runBilling' flag is 'false'
Order	Processing Options	Processing Options Refund	boolean	Optional	Indicates whether to refund after subscription cancellation. Default is false. Note: When refunding a subscription that is not invoiced separately, if you do not enable the Invoice Item Settlement feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.”
Order	Processing Options	Processing Options Refund Amount	number	Optional	Indicates the amount to be refunded. Required if the refund field is true.
Order	Processing Options	Processing Options Refund Reason Code	string	Optional	A code identifying the reason for the refund transaction. The value must be an existing payment refund reason code listed in Payments Settings > Configure Reason Codes. If you do not specify the field or leave the field with an empty value, Zuora uses the default payment refund reason code.
Order	Processing Options	Processing Options Run Billing	boolean	Optional	Indicates if the current request needs to generate an invoice. The invoice will be generated against all subscriptions included in this order.
Order	Processing Options	Processing Options Write Off	boolean	Optional	Indicates whether to write off the outstanding balance on the invoice after refund. Default is false. Note: When refunding a subscription that is not invoiced separately, if you do not enable the Invoice Item Settlement feature, you will encounter the following error during the cancel and refund process: “Cancellation/Refund failed because of the following reason: Invoice is linked to multiple subscriptions. Cancellation was not processed.” The Invoice Settlement feature must have been enabled for write-off. When this field is set to true, the generated credit memos have a reason code of Write-off and it cannot be overridden.
Order	Processing Options	Processing Options Billing Options Credit Memo Reason Code	string	Optional	A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.
Order	Processing Options	Processing Options Billing Options Document Date	string <date>	Optional	The invoice date displayed on the invoice.
Order	Processing Options	Processing Options Billing Options Generate Draft Invoice	boolean	Optional	Indicates if the current request needs to generate a draft invoice. Values are: true false (default)
Order	Processing Options	Processing Options Billing Options Target Date	string <date>	Optional	Date through which to calculate charges if an invoice is generated. See What is a Target Date? Note: If you do not specify this field, today's date is used by default.
Order	Processing Options	Processing Options Electronic Payment Options Auth Transaction Id	string <= 50 characters	Optional	The authorization transaction ID from the payment gateway. When you create a payment to capture the funds that have been authorized through Create authorization, pass in the authTransactionId field. It is highly recommended to also pass in gatewayOrderId that you used when authorizing the funds. authTransactionId is required, while gatewayOrderId is optional.
Order	Processing Options	Processing Options Electronic Payment Options Gateway Order Id	string <= 50 characters	Optional	A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead. Gateways check duplicates on the gateway order ID to ensure that the same transaction is not entered twice accidentally. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems. When you create a payment to capture the funds that have been authorized through Create authorization, pass in the authTransactionId field. It is highly recommended to also pass in gatewayOrderId that you used when authorizing the funds. authTransactionId is required, while gatewayOrderId is optional
Order	Processing Options	Processing Options Electronic Payment Options Payment Gateway Id	string	Optional	Specifies the ID of a payment gateway to override the default gateway. If Payment Gateway Routing is enabled: If this field is not specified, gateway routing rules will be invoked. If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. If this field is specified, the specified gateway will be used to process the payment.
Order	Processing Options	Processing Options Electronic Payment Options Payment Method Id	string	Optional	Specifies an electronic payment method. It can be one that has already been associated with an invoice owner, or an orphan payment method, which is not associated with any invoice owner. For an orphan payment method, this operation will then associate it with the account that this order will be created under.
Processing Options Write Off Behaviour-Container for the finance information related to the credit memo items that are created for invoice write-off.The financial information of the credit memo items generated to write off the invoice balance. Note: All the credit memo items that are used to write off the invoice will be applied with the same financial information. Credit memo items generated from the unconsumed services of the canceled subscription will not be applied with the finance information specified here.				Optional
Order>Processing Options	Write Off Behaviour	Processing Options Write Off Behaviour Finance Information Deferred Revenue Accounting Code	string [ 0 .. 100 ] characters	Optional	The accounting code for the deferred revenue, such as Monthly Recurring Liability.
Order>Processing Options	Write Off Behaviour	Processing Options Write Off Behaviour Finance Information On Account Accounting Code	string [ 0 .. 100 ] characters	Optional	The accounting code that maps to an on account in your accounting system.
Order>Processing Options	Write Off Behaviour	Processing Options Write Off Behaviour Finance Information Recognized Revenue Accounting Code	string [ 0 .. 100 ] characters	Optional	The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.
Order>Processing Options	Write Off Behaviour	Processing Options Write Off Behaviour Finance Information Revenue Recognition Rule Name	string [ 0 .. 100 ] characters	Optional	The name of the revenue recognition rule governing the revenue schedule.
Array of objects	Marker Column	IsNewSubscription	True or False	Required as 'True' when creating or updating a subscription , otherwise False or can be left blank	Each item includes a set of order actions, which will be applied to the same base subscription. When you create an order that includes changes to multiple existing subscriptions, these subscriptions can have different invoice owner accounts. However, creating multiple new subscriptions through the createSubscription order action with different invoice owner accounts is not supported.
Subscription	Subscription	Subscriptions Subscription Number	string	Required when updating a subscription	Leave this empty to represent new subscription creation. Specify a subscription number to update an existing subscription.
Array of objects (CreateOrderOrderAction)	Marker Column	IsNewOrderAction	True or False	Required as 'True' when creating a new OrderAction otherwise False or can be left blank	The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request.
Order>Subscription	Order Action	Order Actions Change Reason	string <= 255 characters		The change reason set for an order action when an order is created.
Order>Subscription	Order Action	Action Type*	string	Required for creating a new Order Action	Type of order action. Unless the type of order action is RenewSubscription, you must use the corresponding field to provide information about the order action. For example, if the type of order action is AddProduct, you must set the addProduct field. Zuora returns an error if you set a field that corresponds to a different type of order action. For example, if the type of order action is AddProduct, Zuora returns an error if you set the updateProduct field. A pending order can be created by the following order actions: Create new subscription Add product Update product Remove product Terms and conditions Renew subscription Note: The change plan type of order action is currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing. Enum: "CreateSubscription" "TermsAndConditions" "AddProduct" "UpdateProduct" "RemoveProduct" "RenewSubscription" "CancelSubscription" "OwnerTransfer" "Suspend" "Resume" "ChangePlan".
Order>Subscription>Order Action	Terms and Conditions	Action Auto Renew	boolean	Optional	Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is TERMED.
Order>Subscription>Order Action	Create Subscription, OwnerTransfer, Renew Subscription, Terms and Conditions	Action Bill To Contact Id	string	Optional	The ID of the bill-to contact associated with the subscription. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body. If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select Default Contact from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.
Order>Subscription>Order Action	Cancel Subscriptions	Action Cancellation Effective Date	string <date>	Optional
Order>Subscription>Order Action	Cancel Subscriptions	Action Cancellation Policy	string	Optional	Enum: "EndOfCurrentTerm" "EndOfLastInvoicePeriod" "SpecificDate"
Order>Subscription>Order Action	OwnerTransfer, Renew Subscription, Terms and Conditions	Action Clearing Existing Bill To Contact	boolean	Optional	Default: false Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the billToContactId field. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.
Order>Subscription>Order Action	Add Product, Update Product	Action Clearing Existing Features	boolean	Optional	Specifies whether all features in the rate plan will be cleared.
Order>Subscription>Order Action	OwnerTransfer, Renew Subscription, Terms and Condition	Action Clearing Existing Invoice Template	boolean	Optional	Default: false Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the invoiceTemplateId field. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.
Order>Subscription>Order Action	OwnerTransfer, Renew Subscription, Terms and Condition	Action Clearing Existing Payment Term	boolean	Optional	Default: false Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the paymentTerm field. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.
Order>Subscription>Order Action	OwnerTransfer, Renew Subscription, Terms and Condition	Action Clearing Existing Sequence Set	boolean	Optional	Default: false Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the sequenceSetId field. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.
Order>Subscription>Order Action	OwnerTransfer, Renew Subscription, Terms and Condition	Action Clearing Existing Sold To Contact	boolean	Optional	Default: false Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the soldToContactId field. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.
Order>Subscription>Order Action	Create Subscriptions	Action Currency Code	string <= 3 characters	Optional	The code of currency that is used for this subscription. If the currency is not selected, the default currency from the account will be used. All subscriptions in the same order must use the same currency. The currency for a subscription cannot be changed. Note: This field is available only if you have the Multiple Currencies feature enabled.
Order>Subscription>Order Action	OwnerTransfer	Action Destination Account Number	string	Optional	The account number of the account that the subscription is being transferred to
Order>Subscription>Order Action	OwnerTransfer	Action Destination Invoice Account Number	string	Optional	The account number of the invoice owner account that the subscription is being transferred to.
Order>Subscription>Order Action	Change Plan	Action Effective Policy	string	Optional	The default value for the effectivePolicy field is as follows: If the rate plan change (from old to new) is an upgrade, the effective policy is EffectiveImmediately by default. If the rate plan change (from old to new) is a downgrade, the effective policy is EffectiveEndOfBillingPeriod by default. Otherwise, the effective policy is SpecificDate by default. Note: When setting this field to EffectiveEndOfBillingPeriod, you cannot set the billing trigger dates for the subscription as the system will automatically set the trigger dates to the end of billing period, and you cannot set the following billing trigger date settings to Yes: Require Customer Acceptance of Orders? Require Service Activation of Orders? When setting this field to SpecificDate, you must also set the contract effective date in the triggerDates field as follows: Set the name field as ContractEffective Specify a date for the triggerDate field Enum: "EffectiveImmediately" "EffectiveEndOfBillingPeriod" "SpecificDate".
Order>Subscription>Order Action	Renew Subscription	Action Extends Term	boolean	Optional	Specifies whether to extend the subscription term by the length of time the suspension is in effect.
Order>Subscription>Order Action	Change Plan, Remove Product , Update Product	Action External Catalog Plan Id	string	Optional	An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the externalCatalogPlanId field must match one of the values that are predefined in the externallyManagedPlanIds field on a product rate plan. Note: If both externalCatalogPlanId and productRatePlanId are provided. They must point to the same product rate plan. Otherwise, the request would fail.
Order>Subscription>Order Action	Add product	Action Externally Managed Plan Id	string	Optional	Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
Order>Subscription>Order Action	Create Subscription, Terms and Conditions	Action Invoice Separately	boolean	Optional	Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.
Order>Subscription>Order Action	Create Subscription, Owner Transfer, Renew Subscription, Terms and Conditions	Action Invoice Template Id	string	Optional	The ID of the invoice template associated with the subscription. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body. If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select Default Template from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.
Order>Subscription>Order Action	Create Subscription	Action Notes	string <= 500 characters	Optional	Notes about the subscription. These notes are only visible to Zuora users.
Order>Subscription>Order Action	Create Subscription, Owner Transfer, Renew Subscription, Terms and Conditions	Action Payment Term	string	Optional	The name of the payment term associated with the subscription. For example, Net 30. The payment term determines the due dates of invoices. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body. If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select Default Term from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.
Order>Subscription>Order Action	Change Plan	Action Product Rate Plan Id	string	Optional	Internal identifier of the product rate plan that the rate plan is based on.
Order>Subscription>Order Action	Change Plan, Remove Product , Update Product	Action Product Rate Plan Number	string	Optional	Number of a product rate plan for this subscription.
Order>Subscription>Order Action	Change Plan, Remove Product , Update Product	Action Rate Plan Id	string	Optional	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.
Order>Subscription>Order Action	Terms and Conditions	Action Renewal Setting	string	Optional	Enum: "RENEW_WITH_SPECIFIC_TERM" "RENEW_TO_EVERGREEN"
Order>Subscription>Order Action	Change Plan	Action Reset Bcd	boolean	Optional	Default: false If resetBcd is true then reset the Account BCD to the effective date; if it is false keep the original BCD. Note: If the rate plan change is an upgrade (the subType field is Upgrade), then the effective policy is EffectiveImmediately by default. In this case, if you do not specify the resetBcd field, the system sets this field to true while BCD is the effective date.
Order>Subscription>Order Action	Resume Subscription	Action Resume Periods	integer	Optional	This field is applicable only when the resumePolicy field is set to FixedPeriodsFromToday or FixedPeriodsFromSuspendDate. It must be used together with the resumePeriodsType field. The total number of the periods used to specify when a subscription resumption takes effect. The subscription resumption will take place after the specified time frame (suspendPeriods multiplied by suspendPeriodsType) from today's date.
Order>Subscription>Order Action	Resume Subscription	Action Resume Periods Type	string	Optional	This field is applicable only when the resumePolicy field is set to FixedPeriodsFromToday or FixedPeriodsFromSuspendDate. It must be used together with the resumePeriods field. The period type used to specify when a subscription resumption takes effect. The subscription suspension will take place after the specified time frame (suspendPeriods multiplied by suspendPeriodsType) from today's date. Enum: "Day" "Week" "Month" "Year"
Order>Subscription>Order Action	Resume Subscription	Action Resume Policy	string	Required when creating record for Resume Subscription	Resume methods. Specify a way to resume a subscription. See Resume Date for more information. If SuspendDate is specfied, the resumption will take place on the same day as the suspension. Enum: "Today" "FixedPeriodsFromSuspendDate" "FixedPeriodsFromToday" "SpecificDate" "SuspendDate"
Order>Subscription>Order Action	Resume Subscription	Action Resume Specific Date	string <date>	Optional	This field is applicable only when the resumePolicy field is set to SpecificDate. A specific date when the subscription resumption takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription suspension date.
Order>Subscription>Order Action	Create Subscription, Owner Transfer, Renew Subscription, Terms and Conditions	Action Sequence Set Id	string or null	Optional	The ID of the sequence set associated with the subscription. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body. If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select Default Set from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.
Order>Subscription>Order Action	Create Subscription, Owner Transfer, Renew Subscription, Terms and Conditions	Action Sold To Contact Id	string	Optional	The ID of the sold-to contact associated with the subscription. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body. If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select Default Contact from Account for this field during subscription creation, the value of this field is automatically set to null in the response body.
Order>Subscription>Order Action	Change Plan	Action SubType	string	Optional	Use this field to choose the sub type for your change plan order action. However, if you do not set this field, the field will be automatically generated by the system according to the following rules: When the old and new rate plans are within the same Grading catalog group: If the grade of new plan is greater than that of the old plan, this is an "Upgrade". If the grade of new plan is less than that of the old plan, this is a "Downgrade". If the grade of new plan equals that of the old plan, this is a "Crossgrade". When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is "PlanChanged". Enum: "Upgrade" "Downgrade" "Crossgrade" "PlanChanged"
Order>Subscription>Order Action	Create Subscription	Action Subscription Number	string <= 100 characters	Optional	Subscription number of the subscription. For example, A-S00000001. If you do not set this field, Zuora will generate the subscription number.
Order>Subscription>Order Action	Create Subscription	Action Subscription Owner Account Number	string <= 70 characters	Optional	Account number of an existing account that will own the subscription. For example, A00000001. If you do not set this field or the newSubscriptionOwnerAccount field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the newSubscriptionOwnerAccount field.
Order>Subscription>Order Action	Add product, Change Plan, Remove Product , Update Product	Action Subscription Rate Plan Number	string <= 50 characters	Optional	Number of a subscription rate plan for this subscription.
Order>Subscription>Order Action	Suspend Subscription	Action Suspend Periods	integer	Optional	This field is applicable only when the suspendPolicy field is set to FixedPeriodsFromToday. It must be used together with the suspendPeriodsType field. The total number of the periods used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (suspendPeriods multiplied by suspendPeriodsType) from today's date.
Order>Subscription>Order Action	Suspend Subscription	Action Suspend Periods Type	string	Optional	This field is applicable only when the suspendPolicy field is set to FixedPeriodsFromToday. It must be used together with the suspendPeriods field. The period type used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (suspendPeriods multiplied by suspendPeriodsType) from today's date. Enum: "Day" "Week" "Month" "Year"
Order>Subscription>Order Action	Suspend Subscription	Action Suspend Policy	string	Required if creating record for suspending subscription	Suspend methods. Specify a way to suspend a subscription. See Suspend Date for more information. Enum: "Today" "EndOfLastInvoicePeriod" "FixedPeriodsFromToday" "SpecificDate"
Order>Subscription>Order Action	Suspend Subscription	Action Suspend Specific Date	string <date>	Optional	This field is applicable only when the suspendPolicy field is set to SpecificDate. A specific date when the subscription suspension takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription's contract effective date or later available versions than the subscription's term end date.
Order>Subscription>Order Action	Add Product, Remove Product , Update Product	Action Unique Token	string <= 50 characters	Optional	Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora. For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.
Array of objects (ratePlan) List of rate plans associated with the subscription	Marker Column	IsNewRatePlanSubscribeToRatePlans	True or False	Required as 'True' when creating a new subscription rate plan, otherwise False or can be left blank	List of rate plans associated with the subscription.
Order>Subscription>Order Action	Create Subscription>Rate Plan	Action Subscribe To / New Product Rate Plan Clearing Existing Features	boolean	Optional	Specifies whether all features in the rate plan will be cleared.
Order>Subscription>Order Action	Create Subscription>Rate Plan	Action Subscribe To / New Product Rate Plan External Catalog Plan Id	string	Optional	An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the externalCatalogPlanId field must match one of the values that are predefined in the externallyManagedPlanIds field on a product rate plan. Note: If both externalCatalogPlanId and productRatePlanId are provided. They must point to the same product rate plan. Otherwise, the request would fail.
Order>Subscription>Order Action	Create Subscription>Rate Plan	Action Subscribe To / New Product Rate Plan Externally Managed Plan Id	string	Optional	Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores.
Order>Subscription>Order Action	Create Subscription>Rate Plan	Action Subscribe To / New Product Rate Plan Product Rate Plan Id	string	Optional	Internal identifier of the product rate plan that the rate plan is based on.
Order>Subscription>Order Action	Create Subscription>Rate Plan	Action Subscribe To / New Product Rate Plan Product Rate Plan Number	string	Optional	Number of a product rate plan for this subscription.
Order>Subscription>Order Action	Create Subscription>Rate Plan	Action Subscribe To / New Product Rate Plan Unique Token	string <= 50 characters	Optional	Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora. For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the rate plan. Then when you update the product, you can use the same unique identifier to specify which rate plan to modify.
Order>Subscription>Order Action	Create Subscription>Rate Plan	Action Subscribe To / New Product Rate Plan Subscription Rate Plan Number	string <= 50 characters	Optional	Number of a subscription rate plan for this subscription.
Array of objects (ratePlanFeature)	Marker Column	IsNewSubscriptionProductFeatures	True or False	Required as 'True' when adding a new subscription product features otherwise False or can be left blank	List of features associated with the rate plan. The system compares the subscriptionProductFeatures and featureId fields in the request with the counterpart fields in a rate plan. The comparison results are as follows: If there is no subscriptionProductFeatures field or the field is empty, features in the rate plan remain unchanged. But if the clearingExistingFeatures field is additionally set to true, all features in the rate plan are cleared. If the subscriptionProductFeatures field contains the featureId nested fields, as well as the optional description and customFields nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.
Order>Subscription>Order Action	Create Subscription>Rate Plan>Product Features	Subscription Product Features Description	string <= 500 characters	Optional	A description of the feature.
Order>Subscription>Order Action	Create Subscription>Rate Plan>Product Features	Subscription Product Features Feature Id	string	Required when adding product Features to rate plans	Internal identifier of the feature in the product catalog.
Array of objects (charge)	Marker Column	IsNewCharge	True or False	Required as 'True' when adding rate plan charges to subscription rate plans otherwise False or can be left blank	List of charges associated with the rate plan.
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Charge Number	string <= 50 characters	Optional	Charge number of the charge. For example, C-00000307. If you do not set this field, Zuora will generate a charge number starting with a default prefix, for example, C-. This default prefix is predefined in Billing Settings > Define Default Subscription and Order Settings. If you want to use a custom charge number, do not use the default prefix predefined in Billing Settings > Define Default Subscription and Order Settings. Use your own prefix, for example, SC-.
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Description	string <= 500 characters	Optional	Description of the charge.
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Draw Down Rate	number	Optional	Note: This field is only available if you have the Prepaid with Drawdown feature enabled. The conversion rate between Usage UOM and Drawdown UOM for a drawdown charge. Must be a positive number (>0).
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Exclude Item Billing From Revenue Accounting	boolean	Optional	Default: false The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. If both the following features are enabled in your tenant, you must ensure the excludeItemBillingFromRevenueAccounting field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the excludeItemBookingFromRevenueAccounting field in a Create Subscription or Add Product order action is set to false, you must also set the excludeItemBillingFromRevenueAccounting field in this order action to false. Prepaid with Drawdown Unbilled Usage. Note: This field is only available if you have the Order to Revenue or Zuora Billing - Revenue Integration feature enabled.
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Exclude Item Booking From Revenue Accounting	boolean	Optional	Default: false The flag to exclude rate plan charges from revenue accounting. If both the following features are enabled in your tenant, you must ensure the excludeItemBookingFromRevenueAccounting field is set consistently for a prepayment charge and the corresponding drawdown charge. Prepaid with Drawdown Unbilled Usage Note: This field is only available if you have the Order to Revenue or Zuora Billing - Revenue Integration feature enabled.
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Is Rollover	boolean	Optional	This field is only available if you have the Prepaid with Drawdown feature enabled. The value is either "True" or "False". It determines whether the rollover fields are needed.
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Prepaid Quantity	number	Optional	This field is only available if you have the Prepaid with Drawdown feature enabled. The number of units included in a prepayment charge. Must be a positive number (>0).
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Product Rate Plan Charge Id	string	Required when associating the rate plan charge with product rate plan charge	Internal identifier of the product rate plan charge that the charge is based on.
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Product Rate Plan Charge Number	string	Optional	Number of a product rate-plan charge for this subscription.
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge RevRec Trigger Condition	string	Optional	Specifies the revenue recognition trigger condition. Contract Effective Date Service Activation Date Customer Acceptance Date Enum: "Contract Effective Date" "Service Activation Date" "Customer Acceptance Date"
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Revenue Recognition Code	string <= 70 characters	Optional	Revenue Recognition Code
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Revenue Recognition Rule Name	string	Optional	Specifies the revenue recognition rule, such as Recognize upon invoicing or Recognize daily over time
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Rollover Apply	string		This field is only available if you have the Prepaid with Drawdown feature enabled. This field defines the priority of rollover, which is either first or last. Enum: "ApplyFirst" "ApplyLast"
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Rollover Period Length	integer	Optional	Default: null: Note: This field is only available if you have the Prepaid with Drawdown feature enabled. Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the rolloverPeriods field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year.
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Rollover Periods	number	Optional	This field is only available if you have the Prepaid with Drawdown feature enabled. This field defines the number of rollover periods, it is restricted to 3.
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Unique Token	string <= 50 characters	Optional	Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora. For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Validity Period Type	string	Optional	This field is only available if you have enabled either of the following: Prepaid with Drawdown Minimum Commitment Both Minimum Commitment and Standalone Orders You can use this field in the following scenarios: When you create a prepayment charge, use this field to define the period in which the prepayment units are valid to use. When you override the setting of commitment true-up charge from the product catalog, set this field consistently with the value of the billing > billingPeriod field in this charge. When you use a standalone order to create a commitment true-up charge, set this field consistently with the value of the billing > billingPeriod field in this charge. Enum: "SUBSCRIPTION_TERM" "ANNUAL" "SEMI_ANNUAL" "QUARTER" "MONTH"
Order>Subscription>Order Action	Add Product>ChargeOverrides	Charge Type*	string	Required when creating rate plan charge	The chargeType of a standalone charge. Supported charge types: OneTime Recurring Usage Note: This field is available when the Standalone Orders feature is enabled.
Order>Subscription>Order Action	Add Product>ChargeOverrides>Pricing>Discount	Charge Apply Discount To	string	Optional	Specifies which type of charge the discount charge applies to. Enum: "ONETIME" "RECURRING" "USAGE" "ONETIMERECURRING" "ONETIMEUSAGE" "RECURRINGUSAGE" "ONETIMERECURRINGUSAGE"
Order>Subscription>Order Action	Add Product>ChargeOverrides>Pricing>Discount	Charge Apply To Billing Period Partially	boolean	Optional	Allow the discount duration to be aligned with the billing period partially. Note: You must enable the Enhanced Discounts feature to access this field.
Order>Subscription>Order Action	Add Product>ChargeOverrides>Pricing>Discount	Charge Discount Amount	number	Optional	Only applicable if the discount charge is a fixed-amount discount.
Order>Subscription>Order Action	Add Product>ChargeOverrides>Pricing>Discount	Charge Discount Class	string	Optional	The discount class defines the sequence in which discount product rate plan charges are applied. Note: You must enable the Enhanced Discounts feature to access this field.
Order>Subscription>Order Action	Add Product>ChargeOverrides>Pricing>Discount	Charge Discount Level	string	Optional	Application scope of the discount charge. For example, if the value of this field is subscription and the value of the applyDiscountTo field is RECURRING, the discount charge applies to all recurring charges in the same subscription as the discount charge. Enum: "rateplan" "subscription" "account"
Order>Subscription>Order Action	Add Product>ChargeOverrides>Pricing>Discount	Charge Discount Percentage	number	Optional	Only applicable if the discount charge is a percentage discount.
Subscription>Order Actions>Create Subscription>Rate Plan>Rate Plan Charge>Pricing		Charge Formula	string	Optional	The pricing formula to calculate actual rating amount. This field is only available for charges that use the Multi-Attribute Pricing charge model.
Order>Subscription>Order Action	Add Product>ChargeOverrides>Pricing>usageoverage	Charge Included Units		Optional
Order>Subscription>Order Action	Add Product>ChargeOverrides>Pricing>OnetimeFlatfee, onetimeperunit,usageflatfee,usageperunit	Charge List Price	number	Required for onetimeflatfee charge	Per-unit price of the charge.
Order>Subscription>Order Action		Charge List Price Base		Optional
Order>Subscription>Order Action	Add Product>ChargeOverrides>Pricing>usageoverage,usagetieredwithoverage	Charge Number Of Periods		Optional
Order>Subscription>Order Action	Add Product>ChargeOverrides>Pricing>Discount	Charge Original Discount Amount	number	Optional	The manufacturer's suggested retail discount price for standalone charge. Only applicable if the standalone discount charge is a fixed-amount discount. Note: This field is available when the Standalone Orders feature is enabled.
Order>Subscription>Order Action	Add Product>ChargeOverrides>Pricing>Discount	Charge Original Discount Percentage	number	Optional	The manufacturer's suggested retail discount percentage for standalone charge. Only applicable if the standalone discount charge is a percentage discount. Note: This field is available when the Standalone Orders feature is enabled.
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>OnetimeFlatFee,OneTimeTiered,Onetimevolume,usageflatfee,usageperunit	Charge Original List Price	number	Optional	The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer. Note: This field is not available for the usageVolume and usageTiered charges in Orders API.
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>usageoverage,usagetieredwithOverage	Charge Overage Price	number	Optional	Price per overage unit consumed.
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>usageoverage,usagetieredwithOverage	Charge Overage Unused Units Credit Option	string	Optional	Specifies whether to credit the customer for unused units. If the value of this field is CreditBySpecificRate, use the unusedUnitsCreditRates field to specify the rate at which to credit the customer for unused units. Enum: "NoCredit" "CreditBySpecificRate"
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>usageflatfee,usageoverage,usageperunit,usagetiered,usagetieredwithOverage,usageVolume	Charge Price Change Option	string	Optional	Specifies how Zuora changes the price of the charge each time the subscription renews. If the value of this field is SpecificPercentageValue, use the priceIncreasePercentage field to specify how much the price of the charge should change. Enum: "NoChange" "SpecificPercentageValue" "UseLatestProductCatalogPricing"
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>usageflatfee,usageoverage,usageperunit,usagetiered,usagetieredwithOverage,usageVolume	Charge Price Increase Percentage	number >= -100	Optional	Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the priceChangeOption field is SpecificPercentageValue.
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>Onetimeperunit,onetimetiered,onetimevolume	Charge Quantity	number >= 0	Optional	Number of units purchased.
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>usageperunit,usagetiered,usagevolume	Charge Rating Group	string	Optional	Specifies how Zuora groups usage records when rating usage. See Usage Rating by Group for more information. ByBillingPeriod (default): The rating is based on all the usages in a billing period. ByUsageStartDate: The rating is based on all the usages on the same usage start date. ByUsageRecord: The rating is based on each usage record. ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file. Enum: "ByBillingPeriod" "ByUsageStartDate" "ByUsageRecord" "ByUsageUpload"
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>Onetimeperunit,onetimetiered,onetimevolume,usageperunit,usagetiered,usagevolume	Charge Unit of measure	number	Optional	Unit of measure of the standalone charge. Note: This field is available when the Standalone Orders feature is enabled.
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>usageoverage,usagetieredwithOverage	Charge Unused Unit Credit Rates		Optional
Array of objects (chargeTier)	Marker Column	IsNewChargeTier	True or False	Required as 'True' when creating tiers on charges otherwise False or can be left blank	List of cumulative pricing tiers in the charge.
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>Tiers>Onetimeperunit,onetimetiered,onetimevolume,usagetiered,usagetieredwithOverage,usagevolume	Charge Tier Ending Unit	number	Optional	Limit on the number of units for which the tier is effective.
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>Tiers>Onetimeperunit,onetimetiered,onetimevolume,usagetiered,usagetieredwithOverage,usagevolume	Charge Tier Number	integer >= 1	Required for OneTimeTiered,OneTimeVolume,UsageTiered,UsagetieredwithOverage,usageVolume	Index of the tier in the charge.
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>Tiers>Onetimeperunit,onetimetiered,onetimevolume,usagetiered,usagetieredwithOverage,usagevolume	Charge Tier Price	number	Required for OneTimeTiered,OneTimeVolume,UsageTiered,UsagetieredwithOverage,usageVolume	Price or per-unit price of the tier, depending on the value of the priceFormat field.
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>Tiers>Onetimeperunit,onetimetiered,onetimevolume,usagetiered,usagetieredwithOverage,usagevolume	Charge Tier Price Format	string	Required for OneTimeTiered,OneTimeVolume,UsageTiered,UsagetieredwithOverage,usageVolume	Specifies whether the tier has a fixed price or a per-unit price. Enum: "FlatFee" "PerUnit"
Order>Subscription>Order Action	Add Product>ChargeOVerrides>Pricing>Tiers>Onetimeperunit,onetimetiered,onetimevolume,usagetiered,usagetieredwithOverage,usagevolume	Charge Tier Starting Unit	number	Required for OneTimeTiered,OneTimeVolume,UsageTiered,UsagetieredwithOverage,usageVolume	Number of units at which the tier becomes effective.
Array of objects (discountApplyDetail)	Marker Column	IsNewChargeDiscountApplyDetail	True or False	Required as 'True' when applying discount to product rate plan and product rate plan charge otherwise False or can be left blank
Order>Subscription>Order Action	Add Product>ChargeOverrides>Pricing>Discount>DiscountApplyDetail	Charge Discount Apply Details Product Rate Plan Charge Id	string	Require when applying discount to product rate plan charge	Product Rate Plan Charge Id of the discount apply to
Order>Subscription>Order Action	Add Product>ChargeOverrides>PricingDiscount>DiscountApplyDetail	Charge Discount Apply Details Product Rate Plan Id	string	Require when applying discount to product rate plan	Product Rate Plan Id of the discount apply to
Order>Subscription>Order Action	Add Product>ChargeOverrides>Billing	Subscriptions Order Actions Action Charge Billing Bill Cycle Day	integer [ 0 .. 31 ]	Optional	Day of the month that each billing period begins on. Only applicable if the value of the billCycleType field is SpecificDayofMonth.
Order>Subscription>Order Action	Add Product>ChargeOverrides>Billing	Subscriptions Order Actions Action Charge Billing Bill Cycle Type	string	Optional	Specifies how Zuora determines the day that each billing period begins on. DefaultFromCustomer - Each billing period begins on the bill cycle day of the account that owns the subscription. SpecificDayofMonth - Use the billCycleDay field to specify the day of the month that each billing period begins on. SubscriptionStartDay - Each billing period begins on the same day of the month as the start date of the subscription. ChargeTriggerDay - Each billing period begins on the same day of the month as the date when the charge becomes active. SpecificDayofWeek - Use the weeklyBillCycleDay field to specify the day of the week that each billing period begins on. Enum: "DefaultFromCustomer" "SpecificDayofMonth" "SubscriptionStartDay" "ChargeTriggerDay" "SpecificDayofWeek"
Order>Subscription>Order Action	Add Product>ChargeOverrides>Billing	Subscriptions Order Actions Action Charge Billing Billing Period	string	Optional	Billing frequency of the charge. The value of this field controls the duration of each billing period. If the value of this field is Specific_Days, Specific_Months or Specific_Weeks, use the specificBillingPeriod field to specify the duration of each billing period. Enum: "Month" "Quarter" "Semi_Annual" "Annual" "Eighteen_Months" "Two_Years" "Three_Years" "Five_Years" "Specific_Months" "Subscription_Term" "Week" "Specific_Weeks" "Specific_Days"
Order>Subscription>Order Action	Add Product>ChargeOverrides>Billing	Subscriptions Order Actions Action Charge Billing Billing Period Alignment	string	Optional	Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges. AlignToCharge - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active. AlignToSubscriptionStart - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription. AlignToTermStart - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term. See the billCycleType field for information about how Zuora determines the billing day. Note: This field is not supported in one time charges. Enum: "AlignToCharge" "AlignToSubscriptionStart" "AlignToTermStart"
Order>Subscription>Order Action	Add Product>ChargeOverrides>Billing	Subscriptions Order Actions Action Charge Billing Billing Timing	string	Optional	Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears). Enum: "IN_ADVANCE" "IN_ARREARS"
Order>Subscription>Order Action	Add Product>ChargeOverrides>Billing	Subscriptions Order Actions Action Charge Billing Specific Billing Period	integer	Optional	Duration of each billing period in months or weeks, depending on the value of the billingPeriod field. Only applicable if the value of the billingPeriod field is Specific_Months or Specific_Weeks
Order>Subscription>Order Action	Add Product>ChargeOverrides>Billing	Subscriptions Order Actions Action Charge Billing Weekly Bill Cycle Day	string	Optional	Day of the week that each billing period begins on. Only applicable if the value of the billCycleType field is SpecificDayofWeek. Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday"
Order>Subscription>Order Action	Add Product>ChargeOverrides>End Date	Subscriptions Order Actions Action Charge End Date End Date Condition	string	Optional	Condition for the charge to become inactive. If the value of this field is Fixed_Period, the charge is active for a predefined duration based on the value of the upToPeriodsType and upToPeriods fields. If the value of this field is Specific_End_Date, use the specificEndDate field to specify the date when the charge becomes inactive. Enum: "Subscription_End" "Fixed_Period" "Specific_End_Date"
Order>Subscription>Order Action	Add Product>ChargeOverrides>End Date	Subscriptions Order Actions Action Charge End Date End Date Policy	string	Optional	End date policy of the discount charge to become active when the Apply to billing period partially checkbox is selected from the product catalog UI or the applyToBillingPeriodPartially field is set as true from the "CRUD: Create a product rate plan charge" operation. If the value of this field is FixedPeriod, the charge is active for a predefined duration based on the value of the upToPeriodsType and upToPeriods fields. If the value of this field is SpecificEndDate, use the specificEndDate field to specify the date when the charge becomes inactive. Note: You must enable the Enhanced Discounts feature to access this field. You can use either endDateCondition or endDatePolicy to define when a discount charge ends, but not both at the same time. Enum: "AlignToApplyToCharge" "SpecificEndDate" "FixedPeriod"
Order>Subscription>Order Action	Add Product>ChargeOverrides>End Date	Subscriptions Order Actions Action Charge End Date Specific End Date	string <date>	Optional	Date in YYYY-MM-DD format. Only applicable if the value of the endDateCondition field is Specific_End_Date.
Order>Subscription>Order Action	Add Product>ChargeOverrides>End Date	Subscriptions Order Actions Action Charge End Date Up To Periods	integer	Optional	Duration of the charge in billing periods, days, weeks, months, or years, depending on the value of the upToPeriodsType field. Only applicable if the value of the endDateCondition field is Fixed_Period
Order>Subscription>Order Action	Add Product>ChargeOverrides>End Date	Subscriptions Order Actions Action Charge End Date Up To Periods Type	string	Optional	Unit of time that the charge duration is measured in. Only applicable if the value of the endDateCondition field is Fixed_Period. Enum: "Billing_Periods" "Days" "Weeks" "Months" "Years"
Order>Subscription>Order Action	Add Product>ChargeOverrides>Start Date	Subscriptions Order Actions Action Charge Start Date Periods After Charge Start	integer	Optional	Duration of the discount charge in days, weeks, months, or years, depending on the value of the startPeriodsType field. Only applicable if the value of the startDatePolicy field is FixedPeriodAfterApplyToChargeStartDate. Note: You must enable the Enhanced Discounts feature to access this field.
Order>Subscription>Order Action	Add Product>ChargeOverrides>Start Date	Subscriptions Order Actions Action Charge Start Date Specific Trigger Date	string <date>	Optional	string <date> Date in YYYY-MM-DD format. Only applicable if the value of the triggerEvent field is SpecificDate. While this field is applicable, if this field is not set, your CreateSubscription order action creates a Pending order and a Pending Acceptance subscription. If at the same time the service activation date is required and not set, a Pending Activation subscription is created. While this field is applicable, if this field is not set, the following order actions create a Pending order but do not impact the subscription status. Note: This feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support. AddProduct UpdateProduct RemoveProduct RenewSubscription TermsAndConditions
Order>Subscription>Order Action	Add Product>ChargeOverrides>Start Date	Subscriptions Order Actions Action Charge Start Date Start Date Policy	string	Optional	Start date policy of the discount charge to become active when the Apply to billing period partially checkbox is selected from the product catalog UI or the applyToBillingPeriodPartially field is set as true from the "CRUD: Create a product rate plan charge" operation. If the value of this field is SpecificDate, use the specificTriggerDate field to specify the date when the charge becomes active. If the value of this field is FixedPeriodAfterApplyToChargeStartDate, the charge is active for a predefined duration based on the value of the upToPeriodsType and upToPeriods fields. Note: You must enable the Enhanced Discounts feature to access this field. You can use either triggerEvent or startDatePolicy to define when a discount charge starts, but not both at the same time. Enum: "AlignToApplyToCharge" "SpecificDate" "EndOfLastInvoicePeriodOfApplyToCharge" "FixedPeriodAfterApplyToChargeStartDate"
Order>Subscription>Order Action	Add Product>ChargeOverrides>Start Date	Subscriptions Order Actions Action Charge Start Date Start Period Type	string	Optional	Unit of time that the discount charge duration is measured in. Only applicable if the value of the startDatePolicy field is FixedPeriodAfterApplyToChargeStartDate. Note: You must enable the Enhanced Discounts feature to access this field. Enum: "Days" "Weeks" "Months" "Years"
Order>Subscription>Order Action	Add Product>ChargeOverrides>Start Date	Subscriptions Order Actions Action Charge Start Date Trigger Event	string	Optional	Condition for the charge to become active. If the value of this field is SpecificDate, use the specificTriggerDate field to specify the date when the charge becomes active. Enum: "ContractEffective" "ServiceActivation" "CustomerAcceptance" "SpecificDate"
Order>Subscription>Order Action	Create Subscription>Terms	Action Terms Auto Renew	boolean	Optional	Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is TERMED
Order>Subscription>Order Action	Create Subscription>Terms	Action Terms Renewal Setting	string	Optional	Specifies the type of the terms that follow the first term if the subscription is renewed. Only applicable if the type of the first term is TERMED. RENEW_WITH_SPECIFIC_TERM - Each renewal term has a predefined duration. The first entry in renewalTerms specifies the duration of the second term of the subscription, the second entry in renewalTerms specifies the duration of the third term of the subscription, and so on. The last entry in renewalTerms specifies the ultimate duration of each renewal term. RENEW_TO_EVERGREEN - The second term of the subscription does not have a predefined duration. Enum: "RENEW_WITH_SPECIFIC_TERM" "RENEW_TO_EVERGREEN"
Order>Subscription>Order Action	Create Subscription>Terms>Initial Term	Subscriptions Order Actions Action Terms Initial Terms Period	integer	Required when providing information about first term of subscription	Duration of the first term in months, years, days, or weeks, depending on the value of the periodType field. Only applicable if the value of the termType field is TERMED.
Order>Subscription>Order Action	Create Subscription>Terms>Initial Term	Subscriptions Order Actions Action Terms Initial Terms Period Type	string	Required when providing information about first term of subscription	Unit of time that the first term is measured in. Only applicable if the value of the termType field is TERMED. Enum: "Month" "Year" "Day" "Week"
Order>Subscription>Order Action	Create Subscription>Terms>Initial Term	Subscriptions Order Actions Action Terms Initial Terms Start Date	string <date>	Required when providing information about first term of subscription	Start date of the first term, in YYYY-MM-DD format.
Order>Subscription>Order Action	Create Subscription>Terms>Initial Term	Subscriptions Order Actions Action Terms Initial Terms Term Type	string	Required when providing information about first term of subscription	Type of the first term. If the value of this field is TERMED, the first term has a predefined duration based on the value of the period field. If the value of this field is EVERGREEN, the first term does not have a predefined duration. Enum: "TERMED" "EVERGREEN"
	Marker Column	IsNewSubscriptionOrderActionRatePlanTermRenewalTerm	True Or False	Required as 'True' when creating record Rate Plan for subscription term renewal otherwise False or can be left blank
Order>Subscription>Order Action	Create Subscription>Terms>Renewal Terms	Subscriptions Order Actions Action Terms Renewal Terms Period	integer	Optional	Duration of the renewal term in months, years, days, or weeks, depending on the value of the periodType field.
Order>Subscription>Order Action	Create Subscription>Terms>Renewal Terms	Subscriptions Order Actions Action Terms Renewal Terms Period Type	string	Optional	Unit of time that the renewal term is measured in. Enum: "Month" "Year" "Day" "Week"
Array of objects (triggerDate)	Marker Column	IsNewRatePlanTriggerDate	True or False	Required as 'True' when creating contract effective, service activation, and customer acceptance dates of the order action Order action with Trigger Dates otherwise False or can be left blank	If Zuora is configured to require service activation and the ServiceActivation field is not set for a CreateSubscription order action, a Pending order and a Pending Activation subscription are created. If Zuora is configured to require customer acceptance and the CustomerAcceptance field is not set for a CreateSubscription order action, a Pending order and a Pending Acceptance subscription are created. At the same time, if the service activation date field is also required and not set, a Pending order and a Pending Activation subscription are created instead. If Zuora is configured to require service activation and the ServiceActivation field is not set for either of the following order actions, a Pending order is created. The subscription status is not impacted.
Order>Subscription>Order Action	Trigger Dates	Action Trigger Dates Name	string	Optional	Name of the trigger date of the order action. Enum: "ContractEffective" "ServiceActivation" "CustomerAcceptance"
Order>Subscription>Order Action	Trigger Dates	Action Trigger Dates Trigger Date	string <date>	Optional	Trigger date in YYYY-MM-DD format
Array of objects (OrderActionRatePlanChargeRemove)	Marker Column	IsNewRatePlanChargeUpdates	True or False	Optional
Order>Subscription>Order Action	Remove Product>Charge Updates	Action Charge Updates Charge Number	string <= 50 characters	Optional	Charge number of the charge. For example, C-00000307. If you do not set this field, Zuora will generate a charge number starting with a default prefix, for example, C-. This default prefix is predefined in Billing Settings > Define Default Subscription and Order Settings. If you want to use a custom charge number, do not use the default prefix predefined in Billing Settings > Define Default Subscription and Order Settings. Use your own prefix, for example, SC-.
Order>Subscription>Order Action	Remove Product>Charge Updates	Action Charge Updates Product Rate Plan Charge Id	string	Optional	Internal identifier of the product rate plan charge that the charge is based on.
Order>Subscription>Order Action	Remove Product>Charge Updates	Action Charge Updates Product Rate Plan Number	string	Optional	Number of a product rate-plan charge for this subscription.
Order>Subscription>Order Action	Remove Product>Charge Updates	Action Charge Updates Unique Token	string <= 50 characters	Optional	Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora. For instance, suppose that you want to use a single order to add a product to a subscription and later update the same product. When you add the product, you can set a unique identifier for the charge. Then when you update the product, you can use the same unique identifier to specify which charge to modify.
Order>Subscription>Order Action	Remove Product>Charge Updates	Action Charge Updates Billing Billing Period Alignment	string	Optional	This field is not supported in one time charges. Enum: "AlignToCharge" "AlignToSubscriptionStart" "AlignToTermStart"
Order>Subscription>Order Action	Remove Product>Charge Updates	Action Charge Updates Effective Date Specific Trigger Date	string <date>	Optional	Date in YYYY-MM-DD format. Only applicable if the value of the triggerEvent field is SpecificDate. While this field is applicable, if this field is not set, your CreateSubscription order action creates a Pending order and a Pending Acceptance subscription. If at the same time the service activation date is required and not set, a Pending Activation subscription is created. While this field is applicable, if this field is not set, the following order actions create a Pending order but do not impact the subscription status. While this field is applicable, for the updateProduct order action, if the Pending order feature as above is not enabled, this field must not be set to null.
Order>Subscription>Order Action	Remove Product>Charge Updates	Action Charge Updates Effective Date Trigger Event	string	Optional	Condition for the charge to become active. If this field is not specified, the value of the field will be defaulted to the trigger event value defined in the product catalog. If the value of this field is SpecificDate, use the specificTriggerDate field to specify the date when the charge becomes active. Enum: "ContractEffective" "ServiceActivation" "CustomerAcceptance" "SpecificDate"
Order>Subscription>Order Action		Action Last Term Period		Optional
Order>Subscription>Order Action		Action Last Term Period Type		Optional
Order>Subscription>Order Action		Action Last Term Start Date		Optional
Order>Subscription>Order Action		Action Last Term Term Type		Optional
	Marker Column	IsNewActionRenewalTerm	True or False	Optional	List of renewal terms of the subscription. Only applicable if the type of the first term is TERMED and the value of the renewalSetting field is RENEW_WITH_SPECIFIC_TERM.
Subscription>Order Actions>Create Subscription>Terms> Renewal Term		Action Renewal Term Period	integer	Optional	Duration of the renewal term in months, years, days, or weeks, depending on the value of the periodType field
Subscription>Order Actions>Create Subscription>Terms> Renewal Term		Action Renewal Term Period Type	string	Optional	Unit of time that the renewal term is measured in. Enum: "Month" "Year" "Day" "Week"
Array of objects (triggerDate)	Marker Column	IsNewTriggerDate	True or False	Optional	Container for the contract effective, service activation, and customer acceptance dates of the order action. For Learning how to use the field, `click here.`
Order>Subscription>Order Action	Trigger Dates	Trigger Dates Name	string	Optional	Name of the trigger date of the order action. Enum: "ContractEffective" "ServiceActivation" "CustomerAcceptance"
Order>Subscription>Order Action	Trigger Dates	Trigger Dates Trigger Date	string <date>	Optional	Trigger date in YYYY-MM-DD format.
The fields populated for a quote when a quote is sent to Zuora Billing from Zuora Quote				Optional
Order>Subscription	Quote	Subscriptions Quote Opportunity Close Date QT	string	Optional	The closing date of the Opportunity. This field is used in Zuora Reporting Data Sources to report on Subscription metrics. If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.
Order>Subscription	Quote	Subscriptions Quote Opportunity Name QT	string	Optional	The unique identifier of the Opportunity. This field is used in the Zuora Reporting Data Sources to report on Subscription metrics. If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. Character limit: 100
Order>Subscription	Quote	Subscriptions Quote Quote Business Type QT	string	Optional	The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in the Zuora Reporting Data Sources to report on Subscription metrics. If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. Character limit: 32
Order>Subscription	Quote	Subscriptions Quote Quote Number QT	string	Optional	The unique identifier of the Quote. This field is used in the Zuora Reporting Data Sources to report on Subscription metrics. If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. Character limit: 32
Order>Subscription	Quote	Subscriptions Quote Quote Type QT	string	Optional	The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in the Zuora Reporting Data Sources to report on Subscription metrics. If the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. Character limit: 32
Container of the ramp definitions				Optional
Order>Subscription	Ramp	Ramp Delete	boolean	Optional	Whether to remove the ramp definition from the new subscription. If you want to remove the ramp definition, this field is the only required field for the ramp object.
Order>Subscription	Ramp	Ramp Description	string	Optional	The short description of the ramp.
Order>Subscription	Ramp	Ramp Name	string	Optional	The name of the ramp.
Array of objects (RampCharge)	Marker Column	IsNewRampRampCharge	True or False	Optional	Container for the rate plan charges that are considered as part of the ramp deal. If this field is not specified, all the one-time and recurring regular charges of the new subscription are automatically considered as part of the ramp deal. If this field is specified, either 'chargeNumber' or 'uniqueToken' must be specified.
Order>Subscription	Ramp>Ramp Charge	Ramp Charges Charge Number	string	Optional	The number of the rate plan charge
Order>Subscription	Ramp>Ramp Charge	Ramp Charges Unique Token	string	Optional	Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.
Array of objects (intervals)	Marker Column	IsNewRampInterval	True or False	Optional	Container for the intervals that the ramp is split into in its timeline. It is required when you want to create or update the ramp definition. The ramp intervals cannot have any overlap or gap between each other.
Order>Subscription	Ramp>Ramp Interval	Ramp Intervals Description	string	Optional	The short description of the interval
Order>Subscription	Ramp>Ramp Interval	Ramp Intervals End Date	string <date>	Required for creating Ramp Interval record	The end date of the interval.
Order>Subscription	Ramp>Ramp Interval	Ramp Intervals Name	string	Optional	The name of the interval.
Order>Subscription	Ramp>Ramp Interval	Ramp Intervals Start Date	string <date>	Required for creating Ramp Interval record	The start date of the interval.
Orders	Orders	Scheduling Options Scheduled Date	string <date>	Optional	The date for the scheduled order.
Orders	Orders	Scheduling Options Scheduled Date Policy	SpecificDate	Optional	The policy that determines the date for a scheduled order.

Welcome to Zuora Product Documentation

Explore our rich library of product information

Advance multi action orders - data dictionary

zuora-footer