--- title: "Preview an order asynchronously" method: POST path: "/v1/async/orders/preview" tags: ["Orders"] --- # Preview an order asynchronously `POST /v1/async/orders/preview` **Notes:** - This operation is only available if you have the [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) feature enabled. Orders is now generally available as of Zuora Billing Release 284 (August 2020). If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing. - The [Order Line Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) feature to access the [Order Line Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) will have the [Order Line Items](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-non-subscription-transactions/order-line-items) feature enabled by default. - You cannot preview enhanced discounts and usage charges. In the case where a normal "Preview an order" operation call will time out, use this operation instead to preview an order asynchronously. A job will be previewing the order in the back end; the job ID will be returned for tracking the job status and result. #### Billing preview behavior regarding draft invoices By default, the billing preview behavior regarding draft invoices is as below: * When you preview billing for your order and the order contains subscriptions only, the draft invoices are excluded. * When you preview billing for your order and the order contains order line items only, the draft invoices are included. * When you preview billing for an order that contains both subscriptions order line items, the draft invoices are included for both subscriptions and order line items. However, if you want to always exclude the draft invoices in billing preview, submit a request at [Zuora Global Support](https://support.zuora.com). #### Limits on Orders API The limit of orders allowed on a subscription is 1000. The limit of order line items allowed in an order is 100. Zuora has the following limits on the Orders synchronous API to prevent performance degradation: * Up to 50 subscriptions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. * Up to 50 order actions are allowed in a single [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. * Up to 50 order actions are allowed on a single subscription in a [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order) or [Preview an order](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrder) operation call. If you have an Order that exceeds any limits of the above, Zuora recommends you use the following asynchronous API operations: * [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) * [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) * [Retrieve the status and response of a job](https://developer.zuora.com/api-references/api/operation/GET_JobStatusAndResponse) for checking the status of the asynchronous API operations Zuora has the following limits on the Orders asynchronous API operations to prevent performance degradation: * Up to 300 subscriptions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. * Up to 300 order actions are allowed in a single [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. * Up to 300 order actions are allowed on a single subscription in a [Create an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_CreateOrderAsynchronously) or [Preview an order asynchronously](https://developer.zuora.com/api-references/api/operation/POST_PreviewOrderAsynchronously) operation call. ## Query parameters - `summarizeInvoiceItem` boolean ## Headers - `Idempotency-Key` string - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Version` string ## Request body - POSTOrderPreviewAsyncRequestType - `category` 'NewSales' | 'Return' — Category of the order to indicate a product sale or return. Default value is `NewSales`. - `customFields` OrderObjectCustomFields — Container for custom fields of an Order object. - `description` string — A description of the order. - `existingAccountId` string — The account ID under which this order will be created. This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber` nested fields in the `subscriptions` field. **Note:** You can specify either the `existingAccountNumber` or `existingAccountId` field, but not both. - `existingAccountNumber` string — The account number under which this order will be created. This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber` nested fields in the `subscriptions` field. - `orderDate` string, date, required — The date when the order is signed. All of the order actions under this order will use this order date as the contract effective date. - `orderLineItems` CreateOrderOrderLineItem[] — [Order Line Items](https://docs.zuora.com?resourceId=billing-order-line-items) are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. With the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. If you do not have the **Create Order Line Items Without Product Catalog** billing permission, you can only create order line items from existing products by specifying the product rate plan charge ID in the `productRatePlanChargeId` field. For more information about billing permissions, see Billing Roles. **Note:** The [Order Line Items](https://docs.zuora.com?resourceId=billing-order-line-items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://docs.zuora.com?resourceId=billing-overview-orders) feature to access the [Order Line Items](https://docs.zuora.com?resourceId=billing-order-line-items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) will have the [Order Line Items](https://docs.zuora.com?resourceId=billing-order-line-items) feature enabled by default. - `UOM` string — Specifies the units to measure usage. - `accountingCode` string — The accounting code for the Order Line Item. - `adjustmentLiabilityAccountingCode` string — The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration). - `adjustmentRevenueAccountingCode` string — The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration). - `amountPerUnit` number — 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. - `billTargetDate` string, date — The target date for the Order Line Item to be picked up by bill run for billing. - `billTo` string — 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. **Note**: If an order's category is set to **Return** in a return Order Line Item, it will inherit the original Order Line Item's `billTo` contact automatically. You cannot specify a different value. - `billingRule` 'TriggerWithoutFulfillment' | 'TriggerAsFulfillmentOccurs' — The billing rule for the Order Line Item. - `contractAssetAccountingCode` string — The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration). - `contractLiabilityAccountingCode` string — The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration). - `contractRecognizedRevenueAccountingCode` string — The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration). - `currency` string — The currency for the order line item. You can specify a currency when creating an order line item through the "Create an order" operation. - `customFields` OrderLineItemCustomFields — Container for custom fields of an Order Line Item object. - `deferredRevenueAccountingCode` string — The deferred revenue accounting code for the Order Line Item. - `description` string — The description of the Order Line Item. - `excludeItemBillingFromRevenueAccounting` boolean — 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](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `excludeItemBookingFromRevenueAccounting` boolean — 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](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `inlineDiscountPerUnit` number — 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. You shall not set the `amountPerUnit` field by yourself. - `inlineDiscountType` 'Percentage' | 'FixedAmount' | 'None' — 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. - `isAllocationEligible` boolean — This field is used to identify if the charge segment is allocation eligible in revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. - `isUnbilled` boolean — This field is used to dictate how to perform the accounting during revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. - `itemCategory` 'Sales' | 'Return' — The category for the Order Line Item, to indicate a product sale or return. - `itemName` string — The name of the Order Line Item. - `itemNumber` string — 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. - `itemState` 'Executing' | 'Booked' | 'SentToBilling' | 'Complete' | 'Cancelled' — 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](https://docs.zuora.com?resourceId=billing-state-transitions-order-line-items) for more information. - `itemType` 'Product' | 'Fee' | 'Services' — The type of the Order Line Item. - `listPricePerUnit` number — The list price per unit for the Order Line Item. - `originalOrderLineItemNumber` string — The number of the original sale order line item for a return order line item. - `originalOrderNumber` string — The number of the original sale order for a return order line item. - `ownerAccountNumber` string — Use this field to assign an existing account as the owner of an order line item. - `productCode` string — The product code for the Order Line Item. - `productRatePlanChargeId` string — ID of a product rate plan charge. Only one-time charges are supported. If you do not have the **Create Order Line Items Without Product Catalog** billing permission, you must specify this field to create the order line item from an existing product rate plan charge. - `purchaseOrderNumber` string — Used by customers to specify the Purchase Order Number provided by the buyer. - `quantity` number — The quantity of units, such as the number of authors in a hosted wiki service. - `recognizedRevenueAccountingCode` string — The recognized revenue accounting code for the Order Line Item. - `relatedSubscriptionNumber` 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. - `revenueRecognitionRule` string — The Revenue Recognition rule for the Order Line Item. - `revenueRecognitionTiming` 'Upon Billing Document Posting Date' | 'Upon Order Activation Date' — 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. - `revenueAmortizationMethod` 'Immediate' | 'Ratable Using Start And End Dates' — Specifies the type of revenue amortization method. 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. - `invoiceGroupNumber` string, nullable — The number of the invoice group associated with the order line item. After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://docs.zuora.com?resourceId=billing-invoice-grouping). **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 during subscription creation, the value of this field is automatically set to `null` in the response body. - You can specify this field on a sales order line item when its state (that is, the `itemState` field) is `Executing`, `Booked`, or `SentToBilling`. - `sequenceSetId` string — The ID of the sequence set associated with the order line item. **Note**: - This field is only available in the request body if you have the Flexible Billing Attributes feature enabled. Otherwise, the response value for this field is `null`. - If you don't specify this field in the request during the creation, OLI uses the value from the account automatically. - You can specify this field on a sales order line item when its state (that is, the `itemState` field) is `Executing`, `Booked`, or `SentToBilling`. - `paymentTerm` string — The payment term name associated with the order line item. **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 don't specify this field in the request during the creation, OLI uses the value from the account automatically. - You can specify this field on a sales order line item when its state (that is, the `itemState` field) is `Executing`, `Booked`, or `SentToBilling`. - `invoiceTemplateId` string — The ID of the invoice template associated with the order line item. **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 don't specify this field in the request during the creation, OLI uses the value from the account automatically. - You can specify this field on a sales order line item when its state (that is, the `itemState` field) is `Executing`, `Booked`, or `SentToBilling`. - `shipTo` string — Use this field to assign an existing account as the ship-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. **Note**: If an order's category is set to **Return** in a return Order Line Item, it will inherit the original Order Line Item's `shipTo` contact automatically. You cannot specify a different value. - `soldTo` unknown - `taxCode` string — The tax code for the Order Line Item. - `taxMode` 'TaxInclusive' | 'TaxExclusive' — The tax mode for the Order Line Item. - `transactionEndDate` string, date — 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. - `transactionStartDate` string, date — The date a transaction starts. The default value of this field is the order date. - `unbilledReceivablesAccountingCode` string — The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration). - `orderNumber` string — The order number of this order. **Note:** The characters `#`, `?`, and `/` are not allowed in this field. Additionally, to ensure compatibility with the UI when viewing orders, use only the following special characters: `_`,`-`, `.`, `~`, `*`, `(`, `)`, and `'`. - `previewAccountInfo` PreviewAccountInfo — Information about the account that will own the order. - `billCycleDay` integer, required — Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as "AutoSet". - `currency` string, required — ISO 3-letter currency code (uppercase). For example, USD. - `customFields` AccountObjectCustomFields — Container for custom fields of an Account object. - `shipToContact` PreviewContactInfo — Contact details associated with an account. - `address1` string — First line of the contact's address. This is often a street address or a business name. - `address2` string — Second line of the contact's address. - `city` string - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country to calculate tax. - `county` string - `postalCode` string - `state` string - `taxRegion` string - `soldToContact` PreviewContactInfo — Contact details associated with an account. - `address1` string — First line of the contact's address. This is often a street address or a business name. - `address2` string — Second line of the contact's address. - `city` string - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country to calculate tax. - `county` string - `postalCode` string - `state` string - `taxRegion` string - `taxInfo` TaxInfo — Information about the tax exempt status of a customer account. - `VATId` string — EU Value Added Tax ID. **Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). - `companyCode` string — Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara. **Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). - `exemptCertificateId` string — ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines. - `exemptCertificateType` string — Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines. - `exemptDescription` string — Description of the tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines. - `exemptEffectiveDate` string, date — Date when the customer tax exemption starts, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines. - `exemptExpirationDate` string, date — Date when the customer tax exemption expires, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines. - `exemptIssuingJurisdiction` string — Jurisdiction in which the customer tax exemption certificate was issued. - `exemptStatus` 'No' | 'Yes' | 'PendingVerification' — Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax. - `previewOptions` PreviewOptions, required - `previewNumberOfPeriods` integer — The number of periods to preview when the value of the `previewThroughType` field is set to `NumberOfPeriods`. - `previewThruType` 'SpecificDate' | 'TermEnd' | 'NumberOfPeriods' — The options on how the preview through date is calculated. Available for preview only. - If you set this field to `SpecificDate`, you must specify a specific date in the `specificPreviewThruDate` field. If you also set `billTargetDate` in the `orderLineItems` field, order line items whose `billTargetDate` is no later than `specificPreviewThruDate` are returned. - If you set this field to `NumberOfPeriods`, you must use the `previewNumberOfPeriods` field to specify how many periods you want to preview. In case the order only contains an order line item but not contains a subscription, if you also set `billTargetDate` in the `orderLineItems` field, order line items whose `billTargetDate` is no later than today are returned. - The `TermEnd` option is invalid when any subscription included in this order is evergreen. In case the order only contains an order line item but not contains a subscription, if you set this field to `TermEnd` and set `billTargetDate` in the `orderLineItems` field, order line items whose `billTargetDate` is no later than today are returned. - `previewTypes` string[] — One or more types of the preview. It can include: * ChargeMetrics: charge level metrics will be returned in the response, including: `cmrr`, `tcv`, `tcb`, and `tax`. * BillingDocs: `invoices` and `creditMemos` will be returned in the response. Note `creditMemos` is only available if the Invoice Settlement feature is enabled. * OrderDeltaMetrics: order delta metrics will be returned in the response, including: `orderDeltaMrr`, `orderDeltaTcb` and `orderDeltaTcv`. * OrderMetrics: order metrics will be returned in the response, including: `quantity`, `mrr`, `tcb`, `tcv`, and `elp`. **Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://docs.zuora.com?resourceId=billing-overview-orders). The new methodologies are reflected in the OrderDeltaMetrics. It is recommended that all customers use the [Order Delta Metrics](https://docs.zuora.com?resourceId=billing-order-delta-metrics). If you are an existing [Order Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/). Whereas new customers, and existing customers not currently on [Order Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders), will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported. * RampMetrics: ramp metrics will be returned in the response, including: `quantity`, `mrr`, `tcb`, `tcv` metrics for each charge and each ramp interval. * RampDeltaMetrics: ramp metrics changes will be returned in the response, including: `deltaQuantity`, `deltaMrr`, `deltaTcb`, `deltaTcv` metrics for each charge and each ramp interval. - `skipTax` boolean — If set to true, the system will bypass the tax calculation during order preview. - `specificPreviewThruDate` string, date — The end date of the order preview. You can preview the invoice charges through the preview through date. (Invoice preview only) **Note:** This field is only applicable if the 'previewThruType' field is set to 'SpecificDate'. - `validateScheduledOrders` boolean — By default, scheduled orders are validated during order preview to ensure all orders can be executed successfully. If you do not want to validate all scheduled orders during order preview, set this field to `false`. - `chargeTypeToExclude` string[] — The charge types to exclude from the forecast run. - `reasonCode` string — Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs. - `subscriptions` object[] — Each item includes a set of order actions, which will be applied to the same base subscription. When you create an order that involves multiple subscriptions, these subscriptions can have different invoice owner accounts or subscription owner accounts. - `customFields` SubscriptionObjectCustomFields — Container for custom fields of a Subscription object. - `notes` string — Notes about the subscription. These notes are only visible to Zuora users. Notes set in this field will override the value of the `notes` field within the createSubscription order action. - `orderActions` PreviewOrderOrderAction[] — The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request. - `addProduct` PreviewOrderRatePlanOverride — Information about an order action of type `AddProduct`. - `chargeOverrides` PreviewOrderChargeOverride[] — List of charges associated with the rate plan. - `accountReceivableAccountingCode` string — The accountReceivableAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled. - `adjustmentLiabilityAccountingCode` string — The adjustmentLiabilityAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `adjustmentRevenueAccountingCode` string — The adjustmentRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `billing` object — Billing information about the charge. - `billCycleDay` integer — Day of the month that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofMonth`. - `billCycleType` 'DefaultFromCustomer' | 'SpecificDayofMonth' | 'SubscriptionStartDay' | 'ChargeTriggerDay' | 'SpecificDayofWeek' — 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. - `billingPeriod` 'Month' | 'Quarter' | 'Semi_Annual' | 'Annual' | 'Eighteen_Months' | 'Two_Years' | 'Three_Years' | 'Five_Years' | 'Specific_Months' | 'Subscription_Term' | 'Week' | 'Specific_Weeks' | 'Specific_Days' — 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. - `billingPeriodAlignment` 'AlignToCharge' | 'AlignToSubscriptionStart' | 'AlignToTermStart' — 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. - `billingTiming` 'IN_ADVANCE' | 'IN_ARREARS' — 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). - `specificBillingPeriod` integer — 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`. - `weeklyBillCycleDay` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' — Day of the week that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofWeek`. - `chargeFunction` 'CommitmentTrueUp' | 'CreditCommitment' — **Note**: This field is only available if you have both the Prepaid with Drawdown and Standalone Orders features enabled. With this field, you can use a standalone order to subscribe to a minimum commitment subscription. This field defines what type of charge it is: * CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge. * CreditCommitment: For usage charges. Credit to minimum commitment funds. - `creditOption` 'TimeBased' | 'ConsumptionBased' | 'FullCreditBack' — **Note**: This field is only available if you have both the Minimum Commitment and Standalone Orders features enabled. With this field, you can use a standalone order to subscribe to a minimum commitment subscription. This field defines the way to calculate credit. See [Credit Option](https://docs.zuora.com?resourceId=billing-prepayment-charge) for more information. - `chargeModel` string — The chargeModel of a standalone charge. Supported charge models: * `FlatFee` * `PerUnit` * `Volume` * `Tiered` * `DiscountFixedAmount` * `DiscountPercentage` **Note:** This field is available when the Standalone Orders feature is enabled. - `chargeNumber` string — 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-. - `chargeType` string — The chargeType of a standalone charge. Supported charge types: * `OneTime` * `Recurring` * `Usage` **Note:** This field is available when the Standalone Orders feature is enabled. - `contractAssetAccountingCode` string — The contractAssetAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `contractLiabilityAccountingCode` string — The contractLiabilityAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `contractRecognizedRevenueAccountingCode` string — The contractRecognizedRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `customFields` RatePlanChargeObjectCustomFields — Container for custom fields of a Rate Plan Charge object. - `deferredRevenueAccountingCode` string — The deferredRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled. - `description` string — Description of the charge. - `drawdownRate` number — **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. The [conversion rate](https://docs.zuora.com?resourceId=billing-create-drawdown-charge) between Usage UOM and Drawdown UOM for a [drawdown charge](https://docs.zuora.com?resourceId=billing-create-drawdown-charge). Must be a positive number (>0). - `drawdownScope` 'SUBSCRIPTION' | 'ACCOUNT' — The scope in which the funds are applicable for the usage drawdown charges during drawdown. Valid for the charge with function of `Prepayment`. - `SUBSCRIPTION` - only usage charges of the same subscription can be drawn down. - `ACCOUNT` - only usage charges in the same account (subscription owner) can be drawn down. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `drawdownPriority` integer — Drawdown priority for consumption ordering. Lower value means that it will be consumed first. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `endDate` EndConditions — Specifies when a charge becomes inactive. - `endDateCondition` 'Subscription_End' | 'Fixed_Period' | 'Specific_End_Date' | 'One_Time', nullable — 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. - `endDatePolicy` 'AlignToApplyToCharge' | 'SpecificEndDate' | 'FixedPeriod' — 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. **Notes**: - You must enable the [Enhanced Discounts](https://docs.zuora.com?resourceId=billing-manage-enhanced-discount) 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. - `specificEndDate` string, date, nullable — Date in YYYY-MM-DD format. Only applicable if the value of the `endDateCondition` field is `Specific_End_Date`. - `upToPeriods` integer, nullable — 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`. - `upToPeriodsType` 'Billing_Periods' | 'Days' | 'Weeks' | 'Months' | 'Years', nullable — Unit of time that the charge duration is measured in. Only applicable if the value of the `endDateCondition` field is `Fixed_Period`. - `estimatedStartDate` string, date — The estimated start date of the pending charge in an active subscription. If you specify `SpecificDate` in the `startDate` > `triggerEvent` field and want to create a completed order and an active subscription, you must specify either the `estimatedStartDate` or `startDate` > `specificTriggerDate` field: - `estimatedStartDate`: The charge will be in pending status. - `specificTriggerDate`: The charge will be in active status. The value of this field must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge. **Note:** This field is available only when the Pending Subscription Processing feature is turned on. - `excludeItemBillingFromRevenueAccounting` boolean — 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](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `excludeItemBookingFromRevenueAccounting` boolean — 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](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `fundSupportAccountHierarchy` boolean — Indicates whether to enable sub-account's usage to drawdown from the parent's funds. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `isAllocationEligible` boolean — This field is used to identify if the charge segment is allocation eligible in revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. - `isRollover` boolean — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The value is either "True" or "False". It determines whether the rollover fields are needed. - `isUnbilled` boolean — This field is used to dictate how to perform the accounting during revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. - `name` string — The name of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `negotiatedPriceTable` NegotiatedItems[] — Array of negotiated price table information. The rate card entries provided in the array will override the existing rate card entries in the standard price table to form a negotiated price table that will be used during pricing evaluation. **Note:** To enable the Negotiated Price Table feature, submit a request to Zuora Global Support. - `items` object — The rate card entry object. **Note:** For more information, refer to the rate card definition in the product catalog. - `pobPolicy` string — The pobPolicy of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `prepaidQuantity` number — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The number of units included in a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). Must be a positive number (>0). - `prepaymentUnitType` 'UNIT' — The unit type of the prepayment charge. For topup (recurring/one-time) charges, this field indicates what type of funds are created. For drawdown (usage) charges, this field indicates what type of funds are drawn down from those created by topup charges. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `pricing` object — Pricing information about the charge. - `chargeModelData` ChargeModelDataOverride — Container for charge model configuration data. **Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information. - … - `discount` DiscountPricingOverride — Pricing information about a discount charge. - … - `oneTimeFlatFee` OneTimeFlatFeePricingOverride — Pricing information about a one-time charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price. - … - `oneTimePerUnit` OneTimePerUnitPricingOverride — Pricing information about a one-time charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit purchased. - … - `oneTimeTiered` OneTimeTieredPricingOverride — Pricing information about a one-time charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased. - … - `oneTimeVolume` OneTimeVolumePricingOverride — Pricing information about a one-time charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased. - … - `recurringCalculated` RecurringCalculatedPricingOverride — Pricing information about a recurring charge that uses the "calculated" charge model. - … - `recurringDeliveryBased` RecurringDeliveryPricingOverride — Pricing information about a recurring charge that uses the Delivery Pricing charge model. In this charge model, the charge has a fixed price. This field is only available if you have the Delivery Pricing charge model enabled. - … - `recurringFlatFee` RecurringFlatFeePricingOverride — Pricing information about a recurring charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price. - … - `recurringPerUnit` RecurringPerUnitPricingOverride — Pricing information about a recurring charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit purchased. - … - `recurringTiered` RecurringTieredPricingOverride — Pricing information about a recurring charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased. - … - `recurringVolume` RecurringVolumePricingOverride — Pricing information about a recurring charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased. - … - `pricingAttributes` object — Container for pricing attribute and value that provide additional context for dynamic pricing. The pricing attribute values are used to get the charge’s list price from the product catalog. For the pricing attribute mapped to a Zuora object field, Zuora will retrieve the value automatically, you don’t need to pass its value explicitly. If you pass a value that doesn’t match the actual value of the Zuora object, an error will be returned. Note that for any pricing attribute mapped to the field of Zuora object Usage, because its value is only determined when the usage record arrives, you can’t provide a value via Orders API payload and Zuora will not retrieve its value automatically. **Note:** To enable Dynamic Pricing, submit a request to Zuora Global Support. - `productCategory` string — The productCategory of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productClass` string — The productClass of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productFamily` string — The productFamily of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productLine` string — The productLine of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productRatePlanChargeId` string, required — Internal identifier of the product rate plan charge that the charge is based on. You can specify either `productRatePlanChargeId` or `productRatePlanChargeNumber`. When subscribing to a hard bundle, include the optional component charge’s ID explicitly in order to add it to the subscription. When `isAddingSubsetCharges` is set to true, the product rate charge specified by `productRatePlanChargeId` is added to the existing rate plan specified by `ratePlanId`. **Note**: The **Hard Bundle** feature is in the **Early Availability** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early availability program, submit a request at Zuora Global Support. - `productRatePlanChargeNumber` string — Number of a product rate-plan charge for this subscription. - `prorationOption` 'NoProration' | 'TimeBasedProration' | 'DefaultFromTenantSetting' | 'ChargeFullPeriod' | 'CustomizeProrationOptionOverrides' — **Note**: This field is only available if you have the **Charge Level Proration** feature enabled. For more information, see Usage charge proration and Charge level proration option for a recurring charge. You can use this field to specify the charge-level proration option for a usage charge or recurring charge when you create or add a subscription rate plan charge through an order. The tenant-level proration option will be overridden. * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge. * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period. * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting. * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period. * `CustomizeProrationOptionOverrides`: charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the `ratingPropertiesOverride` field. When the Enhanced Unit-Based Prepaid with Drawdown feature is enabled, the possible options are: - DefaultFromTenantSetting - CustomizeProrationOptionOverrides. When `CustomizeProrationOptionOverrides` is selected, define the customization rules using these options in the `ratingPropertiesOverride` field. - `ratingPropertiesOverride` object — **Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge. This field is used only when the value of the `prorationOption` field is set to `CustomizeProrationOptionOverrides`. Use this field to specify more customized proration options for a recurring charge when you creating or adding a subscription rate plan charge through an order. The tenant-level proration option will be overridden. - `isProratePartialMonth` boolean — **Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge. Use this field to specify whether to prorate the recurring charge for a partial month. The tenant-level proration option will be overridden. - `prepaymentChargeProrationRule` 'ProrateAmount' | 'ChargeFullAmount' — Define whether to prorate the charge amount or not. When `ProrateAmount` is selected, define the proration rules via the options under this section. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `prorationUnit` 'ProrateByDay' | 'ProrateByMonthFirst' — **Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge. Use this field to specify the unit of proration for a recurring charge. The tenant-level proration option will be overridden. - `daysInMonth` 'UseActualDays' | 'Assume30Days' | 'Assume30DaysStrict' — **Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge. Use this field to specify the number of days counted for a month when prorating a recurring charge. The tenant-level proration option will be overridden. See more details for each of the following enum values in Proration. - `recognizedRevenueAccountingCode` string — The recognizedRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled. - `revRecCode` string — Revenue Recognition Code - `revRecTriggerCondition` 'Contract Effective Date' | 'Service Activation Date' | 'Customer Acceptance Date' — Specifies the revenue recognition trigger condition. * `Contract Effective Date` * `Service Activation Date` * `Customer Acceptance Date` - `revenueRecognitionRuleName` string — Specifies the revenue recognition rule, such as `Recognize upon invoicing` or `Recognize daily over time`. - `revenueRecognitionTiming` 'Upon Billing Document Posting Date' | 'Upon Order Activation Date' — 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 both the Order to Revenue feature and the Standalone Orders feature enabled. - `revenueAmortizationMethod` 'Immediate' | 'Ratable Using Start And End Dates' — Specifies the type of revenue amortization method. 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 both the Order to Revenue feature and the Standalone Orders feature enabled. - `rolloverApply` 'ApplyFirst' | 'ApplyLast' — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. This field defines the priority of rollover, which is either first or last. - `rolloverEndDate` string, date — Explicit cutoff date when `rolloverEndDateType` is `SpecificDate`. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `rolloverEndDateType` 'ChargeEndDate' | 'SubscriptionTerm' | 'SpecificDate' — Rollover cutoff strategy determining when the rollover eligibility will end. Possible values are: * `ChargeEndDate` - Rollover stops at the charge end date. * `SubscriptionTerm` - Rollover stops at the subscription term end. * `SpecificDate` - Rollover stops at an explicit date specified in `RolloverEndDate`. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `rolloverFundPriority` integer — Priority for rolled-over funds. Lower value means that it will be consumed first. When Enhanced Unit-Based Prepaid with Drawdown feature is enabled, you can customize a single rollover period length together with `rolloverPeriodType` field. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `rolloverPeriodLength` integer — **Note**: This field is only available if you have the Enhanced Unit-Based 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. When the **Enhanced Unit-Based Prepaid with Drawdown** feature is enabled, you can customize a single rollover period length together with `rolloverPeriodType` field. - `rolloverPeriods` number — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. This field defines the number of rollover periods, it is restricted to 3. - `rolloverPeriodType` 'Day' | 'Month' | 'Quarter' | 'Annual' — Unit for rollover period length. Possible values are: * `Day` - Day-based rollover periods. * `Month` - Month-based rollover periods. * `Quarter` - Quarter-based rollover periods. * `Annual` - Annual rollover periods. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `startDate` PreviewOrderTriggerParams — Specifies when a charge becomes active. - `specificTriggerDate` 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. - `triggerEvent` 'ContractEffective' | 'ServiceActivation' | 'CustomerAcceptance' | 'SpecificDate' — 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. - `unBilledReceivablesAccountingCode` string — The unBilledReceivablesAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `uniqueToken` string — 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. - `upsellOriginChargeNumber` string — The identifier of the original upselling charge associated with the current charge. For a termed subscription, you can now use the "Create an order" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows: * Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell. * In the preceding charge to add, use the `upsellOriginChargeNumber` field to specify the existing rate plan charge for which you want to make the quantity upsell. Note that a termed subscription with such upsell charges can not be changed to an evergreen subscription. **Note**: The Quantity Upsell feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](https://support.zuora.com). - `validityPeriodType` 'SUBSCRIPTION_TERM' | 'ANNUAL' | 'SEMI_ANNUAL' | 'QUARTER' | 'MONTH' — **Note**: 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](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover), 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. * When **Enhanced Unit-Based Prepaid with Drawdown** feature is enabled, you can also choose from the following options: `SPECIFIC_DAYS`, `SPECIFIC_WEEKS`, `SPECIFIC_MONTHS`. Specify the actual number in `specificValidityPeriodLength` field. - `specificValidityPeriodLength` integer — The number of days, weeks, or months for the validity period when `ValidityPeriodType` is `SPECIFIC_DAYS`, `SPECIFIC_WEEKS`, or `SPECIFIC_MONTHS`. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `validityPeriodAlignment` 'ChargeStart' | 'TermStart' | 'TermEnd' | 'SpecificDate' — Determines the anchor date for validity period (VP) boundaries. The anchor date defines the recurring grid — VP boundaries fall at every VP-length step from the anchor. The charge's start and end dates then determine which portion of this grid is covered. Possible values are: * `ChargeStart` (default) - Anchor date is the charge start date. Simplest option with no partial first VP. * `TermStart` - Anchor date is the subscription term start date. Aligns all charges on the same subscription to a common grid. * `TermEnd` - Anchor date is derived by walking backward from the subscription term end date. Last VP always ends cleanly at term end; partial VP (if any) is at the start. * `SpecificDate` - Anchor date is an explicit `validityPeriodAnchorDate` on the charge. Custom alignment for special billing arrangements. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `validityPeriodAnchorDate` string, date — The anchor date for validity period alignment. Required when `validityPeriodAlignment` is `SpecificDate`. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `validityPeriodProrationOption` 'ProrateUnits' | 'NoProrate' — Controls what happens to units when a validity period (VP) is partial. Possible values are: * `ProrateUnits` - Grant partial units, the number is prorated based on the overlap ratio. * `NoProrate` - Grant full units. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `taxCode` string — The tax code of a charge. This field is available when the `taxable` field is set to `true`. - `taxMode` 'TaxInclusive' | 'TaxExclusive' — The tax mode of a charge. This field is available when the `taxable` field is set to `true`. - `taxable` boolean — The flag indicates whether the charge is taxable. If this field is set to `true`, you must specify the `taxCode` and `taxMode` fields. - `clearingExistingFeatures` boolean — Specifies whether all features in the rate plan will be cleared. - `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. - `isAddingSubsetCharges` boolean — Specifies whether to add a subset of charges to the subscription. **Note:** To access this field for adding a subset of charges, submit a request at Zuora Global Support. - `isFromExternalCatalog` boolean — Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog. **Note:** This field is available when the Standalone Orders feature is enabled. - `productRatePlanId` string, required — Internal identifier of the product rate plan that the rate plan is based on. - `productRatePlanNumber` string — Number of a product rate plan for this subscription. - `ratePlanName` string — Name of the standalone rate plan. **Note:** This field is available when the Standalone Orders feature is enabled. - `subscriptionProductFeatures` CreateOrderRatePlanFeatureOverride[] — 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. - `customFields` RatePlanFeatureOverrideCustomFields — A container for custom fields of the feature. - `description` string — A description of the feature. - `featureId` string, required — Internal identifier of the feature in the product catalog. - `uniqueToken` string — 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. - `subscriptionRatePlanNumber` string — Number of a subscription rate plan for this subscription. - `cancelSubscription` CancelSubscription — Information about an order action of type `CancelSubscription`. - `cancellationEffectiveDate` string, date - `cancellationPolicy` 'EndOfCurrentTerm' | 'EndOfLastInvoicePeriod' | 'SpecificDate', required - `changePlan` PreviewOrderCreateChangePlan — Information about an order action of type `ChangePlan`. Use the change plan type of order action to replace the existing rate plans in a subscription with other rate plans. **Note**: The change plan type of order action is supported for the Order to Revenue feature. However, it is currently not supported for the Billing - Revenue Integration feature. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing. If you want to create a pending order through the "change plan" order action, and if the charge's trigger condition is `Specific Date`, you must set a charge number in the `chargeNumber` field for the "change plan" order action. In this case, if you do not set it, Zuora will not generate the charge number for you. See more information about pending orders in Pending orders and subscriptions. - `effectivePolicy` 'EffectiveImmediately' | 'EffectiveEndOfBillingPeriod' | 'SpecificDate' — 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. **Notes**: * 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 - `externalCatalogPlanId` string — An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case. **Note:** Please provide only one of `externalCatalogPlanId`, `ratePlanId` or `productRatePlanId`. If more than 1 field is provided then the request would fail. - `newProductRatePlan` PreviewOrderChangePlanRatePlanOverride, required — Information about the new product rate plan to add. - `chargeOverrides` PreviewOrderChangePlanChargeOverride[] — List of charges associated with the rate plan. - `accountReceivableAccountingCode` string — The accountReceivableAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled. - `adjustmentLiabilityAccountingCode` string — The adjustmentLiabilityAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `adjustmentRevenueAccountingCode` string — The adjustmentRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `billing` object — Billing information about the charge. - … - `chargeFunction` 'CommitmentTrueUp' | 'CreditCommitment' — **Note**: This field is only available if you have both the Prepaid with Drawdown and Standalone Orders features enabled. With this field, you can use a standalone order to subscribe to a minimum commitment subscription. This field defines what type of charge it is: * CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge. * CreditCommitment: For usage charges. Credit to minimum commitment funds. - `creditOption` 'TimeBased' | 'ConsumptionBased' | 'FullCreditBack' — **Note**: This field is only available if you have both the Minimum Commitment and Standalone Orders features enabled. With this field, you can use a standalone order to subscribe to a minimum commitment subscription. This field defines the way to calculate credit. See [Credit Option](https://docs.zuora.com?resourceId=billing-prepayment-charge) for more information. - `chargeModel` string — The chargeModel of a standalone charge. Supported charge models: * `FlatFee` * `PerUnit` * `Volume` * `Tiered` * `DiscountFixedAmount` * `DiscountPercentage` **Note:** This field is available when the Standalone Orders feature is enabled. - `chargeNumber` string — 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-. - `chargeType` string — The chargeType of a standalone charge. Supported charge types: * `OneTime` * `Recurring` * `Usage` **Note:** This field is available when the Standalone Orders feature is enabled. - `contractAssetAccountingCode` string — The contractAssetAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `contractLiabilityAccountingCode` string — The contractLiabilityAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `contractRecognizedRevenueAccountingCode` string — The contractRecognizedRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `customFields` RatePlanChargeObjectCustomFields — Container for custom fields of a Rate Plan Charge object. - `deferredRevenueAccountingCode` string — The deferredRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled. - `description` string — Description of the charge. - `drawdownPriority` integer — Drawdown priority for consumption ordering. Lower value means that it will be consumed first. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `drawdownRate` number — **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. The [conversion rate](https://docs.zuora.com?resourceId=billing-create-drawdown-charge) between Usage UOM and Drawdown UOM for a [drawdown charge](https://docs.zuora.com?resourceId=billing-create-drawdown-charge). Must be a positive number (>0). - `drawdownScope` 'SUBSCRIPTION' | 'ACCOUNT' — The scope in which the funds are applicable for the usage drawdown charges during drawdown. Valid for the charge with function of `Prepayment`. - `SUBSCRIPTION` - only usage charges of the same subscription can be drawn down. - `ACCOUNT` - only usage charges in the same account (subscription owner) can be drawn down. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `endDate` EndConditions — Specifies when a charge becomes inactive. - … - `estimatedStartDate` string, date — The estimated start date of the pending charge in an active subscription. If you specify `SpecificDate` in the `startDate` > `triggerEvent` field and want to create a completed order and an active subscription, you must specify either the `estimatedStartDate` or `startDate` > `specificTriggerDate` field: - `estimatedStartDate`: The charge will be in pending status. - `specificTriggerDate`: The charge will be in active status. The value of this field must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge. **Note:** This field is available only when the Pending Subscription Processing feature is turned on. - `excludeItemBillingFromRevenueAccounting` boolean — The flag to exclude rate plan charge 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](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `excludeItemBookingFromRevenueAccounting` boolean — The flag to exclude rate plan charges from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `fundSupportAccountHierarchy` boolean — Indicates whether to enable sub-account's usage to drawdown from the parent's funds. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `isAllocationEligible` boolean — This field is used to identify if the charge segment is allocation eligible in revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. - `isRollover` boolean — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The value is either "True" or "False". It determines whether the rollover fields are needed. - `isUnbilled` boolean — This field is used to dictate how to perform the accounting during revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. - `negotiatedPriceTable` NegotiatedItems[] — Array of negotiated price table information. The rate card entries provided in the array will override the existing rate card entries in the standard price table to form a negotiated price table that will be used during pricing evaluation. **Note:** To enable the Negotiated Price Table feature, submit a request to Zuora Global Support. - … - `name` string — The name of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `pobPolicy` string — The pobPolicy of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `prepaidQuantity` number — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The number of units included in a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). Must be a positive number (>0). - `prepaymentUnitType` 'UNIT' — The unit type of the prepayment charge. For topup (recurring/one-time) charges, this field indicates what type of funds are created. For drawdown (usage) charges, this field indicates what type of funds are drawn down from those created by topup charges. **Note:** This field is only available if you have the Prepaid with Drawdown feature enabled. - `pricing` object — Pricing information about the charge. - … - `pricingAttributes` object — Container for pricing attribute and value that provide additional context for dynamic pricing. The pricing attribute values are used to get the charge’s list price from the product catalog. For the pricing attribute mapped to a Zuora object field, Zuora will retrieve the value automatically, you don’t need to pass its value explicitly. If you pass a value that doesn’t match the actual value of the Zuora object, an error will be returned. Note that for any pricing attribute mapped to the field of Zuora object Usage, because its value is only determined when the usage record arrives, you can’t provide a value via Orders API payload and Zuora will not retrieve its value automatically. **Note:** To enable Dynamic Pricing, submit a request to Zuora Global Support. - `productCategory` string — The productCategory of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productClass` string — The productClass of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productFamily` string — The productFamily of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productLine` string — The productLine of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productRatePlanChargeId` string, required — Internal identifier of the product rate plan charge that the charge is based on. You can specify either `productRatePlanChargeId` or `productRatePlanChargeNumber`. When subscribing to a hard bundle, include the optional component charge’s ID explicitly in order to add it to the subscription. When `isAddingSubsetCharges` is set to true, the product rate charge specified by `productRatePlanChargeId` is added to the existing rate plan specified by `ratePlanId`. **Note**: The **Hard Bundle** feature is in the **Early Availability** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early availability program, submit a request at Zuora Global Support. - `productRatePlanChargeNumber` string — Number of a product rate-plan charge for this subscription. - `prorationOption` 'NoProration' | 'TimeBasedProration' | 'DefaultFromTenantSetting' | 'ChargeFullPeriod' | 'CustomizeProrationOptionOverrides' — **Note**: This field is only available if you have the **Charge Level Proration** feature enabled. For more information, see Usage charge proration and Charge level proration option for a recurring charge. You can use this field to specify the charge-level proration option for a usage charge or recurring charge when you create or add a subscription rate plan charge through an order. The tenant-level proration option will be overridden. * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge. * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period. * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting. * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period. * `CustomizeProrationOptionOverrides`: charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the `ratingPropertiesOverride` field. When the Enhanced Unit-Based Prepaid with Drawdown feature is enabled, the possible options are: - DefaultFromTenantSetting - CustomizeProrationOptionOverrides. When `CustomizeProrationOptionOverrides` is selected, define the customization rules using these options in the `ratingPropertiesOverride` field. - `ratingPropertiesOverride` object — **Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge. This field is used only when the value of the `prorationOption` field is set to `CustomizeProrationOptionOverrides`. Use this field to specify more customized proration options for a recurring charge when you creating or adding a subscription rate plan charge through an order. The tenant-level proration option will be overridden. - … - `recognizedRevenueAccountingCode` string — The recognizedRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled. - `revRecCode` string — Revenue Recognition Code - `revRecTriggerCondition` 'Contract Effective Date' | 'Service Activation Date' | 'Customer Acceptance Date' — Specifies the revenue recognition trigger condition. * `Contract Effective Date` * `Service Activation Date` * `Customer Acceptance Date` - `revenueRecognitionRuleName` string — Specifies the revenue recognition rule, such as `Recognize upon invoicing` or `Recognize daily over time`. - `revenueRecognitionTiming` 'Upon Billing Document Posting Date' | 'Upon Order Activation Date' — 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 both the Order to Revenue feature and the Standalone Orders feature enabled. - `revenueAmortizationMethod` 'Immediate' | 'Ratable Using Start And End Dates' — Specifies the type of revenue amortization method. 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 both the Order to Revenue feature and the Standalone Orders feature enabled. - `rolloverApply` 'ApplyFirst' | 'ApplyLast' — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. This field defines the priority of rollover, which is either first or last. - `rolloverEndDate` string, date — Explicit cutoff date when `rolloverEndDateType` is `SpecificDate`. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `rolloverEndDateType` 'ChargeEndDate' | 'SubscriptionTerm' | 'SpecificDate' — Rollover cutoff strategy determining when the rollover eligibility will end. Possible values are: * `ChargeEndDate` - Rollover stops at the charge end date. * `SubscriptionTerm` - Rollover stops at the subscription term end. * `SpecificDate` - Rollover stops at an explicit date specified in `RolloverEndDate`. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `rolloverFundPriority` integer — Priority for rolled-over funds. Lower value means that it will be consumed first. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `rolloverPeriodLength` integer — **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. The period length of the rollover fund. When the **Enhanced Unit-Based Prepaid with Drawdown** feature is enabled, you can customize a single rollover period length together with `rolloverPeriodType` field. - `rolloverPeriods` number — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. This field defines the number of rollover periods, it is restricted to 3. - `rolloverPeriodType` 'Day' | 'Month' | 'Quarter' | 'Annual' — Unit for rollover period length. Possible values are: * `Day` - Day-based rollover periods. * `Month` - Month-based rollover periods. * `Quarter` - Quarter-based rollover periods. * `Annual` - Annual rollover periods. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `specificValidityPeriodLength` integer — The number of days, weeks, or months for the validity period when `ValidityPeriodType` is `SPECIFIC_DAYS`, `SPECIFIC_WEEKS`, or `SPECIFIC_MONTHS`. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `startDate` CreateOrderTriggerParams — Specifies when a charge becomes active. - … - `taxCode` string — The taxCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `taxMode` string — The taxMode of a standalone charge. Values: * `TaxExclusive` * `TaxInclusive` **Note:** This field is available when the Standalone Orders feature is enabled. - `unBilledReceivablesAccountingCode` string — The unBilledReceivablesAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `uniqueToken` string — 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. - `upsellOriginChargeNumber` string — The identifier of the original upselling charge associated with the current charge. For a termed subscription, you can now use the "Create an order" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows: * Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell. * In the preceding charge to add, use the `upsellOriginChargeNumber` field to specify the existing rate plan charge for which you want to make the quantity upsell. Note that a termed subscription with such upsell charges can not be changed to an evergreen subscription. **Note**: The Quantity Upsell feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](https://support.zuora.com). - `validityPeriodType` 'SUBSCRIPTION_TERM' | 'ANNUAL' | 'SEMI_ANNUAL' | 'QUARTER' | 'MONTH' — **Note**: 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](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover), 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. * When **Enhanced Unit-Based Prepaid with Drawdown** feature is enabled, you can also choose from the following options: `SPECIFIC_DAYS`, `SPECIFIC_WEEKS`, `SPECIFIC_MONTHS`. Specify the actual number in `specificValidityPeriodLength` field - `validityPeriodAlignment` 'ChargeStart' | 'TermStart' | 'TermEnd' | 'SpecificDate' — Determines the anchor date for validity period (VP) boundaries. The anchor date defines the recurring grid — VP boundaries fall at every VP-length step from the anchor. The charge's start and end dates then determine which portion of this grid is covered. Possible values are: * `ChargeStart` (default) - Anchor date is the charge start date. Simplest option with no partial first VP. * `TermStart` - Anchor date is the subscription term start date. Aligns all charges on the same subscription to a common grid. * `TermEnd` - Anchor date is derived by walking backward from the subscription term end date. Last VP always ends cleanly at term end; partial VP (if any) is at the start. * `SpecificDate` - Anchor date is an explicit `validityPeriodAnchorDate` on the charge. Custom alignment for special billing arrangements. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `validityPeriodAnchorDate` string, date — The anchor date for validity period alignment. Required when `validityPeriodAlignment` is `SpecificDate`. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `validityPeriodProrationOption` 'ProrateUnits' | 'NoProrate' — Controls what happens to units when a validity period (VP) is partial. Possible values are: * `ProrateUnits` - Grant partial units, the number is prorated based on the overlap ratio. * `NoProrate` - Grant full units. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `clearingExistingFeatures` boolean — Specifies whether all features in the rate plan will be cleared. - `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. - `externalCatalogPlanId` string — 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. - `externallyManagedPlanId` string — 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. - `subscriptionRatePlanNumber` string — Number of a subscription rate plan for this subscription. - `isFromExternalCatalog` boolean — Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog. **Note:** This field is available when the Standalone Orders feature is enabled. - `productRatePlanId` string — Internal identifier of the product rate plan that the rate plan is based on. - `productRatePlanNumber` string — Number of a product rate plan for this subscription. - `ratePlanName` string — Name of the standalone rate plan. **Note:** This field is available when the Standalone Orders feature is enabled. - `subscriptionProductFeatures` CreateOrderRatePlanFeatureOverride[] — 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. - `customFields` RatePlanFeatureOverrideCustomFields — A container for custom fields of the feature. - `description` string — A description of the feature. - `featureId` string, required — Internal identifier of the feature in the product catalog. - `uniqueToken` string — 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. - `productRatePlanId` string — ID of the product rate plan that the removed rate plan is based on. - `productRatePlanNumber` string — Number of a product rate plan for this subscription. - `ratePlanId` string — 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. - `resetBcd` boolean — 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. - `subType` 'Upgrade' | 'Downgrade' | 'Crossgrade' | 'PlanChanged' — 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". - `subscriptionRatePlanNumber` string — Number of a rate plan for this subscription. - `changeReason` string — The change reason set for an order action when an order is created. - `createSubscription` PreviewOrderCreateSubscription — Information about an order action of type `CreateSubscription`. - `billToContact` CreateAccountContact — Container for bill-to/sold-to/ship-to contact information for this account. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `city` string — City, 100 characters or less. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. - `county` string — County; 100 characters or less. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string, required — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `lastName` string, required — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number. - `personalEmail` string, email — Personal email address, 80 characters or less. - `postalCode` string — Postal code, 20 characters or less. - `state` string — State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. - `workEmail` string, email — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `contactDescription` string — A description for the contact. - `billToContactId` string — 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. - `currency` string — 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. - `invoiceGroupNumber` string, nullable — The number of the invoice group associated with the subscription. After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://docs.zuora.com?resourceId=billing-invoice-grouping). **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 during subscription creation, the value of this field is automatically set to `null` in the response body. - `invoiceSeparately` boolean — Specifies whether the subscription appears on a separate invoice when Zuora generates invoices. - `invoiceTemplateId` string — 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. - `newSubscriptionOwnerAccount` object — Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature. If you do not set this field or the `subscriptionOwnerAccountNumber` field, the account that owns the order will also own the subscription. Zuora will return an error if you set this field and the `subscriptionOwnerAccountNumber` field. - `accountNumber` string — Account number. For example, A00000001. - `additionalEmailAddresses` string — List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses. - `allowInvoiceEdit` boolean — Indicates if associated invoices can be edited. Values are: * `true` * `false` (default) - `autoPay` boolean — Specifies whether future payments are automatically billed when they are due. - `batch` string — Name of the billing batch that the account belongs to. For example, Batch1. - `billCycleDay` integer, required — Day of the month that the account prefers billing periods to begin on. If set to 0, the bill cycle day will be set as "AutoSet". - `billToContact` BillToContactPostOrder, required — Container for custom fields of a Contact object. - `address1` string — First line of the contact's address. This is often a street address or a business name. - `address2` string — Second line of the contact's address. - `city` string — City of the contact's address. - `contactDescription` string — A description for the contact. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the bill-to contact to calculate tax. - `county` string — County of the contact's address. - `fax` string — Fax number of the contact. - `firstName` string, required — First name of the contact. - `homePhone` string — Home phone number of the contact. - `lastName` string, required — Last name of the contact. - `mobilePhone` string — Mobile phone number of the contact. - `nickname` string — Nickname of the contact. - `otherPhone` string — Additional phone number of the contact. Use the `otherPhoneType` field to specify the type of phone number. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number in the `otherPhone` field. - `personalEmail` string, email — Personal email address of the contact. - `postalCode` string — ZIP code or other postal code of the contact's address. - `state` string — State or province of the contact's address. - `taxRegion` string, nullable — Region defined in your taxation rules. Only applicable if you use Zuora Tax. - `workEmail` string, email — Business email address of the contact. - `workPhone` string — Business phone number of the contact. - `communicationProfileId` string — Internal identifier of the communication profile that Zuora uses when sending notifications to the account's contacts. - `creditCard` CreditCard — Default payment method associated with an account. Only credit card payment methods are supported. - `cardHolderInfo` AccountCreditCardHolder — Information about the cardholder of a credit card payment method associated with an account. If you do not provide information about the cardholder, Zuora uses the account's bill-to contact. - … - `cardNumber` string — Card number. Once set, you cannot update or query the value of this field. The value of this field is only available in masked format. For example, XXXX-XXXX-XXXX-1234 (hyphens must not be used when you set the credit card number). - `cardType` 'Visa' | 'MasterCard' | 'AmericanExpress' | 'Discover' | 'JCB' | 'Diners' | 'CUP' | 'Maestro' | 'Electron' | 'AppleVisa' | 'AppleMasterCard' | 'AppleAmericanExpress' | 'AppleDiscover' | 'AppleJCB' | 'Elo' | 'Hipercard' | 'Naranja' | 'Nativa' | 'TarjetaShopping' | 'Cencosud' | 'Argencard' | 'Cabal' — Type of card. - `expirationMonth` integer — Expiration date of the card. - `expirationYear` integer — Expiration year of the card. - `securityCode` string — CVV or CVV2 security code of the card. To ensure PCI compliance, Zuora does not store the value of this field. - `creditMemoTemplateId` string — **Note:** This field is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-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. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b. - `crmId` string — External identifier of the account in a CRM system. - `currency` string, required — ISO 3-letter currency code (uppercase). For example, USD. - `customFields` AccountObjectCustomFields — Container for custom fields of an Account object. - `customerServiceRepName` string — Name of the account's customer service representative, if applicable. - `debitMemoTemplateId` string — **Note:** This field is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-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. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2. - `hpmCreditCardPaymentMethodId` string — The ID of the payment method associated with this account. The payment method specified for this field will be set as the default payment method of the account. If the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field, but not both. For a specified credit card payment method, it is recommended that [the support for stored credential transactions](https://docs.zuora.com?resourceId=payments-stored-credential-transactions) for this payment method is already enabled. - `invoiceDeliveryPrefsEmail` boolean — Specifies whether to turn on the invoice delivery method 'Email' for the new account. Values are: * `true` (default). Turn on the invoice delivery method 'Email' for the new account. * `false`. Turn off the invoice delivery method 'Email' for the new account. - `invoiceDeliveryPrefsPrint` boolean — Specifies whether to turn on the invoice delivery method 'Print' for the new account. Values are: * `true`. Turn on the invoice delivery method 'Print' for the new account. * `false` (default). Turn off the invoice delivery method 'Print' for the new account. - `invoiceTemplateId` string — Internal identifier of the invoice template that Zuora uses when generating invoices for the account. - `name` string, required — Account name. - `notes` string — Notes about the account. These notes are only visible to Zuora users. - `parentId` string — Identifier of the parent customer account for this Account object. Use this field if you have Customer Hierarchy enabled. - `paymentGateway` string — The payment gateway that Zuora uses when processing electronic payments and refunds for the account. If you do not specify this field or if the value of this field is null, Zuora uses your default payment gateway. - `paymentMethod` union — Payment method information associated with an account. - object — Container for custom fields of a payment method object. - … - object — Container for custom fields of a payment method object. - … - object — Container for custom fields of a payment method object. - … - object — Container for custom fields of a payment method object. - … - object — Container for custom fields of a payment method object. - … - object — Container for custom fields of a payment method object. - … - object — Container for custom fields of a payment method object. - … - object — Container for custom fields of a payment method object. - … - object — Container for custom fields of a payment method object. - … - object — Container for custom fields of a payment method object. - … - object — Container for custom fields of a payment method object. - … - object — Container for custom fields of a payment method object. - … - object — Container for custom fields of a payment method object. - … - object — Container for custom fields of a payment method object. - … - object - … - object - … - object - … - `paymentTerm` string — Name of the payment term associated with the account. For example, "Net 30". The payment term determines the due dates of invoices. - `purchaseOrderNumber` string — The number of the purchase order associated with this account. Purchase order information generally comes from customers. - `salesRep` string — The name of the sales representative associated with this account, if applicable. - `soldToContact` SoldToContactPostOrder — Container for custom fields of a Contact object. - `address1` string — First line of the contact's address. This is often a street address or a business name. - `address2` string — Second line of the contact's address. - `city` string — City of the contact's address. - `contactDescription` string — A description for the contact. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. - `county` string — County of the contact's address. - `fax` string — Fax number of the contact. - `firstName` string, required — First name of the contact. - `homePhone` string — Home phone number of the contact. - `lastName` string, required — Last name of the contact. - `mobilePhone` string — Mobile phone number of the contact. - `nickname` string — Nickname of the contact. - `otherPhone` string — Additional phone number of the contact. Use the `otherPhoneType` field to specify the type of phone number. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number in the `otherPhone` field. - `personalEmail` string, email — Personal email address of the contact. - `postalCode` string — ZIP code or other postal code of the contact's address. - `state` string — State or province of the contact's address. - `taxRegion` string, nullable — Region defined in your taxation rules. Only applicable if you use Zuora Tax. - `workEmail` string, email — Business email address of the contact. - `workPhone` string — Business phone number of the contact. - `taxInfo` TaxInfo — Information about the tax exempt status of a customer account. - `VATId` string — EU Value Added Tax ID. **Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). - `companyCode` string — Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara. **Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). - `exemptCertificateId` string — ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines. - `exemptCertificateType` string — Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines. - `exemptDescription` string — Description of the tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines. - `exemptEffectiveDate` string, date — Date when the customer tax exemption starts, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines. - `exemptExpirationDate` string, date — Date when the customer tax exemption expires, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines. - `exemptIssuingJurisdiction` string — Jurisdiction in which the customer tax exemption certificate was issued. - `exemptStatus` 'No' | 'Yes' | 'PendingVerification' — Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax. - `notes` string — Notes about the subscription. These notes are only visible to Zuora users. - `paymentTerm` string — 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. - `sequenceSetId` string, nullable — 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. - `shipToContact` CreateAccountContact — Container for bill-to/sold-to/ship-to contact information for this account. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `city` string — City, 100 characters or less. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. - `county` string — County; 100 characters or less. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string, required — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `lastName` string, required — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number. - `personalEmail` string, email — Personal email address, 80 characters or less. - `postalCode` string — Postal code, 20 characters or less. - `state` string — State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. - `workEmail` string, email — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `contactDescription` string — A description for the contact. - `shipToContactId` string — The ID of the ship-to contact associated with the subscription. It must be a contact of the subscription owner. **Note**: To access this field, you must have the ShipToContactSupport permission. If you want to enable this permission, submit a request at Zuora Global Support. - `soldToContact` CreateAccountContact — Container for bill-to/sold-to/ship-to contact information for this account. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `city` string — City, 100 characters or less. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. - `county` string — County; 100 characters or less. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string, required — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `lastName` string, required — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number. - `personalEmail` string, email — Personal email address, 80 characters or less. - `postalCode` string — Postal code, 20 characters or less. - `state` string — State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. - `workEmail` string, email — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `contactDescription` string — A description for the contact. - `soldToContactId` string — 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. - `subscribeToRatePlans` PreviewOrderRatePlanOverride[] — List of rate plans associated with the subscription. - `chargeOverrides` PreviewOrderChargeOverride[] — List of charges associated with the rate plan. - `accountReceivableAccountingCode` string — The accountReceivableAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled. - `adjustmentLiabilityAccountingCode` string — The adjustmentLiabilityAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `adjustmentRevenueAccountingCode` string — The adjustmentRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `billing` object — Billing information about the charge. - … - `chargeFunction` 'CommitmentTrueUp' | 'CreditCommitment' — **Note**: This field is only available if you have both the Prepaid with Drawdown and Standalone Orders features enabled. With this field, you can use a standalone order to subscribe to a minimum commitment subscription. This field defines what type of charge it is: * CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge. * CreditCommitment: For usage charges. Credit to minimum commitment funds. - `creditOption` 'TimeBased' | 'ConsumptionBased' | 'FullCreditBack' — **Note**: This field is only available if you have both the Minimum Commitment and Standalone Orders features enabled. With this field, you can use a standalone order to subscribe to a minimum commitment subscription. This field defines the way to calculate credit. See [Credit Option](https://docs.zuora.com?resourceId=billing-prepayment-charge) for more information. - `chargeModel` string — The chargeModel of a standalone charge. Supported charge models: * `FlatFee` * `PerUnit` * `Volume` * `Tiered` * `DiscountFixedAmount` * `DiscountPercentage` **Note:** This field is available when the Standalone Orders feature is enabled. - `chargeNumber` string — 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-. - `chargeType` string — The chargeType of a standalone charge. Supported charge types: * `OneTime` * `Recurring` * `Usage` **Note:** This field is available when the Standalone Orders feature is enabled. - `contractAssetAccountingCode` string — The contractAssetAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `contractLiabilityAccountingCode` string — The contractLiabilityAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `contractRecognizedRevenueAccountingCode` string — The contractRecognizedRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `customFields` RatePlanChargeObjectCustomFields — Container for custom fields of a Rate Plan Charge object. - `deferredRevenueAccountingCode` string — The deferredRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled. - `description` string — Description of the charge. - `drawdownRate` number — **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. The [conversion rate](https://docs.zuora.com?resourceId=billing-create-drawdown-charge) between Usage UOM and Drawdown UOM for a [drawdown charge](https://docs.zuora.com?resourceId=billing-create-drawdown-charge). Must be a positive number (>0). - `drawdownScope` 'SUBSCRIPTION' | 'ACCOUNT' — The scope in which the funds are applicable for the usage drawdown charges during drawdown. Valid for the charge with function of `Prepayment`. - `SUBSCRIPTION` - only usage charges of the same subscription can be drawn down. - `ACCOUNT` - only usage charges in the same account (subscription owner) can be drawn down. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `drawdownPriority` integer — Drawdown priority for consumption ordering. Lower value means that it will be consumed first. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `endDate` EndConditions — Specifies when a charge becomes inactive. - … - `estimatedStartDate` string, date — The estimated start date of the pending charge in an active subscription. If you specify `SpecificDate` in the `startDate` > `triggerEvent` field and want to create a completed order and an active subscription, you must specify either the `estimatedStartDate` or `startDate` > `specificTriggerDate` field: - `estimatedStartDate`: The charge will be in pending status. - `specificTriggerDate`: The charge will be in active status. The value of this field must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge. **Note:** This field is available only when the Pending Subscription Processing feature is turned on. - `excludeItemBillingFromRevenueAccounting` boolean — 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](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `excludeItemBookingFromRevenueAccounting` boolean — 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](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `fundSupportAccountHierarchy` boolean — Indicates whether to enable sub-account's usage to drawdown from the parent's funds. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `isAllocationEligible` boolean — This field is used to identify if the charge segment is allocation eligible in revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. - `isRollover` boolean — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The value is either "True" or "False". It determines whether the rollover fields are needed. - `isUnbilled` boolean — This field is used to dictate how to perform the accounting during revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. - `name` string — The name of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `negotiatedPriceTable` NegotiatedItems[] — Array of negotiated price table information. The rate card entries provided in the array will override the existing rate card entries in the standard price table to form a negotiated price table that will be used during pricing evaluation. **Note:** To enable the Negotiated Price Table feature, submit a request to Zuora Global Support. - … - `pobPolicy` string — The pobPolicy of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `prepaidQuantity` number — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The number of units included in a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). Must be a positive number (>0). - `prepaymentUnitType` 'UNIT' — The unit type of the prepayment charge. For topup (recurring/one-time) charges, this field indicates what type of funds are created. For drawdown (usage) charges, this field indicates what type of funds are drawn down from those created by topup charges. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `pricing` object — Pricing information about the charge. - … - `pricingAttributes` object — Container for pricing attribute and value that provide additional context for dynamic pricing. The pricing attribute values are used to get the charge’s list price from the product catalog. For the pricing attribute mapped to a Zuora object field, Zuora will retrieve the value automatically, you don’t need to pass its value explicitly. If you pass a value that doesn’t match the actual value of the Zuora object, an error will be returned. Note that for any pricing attribute mapped to the field of Zuora object Usage, because its value is only determined when the usage record arrives, you can’t provide a value via Orders API payload and Zuora will not retrieve its value automatically. **Note:** To enable Dynamic Pricing, submit a request to Zuora Global Support. - `productCategory` string — The productCategory of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productClass` string — The productClass of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productFamily` string — The productFamily of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productLine` string — The productLine of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productRatePlanChargeId` string, required — Internal identifier of the product rate plan charge that the charge is based on. You can specify either `productRatePlanChargeId` or `productRatePlanChargeNumber`. When subscribing to a hard bundle, include the optional component charge’s ID explicitly in order to add it to the subscription. When `isAddingSubsetCharges` is set to true, the product rate charge specified by `productRatePlanChargeId` is added to the existing rate plan specified by `ratePlanId`. **Note**: The **Hard Bundle** feature is in the **Early Availability** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early availability program, submit a request at Zuora Global Support. - `productRatePlanChargeNumber` string — Number of a product rate-plan charge for this subscription. - `prorationOption` 'NoProration' | 'TimeBasedProration' | 'DefaultFromTenantSetting' | 'ChargeFullPeriod' | 'CustomizeProrationOptionOverrides' — **Note**: This field is only available if you have the **Charge Level Proration** feature enabled. For more information, see Usage charge proration and Charge level proration option for a recurring charge. You can use this field to specify the charge-level proration option for a usage charge or recurring charge when you create or add a subscription rate plan charge through an order. The tenant-level proration option will be overridden. * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge. * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period. * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting. * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period. * `CustomizeProrationOptionOverrides`: charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the `ratingPropertiesOverride` field. When the Enhanced Unit-Based Prepaid with Drawdown feature is enabled, the possible options are: - DefaultFromTenantSetting - CustomizeProrationOptionOverrides. When `CustomizeProrationOptionOverrides` is selected, define the customization rules using these options in the `ratingPropertiesOverride` field. - `ratingPropertiesOverride` object — **Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge. This field is used only when the value of the `prorationOption` field is set to `CustomizeProrationOptionOverrides`. Use this field to specify more customized proration options for a recurring charge when you creating or adding a subscription rate plan charge through an order. The tenant-level proration option will be overridden. - … - `recognizedRevenueAccountingCode` string — The recognizedRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled. - `revRecCode` string — Revenue Recognition Code - `revRecTriggerCondition` 'Contract Effective Date' | 'Service Activation Date' | 'Customer Acceptance Date' — Specifies the revenue recognition trigger condition. * `Contract Effective Date` * `Service Activation Date` * `Customer Acceptance Date` - `revenueRecognitionRuleName` string — Specifies the revenue recognition rule, such as `Recognize upon invoicing` or `Recognize daily over time`. - `revenueRecognitionTiming` 'Upon Billing Document Posting Date' | 'Upon Order Activation Date' — 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 both the Order to Revenue feature and the Standalone Orders feature enabled. - `revenueAmortizationMethod` 'Immediate' | 'Ratable Using Start And End Dates' — Specifies the type of revenue amortization method. 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 both the Order to Revenue feature and the Standalone Orders feature enabled. - `rolloverApply` 'ApplyFirst' | 'ApplyLast' — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. This field defines the priority of rollover, which is either first or last. - `rolloverEndDate` string, date — Explicit cutoff date when `rolloverEndDateType` is `SpecificDate`. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `rolloverEndDateType` 'ChargeEndDate' | 'SubscriptionTerm' | 'SpecificDate' — Rollover cutoff strategy determining when the rollover eligibility will end. Possible values are: * `ChargeEndDate` - Rollover stops at the charge end date. * `SubscriptionTerm` - Rollover stops at the subscription term end. * `SpecificDate` - Rollover stops at an explicit date specified in `RolloverEndDate`. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `rolloverFundPriority` integer — Priority for rolled-over funds. Lower value means that it will be consumed first. When Enhanced Unit-Based Prepaid with Drawdown feature is enabled, you can customize a single rollover period length together with `rolloverPeriodType` field. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `rolloverPeriodLength` integer — **Note**: This field is only available if you have the Enhanced Unit-Based 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. When the **Enhanced Unit-Based Prepaid with Drawdown** feature is enabled, you can customize a single rollover period length together with `rolloverPeriodType` field. - `rolloverPeriods` number — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. This field defines the number of rollover periods, it is restricted to 3. - `rolloverPeriodType` 'Day' | 'Month' | 'Quarter' | 'Annual' — Unit for rollover period length. Possible values are: * `Day` - Day-based rollover periods. * `Month` - Month-based rollover periods. * `Quarter` - Quarter-based rollover periods. * `Annual` - Annual rollover periods. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `startDate` PreviewOrderTriggerParams — Specifies when a charge becomes active. - … - `unBilledReceivablesAccountingCode` string — The unBilledReceivablesAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `uniqueToken` string — 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. - `upsellOriginChargeNumber` string — The identifier of the original upselling charge associated with the current charge. For a termed subscription, you can now use the "Create an order" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows: * Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell. * In the preceding charge to add, use the `upsellOriginChargeNumber` field to specify the existing rate plan charge for which you want to make the quantity upsell. Note that a termed subscription with such upsell charges can not be changed to an evergreen subscription. **Note**: The Quantity Upsell feature is in the **Early Adopter** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](https://support.zuora.com). - `validityPeriodType` 'SUBSCRIPTION_TERM' | 'ANNUAL' | 'SEMI_ANNUAL' | 'QUARTER' | 'MONTH' — **Note**: 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](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover), 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. * When **Enhanced Unit-Based Prepaid with Drawdown** feature is enabled, you can also choose from the following options: `SPECIFIC_DAYS`, `SPECIFIC_WEEKS`, `SPECIFIC_MONTHS`. Specify the actual number in `specificValidityPeriodLength` field. - `specificValidityPeriodLength` integer — The number of days, weeks, or months for the validity period when `ValidityPeriodType` is `SPECIFIC_DAYS`, `SPECIFIC_WEEKS`, or `SPECIFIC_MONTHS`. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `validityPeriodAlignment` 'ChargeStart' | 'TermStart' | 'TermEnd' | 'SpecificDate' — Determines the anchor date for validity period (VP) boundaries. The anchor date defines the recurring grid — VP boundaries fall at every VP-length step from the anchor. The charge's start and end dates then determine which portion of this grid is covered. Possible values are: * `ChargeStart` (default) - Anchor date is the charge start date. Simplest option with no partial first VP. * `TermStart` - Anchor date is the subscription term start date. Aligns all charges on the same subscription to a common grid. * `TermEnd` - Anchor date is derived by walking backward from the subscription term end date. Last VP always ends cleanly at term end; partial VP (if any) is at the start. * `SpecificDate` - Anchor date is an explicit `validityPeriodAnchorDate` on the charge. Custom alignment for special billing arrangements. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `validityPeriodAnchorDate` string, date — The anchor date for validity period alignment. Required when `validityPeriodAlignment` is `SpecificDate`. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `validityPeriodProrationOption` 'ProrateUnits' | 'NoProrate' — Controls what happens to units when a validity period (VP) is partial. Possible values are: * `ProrateUnits` - Grant partial units, the number is prorated based on the overlap ratio. * `NoProrate` - Grant full units. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `taxCode` string — The tax code of a charge. This field is available when the `taxable` field is set to `true`. - `taxMode` 'TaxInclusive' | 'TaxExclusive' — The tax mode of a charge. This field is available when the `taxable` field is set to `true`. - `taxable` boolean — The flag indicates whether the charge is taxable. If this field is set to `true`, you must specify the `taxCode` and `taxMode` fields. - `clearingExistingFeatures` boolean — Specifies whether all features in the rate plan will be cleared. - `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. - `isAddingSubsetCharges` boolean — Specifies whether to add a subset of charges to the subscription. **Note:** To access this field for adding a subset of charges, submit a request at Zuora Global Support. - `isFromExternalCatalog` boolean — Indicates whether the rate plan is created from the Zuora product catalog or from an external product catalog. **Note:** This field is available when the Standalone Orders feature is enabled. - `productRatePlanId` string, required — Internal identifier of the product rate plan that the rate plan is based on. - `productRatePlanNumber` string — Number of a product rate plan for this subscription. - `ratePlanName` string — Name of the standalone rate plan. **Note:** This field is available when the Standalone Orders feature is enabled. - `subscriptionProductFeatures` CreateOrderRatePlanFeatureOverride[] — 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. - `customFields` RatePlanFeatureOverrideCustomFields — A container for custom fields of the feature. - `description` string — A description of the feature. - `featureId` string, required — Internal identifier of the feature in the product catalog. - `uniqueToken` string — 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. - `subscriptionRatePlanNumber` string — Number of a subscription rate plan for this subscription. - `subscriptionNumber` string — Subscription number of the subscription. For example, A-S00000001. If you do not set this field, Zuora will generate the subscription number. - `subscriptionOwnerAccountNumber` string — 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. - `invoiceOwnerAccountNumber` string — Account number of an existing account that will own the invoice. For example, A00000001. If you do not set this field, the account that owns the order will also own this invoice. - `terms` object — Container for the terms and renewal settings of the subscription. - `autoRenew` boolean — Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is `TERMED`. - `initialTerm` object, required — Information about the first term of the subscription. - `period` integer — 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`. - `periodType` 'Month' | 'Year' | 'Day' | 'Week' — Unit of time that the first term is measured in. Only applicable if the value of the `termType` field is `TERMED`. - `startDate` string, date — Start date of the first term, in YYYY-MM-DD format. - `endDate` string, date — End date of the first term, in YYYY-MM-DD format. - `termType` 'TERMED' | 'EVERGREEN', required — 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. - `renewalSetting` 'RENEW_WITH_SPECIFIC_TERM' | 'RENEW_TO_EVERGREEN' — 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. - `renewalTerms` RenewalTerm[] — 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`. - `period` integer — Duration of the renewal term in months, years, days, or weeks, depending on the value of the `periodType` field. - `periodType` 'Month' | 'Year' | 'Day' | 'Week' — Unit of time that the renewal term is measured in. - `customFields` OrderActionObjectCustomFields — Container for custom fields of an Order Action object. - `ownerTransfer` OwnerTransfer — Information about an order action of type `OwnerTransfer`. **Note:** The Owner Transfer feature is in **Limited Availability**. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). - `billToContact` CreateAccountContact — Container for bill-to/sold-to/ship-to contact information for this account. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `city` string — City, 100 characters or less. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. - `county` string — County; 100 characters or less. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string, required — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `lastName` string, required — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number. - `personalEmail` string, email — Personal email address, 80 characters or less. - `postalCode` string — Postal code, 20 characters or less. - `state` string — State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. - `workEmail` string, email — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `contactDescription` string — A description for the contact. - `billToContactId` string — The contact id of the bill to contact that the subscription is being transferred to. **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. - `clearingExistingBillToContact` boolean — 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. - `clearingExistingInvoiceGroupNumber` boolean — Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` 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. - `clearingExistingInvoiceTemplate` boolean — 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. - `clearingExistingPaymentTerm` boolean — 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. - `clearingExistingSequenceSet` boolean — 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. - `clearingExistingShipToContact` boolean — Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field. **Note:** To access this field, you must have the ShipToContactSupport permission. If you want to enable this permission, submit a request at Zuora Global Support. - `clearingExistingSoldToContact` boolean — 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. - `destinationAccountNumber` string — The account number of the account that the subscription is being transferred to. - `destinationInvoiceAccountNumber` string — The account number of the invoice owner account that the subscription is being transferred to. - `invoiceGroupNumber` string, nullable — The number of the invoice group associated with the subscription. After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://docs.zuora.com?resourceId=billing-invoice-grouping). **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 during subscription creation, the value of this field is automatically set to `null` in the response body. - `invoiceTemplateId` string — 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. - `paymentProfile` object — Container for payment gateway and payment method details of a payment. If you do not set this field, the payment method and payment gateway values cannot be set in the subscription. **Note:** - If multiple order actions are specified, they will be applied in the same order they appear in the API payload. - If one or more of these order actions include the `paymentProfile` element, the changes will be applied in sequence, and the result will be consistent with the last `paymentProfile` element. - `paymentGatewayId` string — The ID of the gateway instance that processes the payment. This field remains unset, if you do not provide value. - `paymentMethodId` string — The ID of the payment method. This field remains unset, if you do not provide value. - `paymentTerm` string — Name of the payment term associated with the account. 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. - `sequenceSetId` string, nullable — 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. - `shipToContact` CreateAccountContact — Container for bill-to/sold-to/ship-to contact information for this account. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `city` string — City, 100 characters or less. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. - `county` string — County; 100 characters or less. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string, required — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `lastName` string, required — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number. - `personalEmail` string, email — Personal email address, 80 characters or less. - `postalCode` string — Postal code, 20 characters or less. - `state` string — State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. - `workEmail` string, email — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `contactDescription` string — A description for the contact. - `shipToContactId` string — The ID of the ship-to contact associated with the subscription. **Note**: To access this field, you must have the ShipToContactSupport permission. If you want to enable this permission, submit a request at Zuora Global Support. - `soldToContact` CreateAccountContact — Container for bill-to/sold-to/ship-to contact information for this account. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `city` string — City, 100 characters or less. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. - `county` string — County; 100 characters or less. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string, required — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `lastName` string, required — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number. - `personalEmail` string, email — Personal email address, 80 characters or less. - `postalCode` string — Postal code, 20 characters or less. - `state` string — State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. - `workEmail` string, email — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `contactDescription` string — A description for the contact. - `soldToContactId` string — 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. - `removeProduct` RemoveProduct — Information about an order action of type `RemoveProduct`. - `externalCatalogPlanId` string — An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case. **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. - `productRatePlanNumber` string — Number of a product rate plan for this subscription. - `ratePlanId` string — ID of the rate plan to remove. This can be the latest version or any history version of ID. - `subscriptionRatePlanNumber` string — Number of a rate plan for this subscription. - `uniqueToken` string — 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. - `customFields` object — Container for custom fields of a Rate Plan object. - `chargeUpdates` OrderActionRatePlanChargeRemove[] - `chargeNumber` string — Read only. Identifies the charge to be updated. - `productRatePlanChargeId` string — Identifier of the rate plan that was updated. - `productRatePlanNumber` string — Number of a product rate plan for this subscription. - `uniqueToken` string — A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions. - `customFields` object — Container for custom fields of a Rate Plan Charge object. - `renewSubscription` RenewSubscription — Information about an order action of type `RenewSubscription`. - `billToContact` CreateAccountContact — Container for bill-to/sold-to/ship-to contact information for this account. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `city` string — City, 100 characters or less. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. - `county` string — County; 100 characters or less. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string, required — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `lastName` string, required — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number. - `personalEmail` string, email — Personal email address, 80 characters or less. - `postalCode` string — Postal code, 20 characters or less. - `state` string — State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. - `workEmail` string, email — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `contactDescription` string — A description for the contact. - `billToContactId` string — 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. - `clearingExistingBillToContact` boolean — 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. - `clearingExistingInvoiceGroupNumber` boolean — Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` 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. - `clearingExistingInvoiceTemplate` boolean — 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. - `clearingExistingPaymentTerm` boolean — 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. - `clearingExistingSequenceSet` boolean — 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](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-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. - `clearingExistingShipToContact` boolean — Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field. **Note:** To access this field, you must have the ShipToContactSupport permission. If you want to enable this permission, submit a request at Zuora Global Support. - `clearingExistingSoldToContact` boolean — 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. - `invoiceGroupNumber` string, nullable — The number of the invoice group associated with the subscription. After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://docs.zuora.com?resourceId=billing-invoice-grouping). **Note**: - If you have the Flexible Billing Attributesfeature 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 during subscription creation, the value of this field is automatically set to `null` in the response body. - `invoiceTemplateId` string, nullable — 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. - `paymentTerm` string — 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.. - `sequenceSetId` string, nullable — 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. - `shipToContact` CreateAccountContact — Container for bill-to/sold-to/ship-to contact information for this account. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `city` string — City, 100 characters or less. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. - `county` string — County; 100 characters or less. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string, required — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `lastName` string, required — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number. - `personalEmail` string, email — Personal email address, 80 characters or less. - `postalCode` string — Postal code, 20 characters or less. - `state` string — State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. - `workEmail` string, email — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `contactDescription` string — A description for the contact. - `shipToContactId` string — The ID of the ship-to contact associated with the subscription. **Note:** To access this field, you must have the ShipToContactSupport permission. If you want to enable this permission, submit a request at Zuora Global Support. - `soldToContact` CreateAccountContact — Container for bill-to/sold-to/ship-to contact information for this account. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `city` string — City, 100 characters or less. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. - `county` string — County; 100 characters or less. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string, required — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `lastName` string, required — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number. - `personalEmail` string, email — Personal email address, 80 characters or less. - `postalCode` string — Postal code, 20 characters or less. - `state` string — State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. - `workEmail` string, email — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `contactDescription` string — A description for the contact. - `soldToContactId` string — 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. - `resume` CreateOrderResume — Information about an order action of type `Resume`. - `extendsTerm` boolean — Specifies whether to extend the subscription term by the length of time the suspension is in effect. - `resumePeriods` integer — 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. - `resumePeriodsType` 'Day' | 'Week' | 'Month' | 'Year' — 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. - `resumePolicy` 'Today' | 'FixedPeriodsFromSuspendDate' | 'FixedPeriodsFromToday' | 'SpecificDate' | 'SuspendDate', required — Resume methods. Specify a way to resume a subscription. See [Resume Date](https://docs.zuora.com?resourceId=billing-subscriptions-resumption) for more information. If `SuspendDate` is specfied, the resumption will take place on the same day as the suspension. - `resumeSpecificDate` string, date — 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. - `suspend` CreateOrderSuspend — Information about an order action of type `Suspend`. - `suspendPeriods` integer — 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. - `suspendPeriodsType` 'Day' | 'Week' | 'Month' | 'Year' — 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. - `suspendPolicy` 'Today' | 'EndOfLastInvoicePeriod' | 'FixedPeriodsFromToday' | 'SpecificDate', required — Suspend methods. Specify a way to suspend a subscription. See [Suspend Date](https://docs.zuora.com?resourceId=billing-considerations-of-suspend-a-subscription) for more information. - `suspendSpecificDate` string, date — 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](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) than the subscription's term end date. - `termsAndConditions` CreateOrderTermsAndConditions — Information about an order action of type `TermsAndConditions`. - `autoRenew` boolean - `billToContact` CreateAccountContact — Container for bill-to/sold-to/ship-to contact information for this account. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `city` string — City, 100 characters or less. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. - `county` string — County; 100 characters or less. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string, required — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `lastName` string, required — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number. - `personalEmail` string, email — Personal email address, 80 characters or less. - `postalCode` string — Postal code, 20 characters or less. - `state` string — State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. - `workEmail` string, email — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `contactDescription` string — A description for the contact. - `billToContactId` string — 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. - `clearingExistingBillToContact` boolean — 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. - `clearingExistingInvoiceGroupNumber` boolean — Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` 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. - `clearingExistingInvoiceTemplate` boolean — 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. - `clearingExistingPaymentTerm` boolean — 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. - `clearingExistingSequenceSet` boolean — 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. - `clearingExistingShipToContact` boolean — Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field. **Note**: To access this field, you must have the ShipToContactSupport permission. If you want to enable this permission, submit a request at Zuora Global Support. - `clearingExistingSoldToContact` boolean — 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. - `communicationProfileId` string — The ID of the communication profile associated with the subscription. **Note**: This field is available in the request body only if you have the Flexible Billing Attributes feature turned on. The value is `null` in the response body without this feature turned on. - `clearingExistingCommunicationProfile` boolean — Whether to clear the existing communication profile at the subscription level. This field is mutually exclusive with the `communicationProfileId` field. - `invoiceGroupNumber` string, nullable — The number of the invoice group associated with the subscription. After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://docs.zuora.com?resourceId=billing-invoice-grouping). **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 during subscription creation, the value of this field is automatically set to `null` in the response body. - `invoiceSeparately` boolean — Specifies whether the subscription appears on a separate invoice while generating invoices. - `invoiceTemplateId` string — 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. - `lastTerm` LastTerm — The length of the period for the current subscription term. - `period` integer — Specify only when the termType is 'TERMED'. - `periodType` 'Month' | 'Year' | 'Day' | 'Week' — Specify only when the termType is 'TERMED'. - `startDate` string, date — The start date of the current term. You can change the term start date of a renewed subscription through a T&Cs order action. However, when changing it to an earlier date, this date must not be earlier than the term start date of the current term before this T&Cs. - `endDate` string, date — The end date of the current term, in YYYY-MM-DD format. - `termType` 'TERMED' | 'EVERGREEN', required - `paymentProfile` object — Container for payment gateway and payment method details of a payment. If you do not set this field, the payment method and payment gateway values cannot be set in the subscription. **Note:** - If multiple order actions are specified, they will be applied in the same order they appear in the API payload. - If one or more of these order actions include the `paymentProfile` element, the changes will be applied in sequence, and the result will be consistent with the last `paymentProfile` element. - `paymentGatewayId` string — The ID of the gateway instance that processes the payment. This field remains unset, if you do not provide value. - `paymentMethodId` string — The ID of the payment method. This field remains unset, if you do not provide value. - `paymentTerm` string — 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. - `renewalSetting` 'RENEW_WITH_SPECIFIC_TERM' | 'RENEW_TO_EVERGREEN' - `renewalTerms` RenewalTerm[] - `period` integer — Duration of the renewal term in months, years, days, or weeks, depending on the value of the `periodType` field. - `periodType` 'Month' | 'Year' | 'Day' | 'Week' — Unit of time that the renewal term is measured in. - `scheduledCancelDate` string, date — The date when the subscription is scheduled to be canceled. The subscription is not canceled until the date specified in this field. - `scheduledSuspendDate` string, date — The date when the subscription is scheduled to be suspended. The subscription is not suspended until the date specified in this field. - `scheduledResumeDate` string, date — The date when the subscription is scheduled to be resumed. The subscription is not resumed until the date specified in this field. - `clearingScheduledCancelDate` boolean — Whether to clear the value of the `scheduledCancelDate` field. **Note**: Do not set this field and the `scheduledCancelDate` field simultaneously. - `clearingScheduledSuspendDate` boolean — Whether to clear the value of the `scheduledSuspendDate` field. **Note**: Do not set this field and the `scheduledSuspendDate` field simultaneously. - `clearingScheduledResumeDate` boolean — Whether to clear the value of the `scheduledResumeDate` field. **Note**: Do not set this field and the `scheduledResumeDate` field simultaneously. - `sequenceSetId` string — 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. - `shipToContact` CreateAccountContact — Container for bill-to/sold-to/ship-to contact information for this account. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `city` string — City, 100 characters or less. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. - `county` string — County; 100 characters or less. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string, required — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `lastName` string, required — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number. - `personalEmail` string, email — Personal email address, 80 characters or less. - `postalCode` string — Postal code, 20 characters or less. - `state` string — State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. - `workEmail` string, email — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `contactDescription` string — A description for the contact. - `shipToContactId` string — The ID of the ship-to contact associated with the subscription. **Note**: To access this field, you must have the ShipToContactSupport permission. If you want to enable this permission, submit a request at Zuora Global Support. - `soldToContact` CreateAccountContact — Container for bill-to/sold-to/ship-to contact information for this account. - `address1` string — First address line, 255 characters or less. - `address2` string — Second address line, 255 characters or less. - `city` string — City, 100 characters or less. - `country` string — Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. - `county` string — County; 100 characters or less. May optionally be used by Zuora Tax to calculate county tax. - `fax` string — Fax phone number, 40 characters or less. - `firstName` string, required — First name, 100 characters or less. - `homePhone` string — Home phone number, 40 characters or less. - `lastName` string, required — Last name, 100 characters or less. - `mobilePhone` string — Mobile phone number, 40 characters or less. - `nickname` string — Nickname for this contact - `otherPhone` string — Other phone number, 40 characters or less. - `otherPhoneType` 'Work' | 'Mobile' | 'Home' | 'Other' — Specifies the type of phone number. - `personalEmail` string, email — Personal email address, 80 characters or less. - `postalCode` string — Postal code, 20 characters or less. - `state` string — State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. - `taxRegion` string — If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. - `workEmail` string, email — Work email address, 80 characters or less. - `workPhone` string — Work phone number, 40 characters or less. - `contactDescription` string — A description for the contact. - `soldToContactId` string — 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. - `triggerDates` TriggerDate[] — Container for the contract effective, service activation, and customer acceptance dates of the order action. If the service activation date is set as a required field in Default Subscription Settings, skipping this field in a `CreateSubscription` order action of your JSON request will result in a `Pending` order and a `Pending Activation` subscription. If the customer acceptance date is set as a required field in Default Subscription Settings, skipping this field in a `CreateSubscription` order action of your JSON request will result in a `Pending` order and a `Pending Acceptance` subscription. If the service activation date field is at the same time required and skipped (or set as null), it will be a `Pending Activation` subscription. - `name` 'ContractEffective' | 'ServiceActivation' | 'CustomerAcceptance' — Name of the trigger date of the order action. - `triggerDate` string, date — Trigger date in YYYY-MM-DD format. - `type` 'CreateSubscription' | 'TermsAndConditions' | 'AddProduct' | 'UpdateProduct' | 'RemoveProduct' | 'RenewSubscription' | 'CancelSubscription' | 'OwnerTransfer' | 'Suspend' | 'Resume' | 'ChangePlan', required — 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. **Note**: The change plan type of order action is supported for the Order to Revenue feature. However, it is currently not supported for the Billing - Revenue Integration feature. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing. - `updateProduct` PreviewOrderRatePlanUpdate — Information about an order action of type `UpdateProduct`. - `chargeUpdates` PreviewOrderChargeUpdate[] — Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action. When previewing an `updateProduct` order action, either the `chargeNumber` or `uniqueToken` field is required to specify the charge to update. - `billing` BillingUpdate - `billingPeriodAlignment` 'AlignToCharge' | 'AlignToSubscriptionStart' | 'AlignToTermStart', nullable — **Note**: This field is not supported in one time charges. - `chargeNumber` string — The number of the charge to be updated. The value of this field is inherited from the `subscriptions` > `orderActions` > `addProduct` > `chargeOverrides` > `chargeNumber` field. - `customFields` RatePlanChargeObjectCustomFields — Container for custom fields of a Rate Plan Charge object. - `description` string - `effectiveDate` PreviewOrderTriggerParams — Specifies when a charge becomes active. - `specificTriggerDate` 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. - `triggerEvent` 'ContractEffective' | 'ServiceActivation' | 'CustomerAcceptance' | 'SpecificDate' — 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. - `estimatedStartDate` string, date — The estimated start date of the pending charge in an active subscription. The value of this field must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge. **Note:** This field is available only when the Pending Subscription Processing feature is turned on. - `negotiatedPriceTable` NegotiatedItems[] — Array of negotiated price table information. The rate card entries provided in the array will override the existing rate card entries in the standard price table to form a negotiated price table that will be used during pricing evaluation. **Note:** To enable the Negotiated Price Table feature, submit a request to Zuora Global Support. - `items` object — The rate card entry object. **Note:** For more information, refer to the rate card definition in the product catalog. - `prepaidQuantity` number — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The number of units included in a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). Must be a positive number (>0). - `pricingAttributes` object — Container for pricing attribute and value that provide additional context for dynamic pricing. The pricing attribute values included in the array will update the existing values. For the pricing attribute mapped to a Zuora object field, Zuora will retrieve the value automatically, you don’t need to pass its value explicitly. If you pass a value that doesn’t match the actual value of the Zuora object, an error will be returned. Note that for any pricing attribute mapped to the field of Zuora object Usage, because its value is only determined when the usage record arrives, you can’t provide a value via Orders API payload and Zuora will not retrieve its value automatically. **Note:** To enable Dynamic Pricing, submit a request to Zuora Global Support. - `pricing` PreviewOrderPricingUpdate - `chargeModelData` ChargeModelDataOverride — Container for charge model configuration data. **Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information. - … - `discount` DiscountPricingUpdate - … - `recurringCalcualated` RecurringCalculatedPricingUpdate — Pricing information about a recurring charge that uses the "calculated" charge model. - … - `recurringFlatFee` RecurringFlatFeePricingUpdate - … - `recurringPerUnit` RecurringPerUnitPricingUpdate - … - `recurringTiered` RecurringTieredPricingUpdate - … - `recurringVolume` RecurringVolumePricingUpdate - … - `productRatePlanChargeId` string — ID of a product rate plan charge for this subscription. When `isAddingSubsetCharges` is set to true, the product rate charge specified by `productRatePlanChargeId` is added to the existing rate plan specified by `ratePlanId`. - `productRatePlanChargeNumber` string — Number of a product rate plan charge for this subscription. When `isAddingSubsetCharges` is set to true, the product rate charge specified by `productRatePlanChargeNumber` is added to the existing rate plan specified by `ratePlanId`. - `uniqueToken` string — A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions. - `chargeOverrides` ChargeOverride[] — This section is only available for hard bundle rate plans. To include additional charges to the subscribed hard bundle, specify the product rate plan charge ID and its attributes. **Note:** This field is only available when the **Hard Bundle** feature is enabled. The **Hard Bundle** feature is in the **Early Availability** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early availability program, submit a request at Zuora Global Support. - `accountReceivableAccountingCode` string — The accountReceivableAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled. - `adjustmentLiabilityAccountingCode` string — The adjustmentLiabilityAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `adjustmentRevenueAccountingCode` string — The adjustmentRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `billing` object — Billing information about the charge. - `billCycleDay` integer — Day of the month that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofMonth`. - `billCycleType` 'DefaultFromCustomer' | 'SpecificDayofMonth' | 'SubscriptionStartDay' | 'ChargeTriggerDay' | 'SpecificDayofWeek' | 'TermStartDay' | 'TermEndDay', nullable — 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. * `TermStartDay` - The start day of the term. * `TermEndDay` - The End day of the term. - `billingPeriod` 'Month' | 'Quarter' | 'Semi_Annual' | 'Annual' | 'Eighteen_Months' | 'Two_Years' | 'Three_Years' | 'Five_Years' | 'Specific_Months' | 'Subscription_Term' | 'Week' | 'Specific_Weeks' | 'Specific_Days', nullable — 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. - `billingPeriodAlignment` 'AlignToCharge' | 'AlignToSubscriptionStart' | 'AlignToTermStart' | 'AlignToTermEnd', nullable — 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. * `AlignToTermEnd` - This field is available only for prepayment charges by default. To enable this value for non-prepaid recurring charges, contact Zuora Global Support. See the `billCycleType` field for information about how Zuora determines the billing day. **Note**: This field is not supported in one time charges. - `billingTiming` 'IN_ADVANCE' | 'IN_ARREARS', nullable — 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). This field is only used if the `ratePlanChargeType` value is `Recurring`. - `specificBillingPeriod` integer, nullable — 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`. - `weeklyBillCycleDay` 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday', nullable — Day of the week that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofWeek`. - `chargeFunction` 'Standard' | 'Prepayment' | 'CommitmentTrueUp' | 'Drawdown' | 'CreditCommitment' | 'DrawdownAndCreditCommitment' — **Note**: This field is only available if you have both the Prepaid with Drawdown and Standalone Orders features enabled. With this field, you can use a standalone order to subscribe to a minimum commitment subscription. This field defines what type of charge it is: * Standard: Normal charge with no Prepayment or Commitment or Drawdown. * Prepayment: For recurring charges. Unit or currency based prepaid charge. * CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge. * Drawdown: For usage charges. Drawdown from prepaid funds. * DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds. * CreditCommitment: For usage charges. Credit to minimum commitment funds. - `creditOption` 'TimeBased' | 'ConsumptionBased' | 'FullCreditBack' — **Note**: This field is only available if you have both the Minimum Commitment and Standalone Orders features enabled. With this field, you can use a standalone order to subscribe to a minimum commitment subscription. This field defines the way to calculate credit. See [Credit Option](https://docs.zuora.com?resourceId=billing-prepayment-charge) for more information. - `chargeModel` 'FlatFee' | 'PerUnit' | 'Volume' | 'Tiered' | 'TieredWithOverage' | 'DiscountFixedAmount' | 'DiscountPercentage' | 'MultiAttributePricing' | 'PreratedPerUnit' | 'PreratedPricing' | 'HighWatermarkVolumePricing' | 'HighWatermarkTieredPricing' | 'Delivery' | 'Calculated' — The chargeModel of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `chargeNumber` string — 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-. - `chargeType` 'OneTime' | 'Recurring' | 'Usage' | 'Others' — The chargeType of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `contractAssetAccountingCode` string — The contractAssetAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `contractLiabilityAccountingCode` string — The contractLiabilityAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `contractRecognizedRevenueAccountingCode` string — The contractRecognizedRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `customFields` RatePlanChargeObjectCustomFields — Container for custom fields of a Rate Plan Charge object. - `deferredRevenueAccountingCode` string — The deferredRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled. - `description` string, nullable — Description of the charge. - `drawdownPriority` integer — Drawdown priority for consumption ordering. Lower value means that it will be consumed first. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `drawdownRate` number — **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. The [conversion rate](https://docs.zuora.com?resourceId=billing-create-drawdown-charge) between Usage UOM and Drawdown UOM for a [drawdown charge](https://docs.zuora.com?resourceId=billing-create-drawdown-charge). Must be a positive number (>0). - `drawdownScope` 'SUBSCRIPTION' | 'ACCOUNT' — The scope in which the funds are applicable for the usage drawdown charges during drawdown. Valid for the charge with function of `Prepayment`. - `SUBSCRIPTION` - only usage charges of the same subscription can be drawn down. - `ACCOUNT` - only usage charges in the same account (subscription owner) can be drawn down. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `endDate` EndConditions — Specifies when a charge becomes inactive. - `endDateCondition` 'Subscription_End' | 'Fixed_Period' | 'Specific_End_Date' | 'One_Time', nullable — 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. - `endDatePolicy` 'AlignToApplyToCharge' | 'SpecificEndDate' | 'FixedPeriod' — 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. **Notes**: - You must enable the [Enhanced Discounts](https://docs.zuora.com?resourceId=billing-manage-enhanced-discount) 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. - `specificEndDate` string, date, nullable — Date in YYYY-MM-DD format. Only applicable if the value of the `endDateCondition` field is `Specific_End_Date`. - `upToPeriods` integer, nullable — 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`. - `upToPeriodsType` 'Billing_Periods' | 'Days' | 'Weeks' | 'Months' | 'Years', nullable — Unit of time that the charge duration is measured in. Only applicable if the value of the `endDateCondition` field is `Fixed_Period`. - `estimatedStartDate` string, date — The estimated start date of the pending charge in an active subscription. If you specify `SpecificDate` in the `startDate` > `triggerEvent` field and want to create a completed order and an active subscription, you must specify either the `estimatedStartDate` or `startDate` > `specificTriggerDate` field: - `estimatedStartDate`: The charge will be in pending status. - `specificTriggerDate`: The charge will be in active status. The value of this field must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge. **Note:** This field is available only when the Pending Subscription Processing feature is turned on. - `excludeItemBillingFromRevenueAccounting` boolean — 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 an 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](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `excludeItemBookingFromRevenueAccounting` boolean — 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](https://docs.zuora.com?resourceId=revenue-billing-integration) feature enabled. - `fundSupportAccountHierarchy` boolean — Indicates whether to enable sub-account's usage to drawdown from the parent's funds. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `isAllocationEligible` boolean — This field is used to identify if the charge segment is allocation eligible in revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. - `isRollover` boolean — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The value is either "True" or "False". It determines whether the rollover fields are needed. - `isUnbilled` boolean — This field is used to dictate how to perform the accounting during revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. - `name` string — The name of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `negotiatedPriceTable` NegotiatedItems[] — Array of negotiated price table rate card entries in the order request. **Note:** To enable the Negotiated Price Table feature, submit a request to Zuora Global Support. - `items` object — The rate card entry object. **Note:** For more information, refer to the rate card definition in the product catalog. - `pobPolicy` string — The pobPolicy of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `prepaidQuantity` number — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. The number of units included in a [prepayment charge](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover). Must be a positive number (>0). - `prepaymentUnitType` 'UNIT' | 'CURRENCY' — The unit type of the prepayment charge. For topup (recurring/one-time) charges, this field indicates what type of funds are created. For drawdown (usage) charges, this field indicates what type of funds are drawn down from those created by topup charges. - If the prepaid charge is `UNIT`, it will create a fund with given prepaidUom. - If the prepaid charge is `CURRENCY`, it will create a fund with the currency amount calculated in list price. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `pricing` object — Pricing information about the charge. - `chargeModelData` ChargeModelDataOverride — Container for charge model configuration data. **Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information. - … - `discount` DiscountPricingOverride — Pricing information about a discount charge. - … - `oneTimeFlatFee` OneTimeFlatFeePricingOverride — Pricing information about a one-time charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price. - … - `oneTimePerUnit` OneTimePerUnitPricingOverride — Pricing information about a one-time charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit purchased. - … - `oneTimeTiered` OneTimeTieredPricingOverride — Pricing information about a one-time charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased. - … - `oneTimeVolume` OneTimeVolumePricingOverride — Pricing information about a one-time charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased. - … - `recurringCalculated` RecurringCalculatedPricingOverrideGetOrder — Pricing information about a recurring charge that uses the "calculated" charge model. - … - `recurringDelivery` RecurringDeliveryPricingOverride — Pricing information about a recurring charge that uses the Delivery Pricing charge model. In this charge model, the charge has a fixed price. This field is only available if you have the Delivery Pricing charge model enabled. - … - `recurringFlatFee` RecurringFlatFeePricingOverride — Pricing information about a recurring charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price. - … - `recurringPerUnit` RecurringPerUnitPricingOverride — Pricing information about a recurring charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit purchased. - … - `recurringTiered` RecurringTieredPricingOverride — Pricing information about a recurring charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased. - … - `recurringVolume` RecurringVolumePricingOverride — Pricing information about a recurring charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased. - … - `usageFlatFee` UsageFlatFeePricingOverride — Pricing information about a usage charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price. - … - `usageOverage` UsageOveragePricingOverride — Pricing information about a usage charge that uses the "overage" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed. - … - `usagePerUnit` UsagePerUnitPricingOverride — Pricing information about a usage charge that uses the "per unit" charge model. In this charge model, the charge has a fixed price per unit consumed. - … - `usageTiered` UsageTieredPricingOverride — Pricing information about a usage charge that uses the "tiered pricing" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. - … - `usageTieredWithOverage` UsageTieredWithOveragePricingOverride — Pricing information about a usage charge that uses the "tiered with overage" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier. - … - `usageVolume` UsageVolumePricingOverride — Pricing information about a usage charge that uses the "volume pricing" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed. - … - `pricingAttributes` object — Container for pricing attribute and value in the order request. **Note:** To enable Dynamic Pricing, submit a request to Zuora Global Support. - `productCategory` string — The productCategory of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productClass` string — The productClass of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productFamily` string — The productFamily of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productLine` string — The productLine of a standalone charge. **Note:** This field is available when the Standalone Orders feature is enabled. - `productRatePlanChargeNumber` string — Number of a product rate-plan charge for this subscription. - `productRateplanChargeId` string, required — Internal identifier of the product rate plan charge that the charge is based on. - `prorationOption` 'NoProration' | 'TimeBasedProration' | 'DefaultFromTenantSetting' | 'ChargeFullPeriod' | 'CustomizeProrationOptionOverrides' — **Note**: This field is only available if you have the **Charge Level Proration** feature enabled. For more information, see Usage charge proration and Charge level proration option for a recurring charge. You can use this field to specify the charge-level proration option for a usage charge or recurring charge when you create or add a subscription rate plan charge through an order. The tenant-level proration option will be overridden. * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge. * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period. * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting. * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period. * `CustomizeProrationOptionOverrides`: charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the `ratingPropertiesOverride` field. When the Enhanced Unit-Based Prepaid with Drawdown feature is enabled, the possible options are: - DefaultFromTenantSetting - CustomizeProrationOptionOverrides. When `CustomizeProrationOptionOverrides` is selected, define the customization rules using these options in the `ratingPropertiesOverride` field. - `ratingPropertiesOverride` object — **Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge. This field is used only when the value of the `prorationOption` field is set to `CustomizeProrationOptionOverrides`. Use this field to specify more customized proration options for a recurring charge when you creating or adding a subscription rate plan charge through an order. The tenant-level proration option will be overridden. - `isProratePartialMonth` boolean — Indicates whether to prorate the charge for the partial month. **Note**: This field is only available if you have the **Charge Level Proration** feature enabled. For more information, see Charge level proration option for a recurring charge. Use this field to specify whether to prorate the recurring charge for a partial month. The tenant-level proration option will be overridden. - `prepaymentChargeProrationRule` 'ProrateAmount' | 'ChargeFullAmount' — Define whether to prorate the charge amount or not. When `ProrateAmount` is selected, define the proration rules via the options under this section. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `prorationUnit` 'ProrateByDay' | 'ProrateByMonthFirst' — **Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge. Use this field to specify the unit of proration for a recurring charge. The tenant-level proration option will be overridden. - `daysInMonth` 'UseActualDays' | 'Assume30Days' | 'Assume30DaysStrict' — **Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge. Use this field to specify the number of days counted for a month when prorating a recurring charge. The tenant-level proration option will be overridden. See more details for each of the following enum values in Proration. - `recognizedRevenueAccountingCode` string — The recognizedRevenueAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders and Zuora Finance features are enabled. - `revRecCode` string — Revenue Recognition Code - `revRecTriggerCondition` 'Contract Effective Date' | 'Service Activation Date' | 'Customer Acceptance Date' — Specifies the revenue recognition trigger condition. * `Contract Effective Date` * `Service Activation Date` * `Customer Acceptance Date` - `revenueRecognitionRuleName` 'Recognize upon invoicing' | 'Recognize daily over time' — Specifies the revenue recognition rule. - `revenueRecognitionTiming` 'Upon Billing Document Posting Date' | 'Upon Order Activation Date' — 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. - `revenueAmortizationMethod` 'Immediate' | 'Ratable Using Start And End Dates' — Specifies the type of revenue amortization method. 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. - `rolloverApply` 'ApplyFirst' | 'ApplyLast' — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. This field defines the priority of rollover, which is either first or last. - `rolloverEndDate` string, date — Explicit cutoff date when `rolloverEndDateType` is `SpecificDate`. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `rolloverEndDateType` 'ChargeEndDate' | 'SubscriptionTerm' | 'SpecificDate' — Rollover cutoff strategy determining when the rollover eligibility will end. Possible values are: * `ChargeEndDate` - Rollover stops at the charge end date. * `SubscriptionTerm` - Rollover stops at the subscription term end. * `SpecificDate` - Rollover stops at an explicit date specified in `RolloverEndDate`. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `rolloverFundPriority` integer — Priority override for rolled-over funds. Lower value means that it will be consumed first. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. When **Enhanced Unit-Based Prepaid with Drawdown** feature is enabled, you can customize a single rollover period length together with `rolloverPeriodType` field. - `rolloverPeriodLength` integer — The rollover period length. When the **Enhanced Unit-Based Prepaid with Drawdown** feature is enabled, you can customize a single rollover period length together with `rolloverPeriodType` field. **Note**: This field is only available if you have the Enhanced Unit-Based 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. When the **Enhanced Unit-Based Prepaid with Drawdown** feature is enabled, you can customize a single rollover period length together with `rolloverPeriodType` field. - `rolloverPeriods` number — **Note**: This field is only available if you have the [Prepaid with Drawdown](https://docs.zuora.com?resourceId=billing-prepaid-with-drawdown-overview) feature enabled. To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. This field defines the number of rollover periods, it is restricted to 3. - `rolloverPeriodType` 'Day' | 'Month' | 'Quarter' | 'Annual' — Unit for rollover period length. Possible values are: * `Day` - Day-based rollover periods. * `Month` - Month-based rollover periods. * `Quarter` - Quarter-based rollover periods. * `Annual` - Annual rollover periods. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `startDate` TriggerParams — Specifies when a charge becomes active. - `periodsAfterChargeStart` integer — 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](https://docs.zuora.com?resourceId=billing-manage-enhanced-discount) feature to access this field. - `specificTriggerDate` string, date, nullable — 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](http://support.zuora.com/). * AddProduct * UpdateProduct * RemoveProduct * RenewSubscription * TermsAndConditions - `startDatePolicy` 'AlignToApplyToCharge' | 'SpecificDate' | 'EndOfLastInvoicePeriodOfApplyToCharge' | 'FixedPeriodAfterApplyToChargeStartDate' — 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. **Notes**: - You must enable the [Enhanced Discounts](https://docs.zuora.com?resourceId=billing-manage-enhanced-discount) 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. - `startPeriodsType` 'Days' | 'Weeks' | 'Months' | 'Years' — 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](https://docs.zuora.com?resourceId=billing-manage-enhanced-discount) feature to access this field. - `triggerEvent` 'ContractEffective' | 'ServiceActivation' | 'CustomerAcceptance' | 'SpecificDate' — 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. - `specificValidityPeriodLength` integer — The number of days, weeks, or months for the validity period when `ValidityPeriodType` is `SPECIFIC_DAYS`, `SPECIFIC_WEEKS`, or `SPECIFIC_MONTHS`. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `taxCode` string — The tax code of a charge. This field is available when the `taxable` field is set to `true`. - `taxMode` 'TaxExclusive' | 'TaxInclusive' — The tax mode of a charge. This field is available when the `taxable` field is set to `true`. - `taxable` boolean — The flag indicates whether the charge is taxable. If this field is set to `true`, the `taxCode` and `taxMode` fields must be specified. - `unBilledReceivablesAccountingCode` string — The unBilledReceivablesAccountingCode of a standalone charge. **Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled. - `uniqueToken` string, nullable — 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. - `validityPeriodType` 'SUBSCRIPTION_TERM' | 'ANNUAL' | 'SEMI_ANNUAL' | 'QUARTER' | 'MONTH' — **Note**: 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](https://docs.zuora.com?resourceId=billing-create-prepayment-charge-with-rollover), 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. * When **Enhanced Unit-Based Prepaid with Drawdown** feature is enabled, you can also choose from the following options: `SPECIFIC_DAYS`, `SPECIFIC_WEEKS`, `SPECIFIC_MONTHS`. Specify the actual number in `specificValidityPeriodLength` field. - `validityPeriodAlignment` 'ChargeStart' | 'TermStart' | 'TermEnd' | 'SpecificDate' — Determines the anchor date for validity period (VP) boundaries. The anchor date defines the recurring grid — VP boundaries fall at every VP-length step from the anchor. The charge's start and end dates then determine which portion of this grid is covered. Possible values are: * `ChargeStart` (default) - Anchor date is the charge start date. Simplest option with no partial first VP. * `TermStart` - Anchor date is the subscription term start date. Aligns all charges on the same subscription to a common grid. * `TermEnd` - Anchor date is derived by walking backward from the subscription term end date. Last VP always ends cleanly at term end; partial VP (if any) is at the start. * `SpecificDate` - Anchor date is an explicit `validityPeriodAnchorDate` on the charge. Custom alignment for special billing arrangements. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `validityPeriodAnchorDate` string, date — The anchor date for validity period alignment. Required when `validityPeriodAlignment` is `SpecificDate`. **Note:** This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `validityPeriodProrationOption` 'ProrateUnits' | 'NoProrate' — Controls what happens to units when a validity period (VP) is partial. Possible values are: * `ProrateUnits` - Grant partial units, the number is prorated based on the overlap ratio. * `NoProrate` - Grant full units. **Note**: This field is only available if you have the Enhanced Unit-Based Prepaid with Drawdown feature enabled. - `chargeRemovals` ChargeRemoval[] — This section is only available for hard bundle rate plans. To remove optional component charges from the subscribed hard bundle, specify its subscription rate plan charge number or unique token. **Note:** This field is only available when the **Hard Bundle** feature is enabled. The **Hard Bundle** feature is in the **Early Availability** phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early availability program, submit a request at Zuora Global Support. - `chargeNumber` string — The number of the charge to be removed. This must be an optional charge in a bundle rate plan. **Note:** You must specify either `chargeNumber` or `uniqueToken`. **Note:** This field requires the **Hard Bundle** feature enabled. - `uniqueToken` string — A unique string to represent the charge in the order. Use this to reference a charge that was added in a previous order action within the same order using the same uniqueToken. **Note:** You must specify either `chargeNumber` or `uniqueToken`. - `description` string — Description of why the charge is being removed. **Note:** This field does not accept JavaScript or HTML script content for security reasons. - `clearingExistingFeatures` boolean — Specifies whether all features in the rate plan will be cleared. - `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. - `isAddingSubsetCharges` boolean — Specifies whether to add a subset of charges to the subscription. **Note:** To access this field for adding a subset of charges, submit a request at Zuora Global Support. - `productRatePlanNumber` string — Number of a product rate plan for this subscription. - `ratePlanId` string — The id of the rate plan to be updated. It can be the latest version or any history version id. - `specificUpdateDate` string, date — The specific date when the Update Product order action takes effect. This field allows you to update a charge before a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd. **Note**: After you use this option, the charge's `TriggerEvent` field value will be changed to `SpecificDate`. See [Update a Product on Subscription with Future-dated Updates](https://docs.zuora.com?resourceId=billing-update-products-on-subscriptions-future-dated-updates) for more information about this feature. - `subscriptionProductFeatures` CreateOrderRatePlanFeatureOverride[] — 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. - `customFields` RatePlanFeatureOverrideCustomFields — A container for custom fields of the feature. - `description` string — A description of the feature. - `featureId` string, required — Internal identifier of the feature in the product catalog. - `subscriptionRatePlanNumber` string — Number of a rate plan for this subscription. - `uniqueToken` string — A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions. - `quote` QuoteObjectFields — The fields populated for a quote when a quote is sent to Zuora Billing from Zuora Quote. - `OpportunityCloseDate__QT` string — 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. - `OpportunityName__QT` string — 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 - `QuoteBusinessType__QT` string — 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 - `QuoteNumber__QT` string — 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 - `QuoteType__QT` string — 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 - `ramp` RampRequest — Container of the ramp definitions. It is used to create, update, or remove the ramp definition for the new subscription. - `charges` RampChargeRequest[] — 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. - `chargeNumber` string — The number of the rate plan charge. - `uniqueToken` string — Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora. - `delete` boolean — 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. - `description` string — The short description of the ramp. - `intervals` RampIntervalRequest[] — 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. - `description` string — The short description of the interval. - `endDate` string, date, required — The end date of the interval. - `name` string — The name of the interval. - `startDate` string, date, required — The start date of the interval. - `name` string — The name of the ramp. - `subscriptionNumber` string — Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription. ## Response `202` Accepted - object - `jobId` string, UUID — The ID of an asynchronous job that will be returned for tracking the status and result of the job. --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)