POST /v1/async/orders/preview

Default value: "application/json"

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

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.

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'.

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.

Possible values:

• "NumberOfPeriods"
• "SpecificDate"
• "TermEnd"

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. The new methodologies are reflected in the OrderDeltaMetrics. It is recommended that all customers use the Order Delta Metrics. If you are an existing Order Metrics customer and want to migrate to Order Delta Metrics, submit a request at Zuora Global Support. Whereas new customers, and existing customers not currently on Order Metrics, 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.

The number of periods to preview when the value of the previewThroughType field is set to NumberOfPeriods.

Category of the order to indicate a product sale or return. Default value is NewSales.

Possible values:

• "NewSales"
• "Return"

Default value: "NewSales"

Information about the account that will own the order.

Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country to calculate tax.

Container for custom fields of an Account object.

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".

Information about the tax exempt status of a customer account.

Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.

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.

ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines.

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.

Jurisdiction in which the customer tax exemption certificate was issued.

Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax.

Possible values:

• "PendingVerification"
• "Yes"
• "No"

Default value: "No"

Description of the tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.

Date when the customer tax exemption starts, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.

Date when the customer tax exemption expires, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.

ISO 3-letter currency code (uppercase). For example, USD.

Container for custom fields of an Order object.

A description of the order.

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.

Note: The Order Line Items feature is now generally available to all Zuora customers. You need to enable the Orders feature to access the Order Line Items feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on Orders will have the Order Line Items feature enabled by default.

The recognized revenue accounting code for the Order Line Item.

The description of the Order Line Item.

The state of an Order Line Item. If you want to generate billing documents for order line items, you must set this field to SentToBilling. For invoice preview, you do not need to set this field.

See State transitions for an order, order line item, and fulfillment for more information.

Possible values:

• "Booked"
• "Complete"
• "Executing"
• "Cancelled"
• "SentToBilling"

The Revenue Recognition rule for the Order Line Item.

The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration.

Use this field to assign an existing account as the owner of an order line item.

This field is used to identify if the charge segment is allocation eligible in revenue recognition.

Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.

The ID of the sequence set associated with the OrderLineItem.

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.

The currency for the order line item. You can specify a currency when creating an order line item through the "Create an order" operation.

The type of the Order Line Item.

Possible values:

• "Services"
• "Product"
• "Fee"

The category for the Order Line Item, to indicate a product sale or return.

Possible values:

• "Sales"
• "Return"

Default value: "Sales"

The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.

Note: This field is only available if you have the Order to Revenue or Zuora Billing - Revenue Integration feature enabled.

Default value: false

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.

The accounting code for the Order Line Item.

The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration.

The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration.

The deferred revenue accounting code for the Order Line Item.

The name of the Order Line Item.

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.

Possible values:

• "Upon Order Activation Date"
• "Upon Billing Document Posting Date"

The list price per unit for the Order Line Item.

The number of the original sale order line item for a return order line item.

The ID of a contact that belongs to the billing account of the order line item. Use this field to assign an existing account as the bill-to contact of an order line item.

The target date for the Order Line Item to be picked up by bill run for billing.

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.

The number of the original sale order for a return order line item.

The quantity of units, such as the number of authors in a hosted wiki service.

Use this field to assign an existing account as the sold-to contact of an order line item, by the following rules:

• If the ownerAccountNumber field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item.
• If the ownerAccountNumber field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item.

Specifies the units to measure usage.

Used by customers to specify the Purchase Order Number provided by the buyer.

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.

Possible values:

• "Immediate"
• "Ratable Using Start And End Dates"

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.

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.

The flag to exclude Order Line Item from revenue accounting.

Note: This field is only available if you have the Order to Revenue or Zuora Billing - Revenue Integration feature enabled.

Default value: false

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.

Possible values:

• "Percentage"
• "FixedAmount"
• "None"

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.

The billing rule for the Order Line Item.

Possible values:

• "TriggerAsFulfillmentOccurs"
• "TriggerWithoutFulfillment"

Default value: "TriggerWithoutFulfillment"

Container for custom fields of an Order Line Item object.

The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration.

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.

The tax code for the Order Line Item.

The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration.

Id of a Product Rate Plan Charge. Only one-time charges are supported.

The tax mode for the Order Line Item.

Possible values:

• "TaxExclusive"
• "TaxInclusive"

The date a transaction starts. The default value of this field is the order date.

The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration.

This field is used to dictate how to perform the accounting during revenue recognition.

Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.

The product code for the Order Line Item.

The order number of this order.
Note: Make sure the order number does not contain a slash.

The account number that this order will be created under. Note that invoice owner account of the subscriptions included in this order should be the same with the account of the order.

Values of reason code configured in Billing Settings > Configure Reason Codes through Zuora UI. Indicates the reason when a return order line item occurs.

Each item includes a set of order actions, which will be applied to the same base subscription.

Container of the ramp definitions. It is used to create, update, or remove the ramp definition for the new subscription.

The name of the ramp.

The short description of the ramp.

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.

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.

The number of the rate plan charge.

Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.

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.

The end date of the interval.

The name of the interval.

The short description of the interval.

The start date of the interval.

Container for custom fields of a Subscription object.

The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request.

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 of the trigger date of the order action.

Possible values:

• "ContractEffective"
• "ServiceActivation"
• "CustomerAcceptance"

Trigger date in YYYY-MM-DD format.

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 currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.

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.

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.

Information about the new product rate plan to add.

Specifies whether all features in the rate plan will be cleared.

Container for custom fields of the Rate Plan or Subscription Offer object. The custom fields of the Rate Plan object are used when rate plans are subscribed, and the custom fields of the Subscription Offer object are used when product offers are subscribed.

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.

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.

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.

A container for custom fields of the feature.

A description of the feature.

Internal identifier of the feature in the product catalog.

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.

List of charges associated with the rate plan.

The productCategory of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

The recognizedRevenueAccountingCode of a standalone charge.

Note: This field is available when the Standalone Orders and Zuora Finance features are enabled.

The pobPolicy of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

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.

Pricing information about the charge.

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 for pricing information.

The pricing formula to calculate actual rating amount.

This field is only available for charges that use the Multi-Attribute Pricing charge model.

The custom field that carries the per-unit rate for each usage record. For example, perUnitAmount__c.

This field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information.

The custom field that carries the total amount to charge for a usage record. For example, totalAmount__c.

This field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information.

List of cumulative pricing tiers in the charge.

Note: When you override the tiers of a usage-based charge using High Water Mark Pricing charge model, you have to provide all of the tiers, including the ones you do not want to change. The new tiers will completely override the previous ones. The High Water Mark Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information.

Price or per-unit price of the tier, depending on the value of the priceFormat field.

Index of the tier in the charge.

Number of units at which the tier becomes effective.

Specifies whether the tier has a fixed price or a per-unit price.

Possible values:

• "FlatFee"
• "PerUnit"

Limit on the number of units for which the tier is effective.

Number of units purchased. This field is used if the Multi-Attribute Pricing formula uses the quantity() function.

This field is only available for one-time and recurring charges that use the Multi-Attribute Pricing charge model.

Pricing information about a one-time charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.

Price of the charge.

The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.

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.

List of cumulative pricing tiers in the charge.

Price or per-unit price of the tier, depending on the value of the priceFormat field.

Index of the tier in the charge.

Number of units at which the tier becomes effective.

Specifies whether the tier has a fixed price or a per-unit price.

Possible values:

• "FlatFee"
• "PerUnit"

Limit on the number of units for which the tier is effective.

Number of units purchased.

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.

List of variable pricing tiers in the charge.

Price or per-unit price of the tier, depending on the value of the priceFormat field.

Index of the tier in the charge.

Number of units at which the tier becomes effective.

Specifies whether the tier has a fixed price or a per-unit price.

Possible values:

• "FlatFee"
• "PerUnit"

Limit on the number of units for which the tier is effective.

Number of units purchased.

Unit of measure of the standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

Pricing information about a discount charge.

Charge list of discount be applied to.

Note: You must enable the Enhanced Discounts feature to access this field.

Product Rate Plan Charge Id of the discount apply to.

Product Rate Plan Id of the discount apply to.

Specifies which type of charge the discount charge applies to.

Possible values:

• "USAGE"
• "ONETIMERECURRING"
• "ONETIME"
• "ONETIMEUSAGE"
• "RECURRING"
• "RECURRINGUSAGE"
• "ONETIMERECURRINGUSAGE"

The manufacturer's suggested retail discount price for standalone charge.

Only applicable if the standalone discount charge is a fixed-amount discount.

Note: This field is available when the Standalone Orders feature is enabled.

Specifies how Zuora changes the price of the charge each time the subscription renews.

Possible values:

• "UseLatestProductCatalogPricing"
• "NoChange"

The discount class defines the sequence in which discount product rate plan charges are applied.

Note: You must enable the Enhanced Discounts feature to access this field.

Application scope of the discount charge. For example, if the value of this field is subscription and the value of the applyDiscountTo field is RECURRING, the discount charge applies to all recurring charges in the same subscription as the discount charge.

Possible values:

• "rateplan"
• "account"
• "subscription"

The manufacturer's suggested retail discount percentage for standalone charge.

Only applicable if the standalone discount charge is a percentage discount.

Note: This field is available when the Standalone Orders feature is enabled.

Only applicable if the discount charge is a percentage discount.

Allow the discount duration to be aligned with the billing period partially.

Note: You must enable the Enhanced Discounts feature to access this field.

Only applicable if the discount charge is a fixed-amount discount.

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.

Per-unit price of the charge.

Number of units purchased.

Unit of measure of the standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.

Billing information about the charge.

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.

Possible values:

• "AlignToTermStart"
• "AlignToSubscriptionStart"
• "AlignToCharge"

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.

Possible values:

• "SpecificDayofWeek"
• "DefaultFromCustomer"
• "SpecificDayofMonth"
• "SubscriptionStartDay"
• "ChargeTriggerDay"

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.

Day of the month that each billing period begins on. Only applicable if the value of the billCycleType field is SpecificDayofMonth.

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.

Possible values:

• "Subscription_Term"
• "Specific_Weeks"
• "Quarter"
• "Month"
• "Specific_Months"
• "Week"
• "Two_Years"
• "Annual"
• "Specific_Days"
• "Five_Years"
• "Semi_Annual"
• "Three_Years"
• "Eighteen_Months"

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).

Possible values:

• "IN_ARREARS"
• "IN_ADVANCE"

Day of the week that each billing period begins on. Only applicable if the value of the billCycleType field is SpecificDayofWeek.

Possible values:

• "Sunday"
• "Thursday"
• "Saturday"
• "Tuesday"
• "Wednesday"
• "Friday"
• "Monday"

Description of the charge.

The chargeType of a standalone charge.

Supported charge types:

• OneTime

• Recurring

• Usage

Note: This field is available when the Standalone Orders feature is enabled.

Revenue Recognition Code

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The period length of the rollover fund.

Charge number of the charge. For example, C-00000307.

If you do not set this field, Zuora will generate the charge number.

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.

This field is used to identify if the charge segment is allocation eligible in revenue recognition.

Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.

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 feature enabled.

Default value: false

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The value is either "True" or "False". It determines whether the rollover fields are needed.

Specifies the revenue recognition trigger condition.

• Contract Effective Date
• Service Activation Date
• Customer Acceptance Date

Possible values:

• "Service Activation Date"
• "Customer Acceptance Date"
• "Contract Effective Date"

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

This field defines the number of rollover periods, it is restricted to 3.

The productClass of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

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.

The productFamily of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

The deferredRevenueAccountingCode of a standalone charge.

Note: This field is available when the Standalone Orders and Zuora Finance features are enabled.

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

This field defines the priority of rollover, which is either first or last.

Possible values:

• "ApplyLast"
• "ApplyFirst"

Specifies the revenue recognition rule, such as Recognize upon invoicing or Recognize daily over time.

The productLine of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

Specifies when a charge becomes active.

Duration of the discount charge in days, weeks, months, or years, depending on the value of the startPeriodsType field. Only applicable if the value of the startDatePolicy field is FixedPeriodAfterApplyToChargeStartDate.

Note: You must enable the Enhanced Discounts feature to access this field.

Unit of time that the discount charge duration is measured in. Only applicable if the value of the startDatePolicy field is FixedPeriodAfterApplyToChargeStartDate.

Note: You must enable the Enhanced Discounts feature to access this field.

Possible values:

• "Days"
• "Months"
• "Weeks"
• "Years"

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 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.

Possible values:

• "EndOfLastInvoicePeriodOfApplyToCharge"
• "AlignToApplyToCharge"
• "FixedPeriodAfterApplyToChargeStartDate"
• "SpecificDate"

Date in YYYY-MM-DD format. Only applicable if the value of the triggerEvent field is SpecificDate.

While this field is applicable, if this field is not set, your CreateSubscription order action creates a Pending order and a Pending Acceptance subscription. If at the same time the service activation date is required and not set, a Pending Activation subscription is created.

While this field is applicable, if this field is not set, the following order actions create a Pending order but do not impact the subscription status. Note: This feature is in Limited Availability. If you want to have access to the feature, submit a request at Zuora Global Support.

• AddProduct
• UpdateProduct
• RemoveProduct
• RenewSubscription
• TermsAndConditions

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.

Possible values:

• "ContractEffective"
• "ServiceActivation"
• "SpecificDate"
• "CustomerAcceptance"

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.

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.

The accountReceivableAccountingCode of a standalone charge.

Note: This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled.

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 feature enabled.

Default value: false

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.

Specifies when a charge becomes inactive.

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.

Date in YYYY-MM-DD format. Only applicable if the value of the endDateCondition field is Specific_End_Date.

Unit of time that the charge duration is measured in. Only applicable if the value of the endDateCondition field is Fixed_Period.

Possible values:

• "Days"
• "Months"
• "Billing_Periods"
• "Weeks"
• "Years"

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 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.

Possible values:

• "FixedPeriod"
• "AlignToApplyToCharge"
• "SpecificEndDate"

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.

Possible values:

• "Subscription_End"
• "Fixed_Period"
• "Specific_End_Date"

Container for custom fields of a Rate Plan Charge object.

The name of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

Number of a product rate-plan charge for this subscription.

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.

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The conversion rate between Usage UOM and Drawdown UOM for a drawdown charge. Must be a positive number (>0).

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The period in which the prepayment units are valid to use as defined in a prepayment charge.

Possible values:

• "MONTH"
• "SUBSCRIPTION_TERM"
• "QUARTER"
• "ANNUAL"
• "SEMI_ANNUAL"

The taxCode of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

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.

Internal identifier of the product rate plan charge that the charge is based on.

The taxMode of a standalone charge.

Values:

• TaxExclusive
• TaxInclusive

Note: This field is available when the Standalone Orders feature is enabled.

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.

This field is used to dictate how to perform the accounting during revenue recognition.

Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The number of units included in a prepayment charge. Must be a positive number (>0).

Name of the standalone rate plan.

Note: This field is available when the Standalone Orders feature is enabled.

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.

Number of a subscription rate plan for this subscription.

Internal identifier of the product rate plan that the rate plan is based on.

Number of a product rate plan for this subscription.

If resetBcd is true then reset the Account BCD to the effective date; if it is false keep the original BCD.

Default value: false

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

Possible values:

• "EffectiveEndOfBillingPeriod"
• "SpecificDate"
• "EffectiveImmediately"

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.

Number of a rate plan for this subscription.

ID of the product rate plan that the removed rate plan is based on.

Number of a product rate plan for this subscription.

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".

Possible values:

• "Downgrade"
• "Upgrade"
• "PlanChanged"
• "Crossgrade"

Information about an order action of type AddProduct.

Specifies whether all features in the rate plan will be cleared.

Container for custom fields of the Rate Plan or Subscription Offer object. The custom fields of the Rate Plan object are used when rate plans are subscribed, and the custom fields of the Subscription Offer object are used when product offers are subscribed.

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.

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.

A container for custom fields of the feature.

A description of the feature.

Internal identifier of the feature in the product catalog.

List of charges associated with the rate plan.

The productCategory of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

The recognizedRevenueAccountingCode of a standalone charge.

Note: This field is available when the Standalone Orders and Zuora Finance features are enabled.

The pobPolicy of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

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.

Pricing information about the charge.

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 for pricing information.

The pricing formula to calculate actual rating amount.

This field is only available for charges that use the Multi-Attribute Pricing charge model.

The custom field that carries the per-unit rate for each usage record. For example, perUnitAmount__c.

This field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information.

The custom field that carries the total amount to charge for a usage record. For example, totalAmount__c.

This field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information.

List of cumulative pricing tiers in the charge.

Note: When you override the tiers of a usage-based charge using High Water Mark Pricing charge model, you have to provide all of the tiers, including the ones you do not want to change. The new tiers will completely override the previous ones. The High Water Mark Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information.

Price or per-unit price of the tier, depending on the value of the priceFormat field.

Index of the tier in the charge.

Number of units at which the tier becomes effective.

Specifies whether the tier has a fixed price or a per-unit price.

Possible values:

• "FlatFee"
• "PerUnit"

Limit on the number of units for which the tier is effective.

Number of units purchased. This field is used if the Multi-Attribute Pricing formula uses the quantity() function.

This field is only available for one-time and recurring charges that use the Multi-Attribute Pricing charge model.

Pricing information about a one-time charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.

Price of the charge.

The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.

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.

List of cumulative pricing tiers in the charge.

Price or per-unit price of the tier, depending on the value of the priceFormat field.

Index of the tier in the charge.

Number of units at which the tier becomes effective.

Specifies whether the tier has a fixed price or a per-unit price.

Possible values:

• "FlatFee"
• "PerUnit"

Limit on the number of units for which the tier is effective.

Number of units purchased.

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.

List of variable pricing tiers in the charge.

Price or per-unit price of the tier, depending on the value of the priceFormat field.

Index of the tier in the charge.

Number of units at which the tier becomes effective.

Specifies whether the tier has a fixed price or a per-unit price.

Possible values:

• "FlatFee"
• "PerUnit"

Limit on the number of units for which the tier is effective.

Number of units purchased.

Unit of measure of the standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

Pricing information about a discount charge.

Charge list of discount be applied to.

Note: You must enable the Enhanced Discounts feature to access this field.

Product Rate Plan Charge Id of the discount apply to.

Product Rate Plan Id of the discount apply to.

Specifies which type of charge the discount charge applies to.

Possible values:

• "USAGE"
• "ONETIMERECURRING"
• "ONETIME"
• "ONETIMEUSAGE"
• "RECURRING"
• "RECURRINGUSAGE"
• "ONETIMERECURRINGUSAGE"

The manufacturer's suggested retail discount price for standalone charge.

Only applicable if the standalone discount charge is a fixed-amount discount.

Note: This field is available when the Standalone Orders feature is enabled.

Specifies how Zuora changes the price of the charge each time the subscription renews.

Possible values:

• "UseLatestProductCatalogPricing"
• "NoChange"

The discount class defines the sequence in which discount product rate plan charges are applied.

Note: You must enable the Enhanced Discounts feature to access this field.

Application scope of the discount charge. For example, if the value of this field is subscription and the value of the applyDiscountTo field is RECURRING, the discount charge applies to all recurring charges in the same subscription as the discount charge.

Possible values:

• "rateplan"
• "account"
• "subscription"

The manufacturer's suggested retail discount percentage for standalone charge.

Only applicable if the standalone discount charge is a percentage discount.

Note: This field is available when the Standalone Orders feature is enabled.

Only applicable if the discount charge is a percentage discount.

Allow the discount duration to be aligned with the billing period partially.

Note: You must enable the Enhanced Discounts feature to access this field.

Only applicable if the discount charge is a fixed-amount discount.

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.

Per-unit price of the charge.

Number of units purchased.

Unit of measure of the standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.

Billing information about the charge.

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.

Possible values:

• "AlignToTermStart"
• "AlignToSubscriptionStart"
• "AlignToCharge"

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.

Possible values:

• "SpecificDayofWeek"
• "DefaultFromCustomer"
• "SpecificDayofMonth"
• "SubscriptionStartDay"
• "ChargeTriggerDay"

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.

Day of the month that each billing period begins on. Only applicable if the value of the billCycleType field is SpecificDayofMonth.

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.

Possible values:

• "Subscription_Term"
• "Specific_Weeks"
• "Quarter"
• "Month"
• "Specific_Months"
• "Week"
• "Two_Years"
• "Annual"
• "Specific_Days"
• "Five_Years"
• "Semi_Annual"
• "Three_Years"
• "Eighteen_Months"

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).

Possible values:

• "IN_ARREARS"
• "IN_ADVANCE"

Day of the week that each billing period begins on. Only applicable if the value of the billCycleType field is SpecificDayofWeek.

Possible values:

• "Sunday"
• "Thursday"
• "Saturday"
• "Tuesday"
• "Wednesday"
• "Friday"
• "Monday"

Description of the charge.

The chargeType of a standalone charge. Supported charge types:

• OneTime
• Recurring
• Usage
• DiscountFixedAmount
• DiscountPercentage

Note: This field is available when the Standalone Orders feature is enabled.

Revenue Recognition Code

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The period length of the rollover fund.

Charge number of the charge. For example, C-00000307.

If you do not set this field, Zuora will generate the charge number.

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.

This field is used to identify if the charge segment is allocation eligible in revenue recognition.

Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.

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 in Advanced Consumption Billing are enabled in your tenant, you must ensure the excludeItemBillingFromRevenueAccounting field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the excludeItemBookingFromRevenueAccounting field in a Create Subscription or Add Product order action is set to false, you must also set the excludeItemBillingFromRevenueAccounting field in this order action to false.

• Prepaid with Drawdown
• Unbilled Usage

Note: This field is only available if you have the Order to Revenue or Zuora Billing - Revenue Integration feature enabled.

Default value: false

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The value is either "True" or "False". It determines whether the rollover fields are needed.

Specifies the revenue recognition trigger condition.

• Contract Effective Date
• Service Activation Date
• Customer Acceptance Date

Possible values:

• "Service Activation Date"
• "Customer Acceptance Date"
• "Contract Effective Date"

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

This field defines the number of rollover periods, it is restricted to 3.

The productClass of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

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.

The productFamily of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

The deferredRevenueAccountingCode of a standalone charge.

Note: This field is available when the Standalone Orders and Zuora Finance features are enabled.

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

This field defines the priority of rollover, which is either first or last.

Possible values:

• "ApplyLast"
• "ApplyFirst"

Specifies the revenue recognition rule, such as Recognize upon invoicing or Recognize daily over time.

The productLine of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

Specifies when a charge becomes active.

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.

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.

Possible values:

• "ContractEffective"
• "ServiceActivation"
• "SpecificDate"
• "CustomerAcceptance"

The chargeModel of a standalone charge. Supported charge models:

• FlatFee
• PerUnit
• Volume

Note: This field is available when the Standalone Orders feature is enabled.

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.

The accountReceivableAccountingCode of a standalone charge.

Note: This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled.

The flag to exclude rate plan charges from revenue accounting.

If both the following features in Advanced Consumption Billing are enabled in your tenant, you must ensure the excludeItemBookingFromRevenueAccounting field is set consistently for a prepayment charge and the corresponding drawdown charge.

• Prepaid with Drawdown
• Unbilled Usage

Note: This field is only available if you have the Order to Revenue or Zuora Billing - Revenue Integration feature enabled.

Default value: false

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.

Specifies when a charge becomes inactive.

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.

Date in YYYY-MM-DD format. Only applicable if the value of the endDateCondition field is Specific_End_Date.

Unit of time that the charge duration is measured in. Only applicable if the value of the endDateCondition field is Fixed_Period.

Possible values:

• "Days"
• "Months"
• "Billing_Periods"
• "Weeks"
• "Years"

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 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.

Possible values:

• "FixedPeriod"
• "AlignToApplyToCharge"
• "SpecificEndDate"

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.

Possible values:

• "Subscription_End"
• "Fixed_Period"
• "Specific_End_Date"

Container for custom fields of a Rate Plan Charge object.

The name of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

Number of a product rate-plan charge for this subscription.

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.

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The conversion rate between Usage UOM and Drawdown UOM for a drawdown charge. Must be a positive number (>0).

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The period in which the prepayment units are valid to use as defined in a prepayment charge.

Possible values:

• "MONTH"
• "SUBSCRIPTION_TERM"
• "QUARTER"
• "ANNUAL"
• "SEMI_ANNUAL"

The taxCode of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

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.

Internal identifier of the product rate plan charge that the charge is based on.

The taxMode of a standalone charge. Values:

• TaxExclusive
• TaxInclusive

Note: This field is available when the Standalone Orders feature is enabled.

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.

This field is used to dictate how to perform the accounting during revenue recognition.

Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The number of units included in a prepayment charge. Must be a positive number (>0).

Name of the standalone rate plan.

Note: This field is available when the Standalone Orders feature is enabled.

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.

Number of a subscription rate plan for this subscription.

Internal identifier of the product rate plan that the rate plan is based on.

Number of a product rate plan for this subscription.

Information about an order action of type Suspend.

This field is applicable only when the suspendPolicy field is set to SpecificDate.

A specific date when the subscription suspension takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription's contract effective date or later available versions than the subscription's term end date.

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.

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.

Possible values:

• "Week"
• "Day"
• "Year"
• "Month"

Suspend methods. Specify a way to suspend a subscription. See Suspend Date for more information.

Possible values:

• "FixedPeriodsFromToday"
• "Today"
• "SpecificDate"
• "EndOfLastInvoicePeriod"

Information about an order action of type RemoveProduct.

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.

Container for custom fields of a Rate Plan object.

ID of the rate plan to remove. This can be the latest version or any history version of ID.

Container for custom fields of a Rate Plan Charge object.

Read only. Identifies the charge to be updated.

Identifier of the rate plan that was updated.

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.

Number of a product rate plan for this subscription.

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.

Number of a rate plan for this subscription.

Number of a product rate plan for this subscription.

Information about an order action of type Resume.

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.

Specifies whether to extend the subscription term by the length of time the suspension is in effect.

Resume methods. Specify a way to resume a subscription. See Resume Date for more information.

If SuspendDate is specfied, the resumption will take place on the same day as the suspension.

Possible values:

• "SuspendDate"
• "FixedPeriodsFromToday"
• "Today"
• "FixedPeriodsFromSuspendDate"
• "SpecificDate"

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.

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.

Possible values:

• "Week"
• "Day"
• "Year"
• "Month"

Container for custom fields of an Order Action object.

Information about an order action of type UpdateProduct.

Specifies whether all features in the rate plan will be cleared.

Container for custom fields of the Rate Plan or Subscription Offer object. The custom fields of the Rate Plan object are used when rate plans are subscribed, and the custom fields of the Subscription Offer object are used when product offers are subscribed.

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.

A container for custom fields of the feature.

A description of the feature.

Internal identifier of the feature in the product catalog.

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.

Specifies when a charge becomes active.

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.

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.

Possible values:

• "ContractEffective"
• "ServiceActivation"
• "SpecificDate"
• "CustomerAcceptance"

Container for custom fields of a Rate Plan Charge object.

Possible values:

• "AlignToTermStart"
• "AlignToSubscriptionStart"
• "AlignToCharge"

The number of the charge to be updated. The value of this field is inherited from the subscriptions > orderActions > addProduct > chargeOverrides > chargeNumber field.

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.

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The number of units included in a prepayment charge. Must be a positive number (>0).

The id of the rate plan to be updated. It can be the latest version or any history version id.

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.

Number of a rate plan for this subscription.

Number of a product rate plan for this subscription.

The date when the Update Product order action takes effect. This field is only applicable if there is already a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.

See Update a Product on Subscription with Future-dated Updates for more information about this feature.

The change reason set for an order action when an order is created.

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 currently not supported for Billing - Revenue Integration. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.

Possible values:

• "CreateSubscription"
• "RenewSubscription"
• "Suspend"
• "CancelSubscription"
• "RemoveProduct"
• "OwnerTransfer"
• "Resume"
• "AddProduct"
• "UpdateProduct"
• "ChangePlan"
• "TermsAndConditions"

Information about an order action of type TermsAndConditions.

Possible values:

• "RENEW_TO_EVERGREEN"
• "RENEW_WITH_SPECIFIC_TERM"

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.

Default value: false

Duration of the renewal term in months, years, days, or weeks, depending on the value of the periodType field.

Unit of time that the renewal term is measured in.

Possible values:

• "Week"
• "Day"
• "Year"
• "Month"

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.

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.

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.

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.

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.

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.

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.

Default value: false

Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the soldToContactId field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.

Default value: false

The length of the period for the current subscription term.

The end date of the current term, in YYYY-MM-DD format.

Specify only when the termType is 'TERMED'.

Possible values:

• "EVERGREEN"
• "TERMED"

Specify only when the termType is 'TERMED'.

Possible values:

• "Week"
• "Day"
• "Year"
• "Month"

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.

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.

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.

Default value: false

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.

Default value: false

Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the paymentTerm field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.

Default value: false

Information about an order action of type CancelSubscription.

Possible values:

• "EndOfCurrentTerm"
• "SpecificDate"
• "EndOfLastInvoicePeriod"

Information about an order action of type RenewSubscription.

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.

Default value: false

Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the billToContactId field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.

Default value: false

Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the soldToContactId field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.

Default value: false

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..

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.

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.

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.

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.

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.

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.

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.

Default value: false

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.

Default value: false

Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the paymentTerm field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.

Default value: false

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.

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.

Default value: false

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.

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.

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.

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.

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.

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.

The account number of the invoice owner account that the subscription is being transferred to.

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.

Default value: false

Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the soldToContactId field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.

Default value: false

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.

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.

Default value: false

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.

Default value: false

Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the paymentTerm field.

Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body.

Default value: false

The account number of the account that the subscription is being transferred to.

Information about an order action of type CreateSubscription.

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.

Specifies whether the subscription appears on a separate invoice when Zuora generates invoices.

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.

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.

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.

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.

Information about a new account that will own the subscription. Only available if you have enabled the Owner Transfer feature.

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.

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.

Payment method information associated with an account.

Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist 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.

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".

Default payment method associated with an account. Only credit card payment methods are supported.

CVV or CVV2 security code of the card. To ensure PCI compliance, Zuora does not store the value of this field.

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).

Expiration date of the card.

Type of card.

Possible values:

• "Naranja"
• "AppleAmericanExpress"
• "Hipercard"
• "AppleMasterCard"
• "Nativa"
• "Cencosud"
• "Maestro"
• "AppleVisa"
• "AppleDiscover"
• "Visa"
• "AmericanExpress"
• "AppleJCB"
• "Discover"
• "Electron"
• "Argencard"
• "CUP"
• "TarjetaShopping"
• "Cabal"
• "MasterCard"
• "Diners"
• "JCB"
• "Elo"

Expiration year of the card.

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.

Email address of the cardholder.

Phone number of the cardholder.

Country of the cardholder's address. The value of this field must be a valid country name or abbreviation.

It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.

State or province of the cardholder's address.

ZIP code or other postal code of the cardholder's address.

First line of the cardholder's address.

Full name of the cardholder as it appears on the card. For example, "John J Smith".

City of the cardholder's address.

It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing.

Second line of the cardholder's address.

ISO 3-letter currency code (uppercase). For example, USD.

Indicates if associated invoices can be edited. Values are:

• true
• false (default)

Identifier of the parent customer account for this Account object. Use this field if you have Customer Hierarchy enabled.

Name of the account's customer service representative, if applicable.

The name of the sales representative associated with this account, if applicable.

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.

Specifies whether future payments are automatically billed when they are due.

List of additional email addresses to receive emailed invoices. Values should be a comma-separated list of email addresses.

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.

External identifier of the account in a CRM system.

Name of the payment term associated with the account. For example, "Net 30". The payment term determines the due dates of invoices.

Internal identifier of the invoice template that Zuora uses when generating invoices for the account.

The number of the purchase order associated with this account. Purchase order information generally comes from customers.

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 for this payment method is already enabled.

Account number. For example, A00000001.

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.

Container for custom fields of an Account object.

Note: This field is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist 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.

Account name.

Internal identifier of the communication profile that Zuora uses when sending notifications to the account's contacts.

Notes about the account. These notes are only visible to Zuora users.

Information about the tax exempt status of a customer account.

Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.

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.

ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines.

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.

Jurisdiction in which the customer tax exemption certificate was issued.

Status of the account tax exemption. Applicable if you use Zuora Tax or Connect tax engines. Required if you use Zuora Tax.

Possible values:

• "PendingVerification"
• "Yes"
• "No"

Default value: "No"

Description of the tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.

Date when the customer tax exemption starts, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.

Date when the customer tax exemption expires, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.

Name of the billing batch that the account belongs to. For example, Batch1.

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.

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.

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.

List of rate plans associated with the subscription.

Specifies whether all features in the rate plan will be cleared.

Container for custom fields of the Rate Plan or Subscription Offer object. The custom fields of the Rate Plan object are used when rate plans are subscribed, and the custom fields of the Subscription Offer object are used when product offers are subscribed.

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.

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.

A container for custom fields of the feature.

A description of the feature.

Internal identifier of the feature in the product catalog.

List of charges associated with the rate plan.

The productCategory of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

The recognizedRevenueAccountingCode of a standalone charge.

Note: This field is available when the Standalone Orders and Zuora Finance features are enabled.

The pobPolicy of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

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.

Pricing information about the charge.

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 for pricing information.

The pricing formula to calculate actual rating amount.

This field is only available for charges that use the Multi-Attribute Pricing charge model.

The custom field that carries the per-unit rate for each usage record. For example, perUnitAmount__c.

This field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information.

The custom field that carries the total amount to charge for a usage record. For example, totalAmount__c.

This field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information.

List of cumulative pricing tiers in the charge.

Note: When you override the tiers of a usage-based charge using High Water Mark Pricing charge model, you have to provide all of the tiers, including the ones you do not want to change. The new tiers will completely override the previous ones. The High Water Mark Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see Zuora Editions for pricing information.

Price or per-unit price of the tier, depending on the value of the priceFormat field.

Index of the tier in the charge.

Number of units at which the tier becomes effective.

Specifies whether the tier has a fixed price or a per-unit price.

Possible values:

• "FlatFee"
• "PerUnit"

Limit on the number of units for which the tier is effective.

Number of units purchased. This field is used if the Multi-Attribute Pricing formula uses the quantity() function.

This field is only available for one-time and recurring charges that use the Multi-Attribute Pricing charge model.

Pricing information about a one-time charge that uses the "flat fee" charge model. In this charge model, the charge has a fixed price.

Price of the charge.

The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.

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.

List of cumulative pricing tiers in the charge.

Price or per-unit price of the tier, depending on the value of the priceFormat field.

Index of the tier in the charge.

Number of units at which the tier becomes effective.

Specifies whether the tier has a fixed price or a per-unit price.

Possible values:

• "FlatFee"
• "PerUnit"

Limit on the number of units for which the tier is effective.

Number of units purchased.

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.

List of variable pricing tiers in the charge.

Price or per-unit price of the tier, depending on the value of the priceFormat field.

Index of the tier in the charge.

Number of units at which the tier becomes effective.

Specifies whether the tier has a fixed price or a per-unit price.

Possible values:

• "FlatFee"
• "PerUnit"

Limit on the number of units for which the tier is effective.

Number of units purchased.

Unit of measure of the standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

Pricing information about a discount charge.

Charge list of discount be applied to.

Note: You must enable the Enhanced Discounts feature to access this field.

Product Rate Plan Charge Id of the discount apply to.

Product Rate Plan Id of the discount apply to.

Specifies which type of charge the discount charge applies to.

Possible values:

• "USAGE"
• "ONETIMERECURRING"
• "ONETIME"
• "ONETIMEUSAGE"
• "RECURRING"
• "RECURRINGUSAGE"
• "ONETIMERECURRINGUSAGE"

The manufacturer's suggested retail discount price for standalone charge.

Only applicable if the standalone discount charge is a fixed-amount discount.

Note: This field is available when the Standalone Orders feature is enabled.

Specifies how Zuora changes the price of the charge each time the subscription renews.

Possible values:

• "UseLatestProductCatalogPricing"
• "NoChange"

The discount class defines the sequence in which discount product rate plan charges are applied.

Note: You must enable the Enhanced Discounts feature to access this field.

Application scope of the discount charge. For example, if the value of this field is subscription and the value of the applyDiscountTo field is RECURRING, the discount charge applies to all recurring charges in the same subscription as the discount charge.

Possible values:

• "rateplan"
• "account"
• "subscription"

The manufacturer's suggested retail discount percentage for standalone charge.

Only applicable if the standalone discount charge is a percentage discount.

Note: This field is available when the Standalone Orders feature is enabled.

Only applicable if the discount charge is a percentage discount.

Allow the discount duration to be aligned with the billing period partially.

Note: You must enable the Enhanced Discounts feature to access this field.

Only applicable if the discount charge is a fixed-amount discount.

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.

Per-unit price of the charge.

Number of units purchased.

Unit of measure of the standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer.

Billing information about the charge.

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.

Possible values:

• "AlignToTermStart"
• "AlignToSubscriptionStart"
• "AlignToCharge"

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.

Possible values:

• "SpecificDayofWeek"
• "DefaultFromCustomer"
• "SpecificDayofMonth"
• "SubscriptionStartDay"
• "ChargeTriggerDay"

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.

Day of the month that each billing period begins on. Only applicable if the value of the billCycleType field is SpecificDayofMonth.

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.

Possible values:

• "Subscription_Term"
• "Specific_Weeks"
• "Quarter"
• "Month"
• "Specific_Months"
• "Week"
• "Two_Years"
• "Annual"
• "Specific_Days"
• "Five_Years"
• "Semi_Annual"
• "Three_Years"
• "Eighteen_Months"

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).

Possible values:

• "IN_ARREARS"
• "IN_ADVANCE"

Day of the week that each billing period begins on. Only applicable if the value of the billCycleType field is SpecificDayofWeek.

Possible values:

• "Sunday"
• "Thursday"
• "Saturday"
• "Tuesday"
• "Wednesday"
• "Friday"
• "Monday"

Description of the charge.

The chargeType of a standalone charge. Supported charge types:

• OneTime
• Recurring
• Usage
• DiscountFixedAmount
• DiscountPercentage

Note: This field is available when the Standalone Orders feature is enabled.

Revenue Recognition Code

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The period length of the rollover fund.

Charge number of the charge. For example, C-00000307.

If you do not set this field, Zuora will generate the charge number.

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.

This field is used to identify if the charge segment is allocation eligible in revenue recognition.

Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.

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 in Advanced Consumption Billing are enabled in your tenant, you must ensure the excludeItemBillingFromRevenueAccounting field is set consistently for a prepayment charge and the corresponding drawdown charge. In addition, if the excludeItemBookingFromRevenueAccounting field in a Create Subscription or Add Product order action is set to false, you must also set the excludeItemBillingFromRevenueAccounting field in this order action to false.

• Prepaid with Drawdown
• Unbilled Usage

Note: This field is only available if you have the Order to Revenue or Zuora Billing - Revenue Integration feature enabled.

Default value: false

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The value is either "True" or "False". It determines whether the rollover fields are needed.

Specifies the revenue recognition trigger condition.

• Contract Effective Date
• Service Activation Date
• Customer Acceptance Date

Possible values:

• "Service Activation Date"
• "Customer Acceptance Date"
• "Contract Effective Date"

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

This field defines the number of rollover periods, it is restricted to 3.

The productClass of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

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.

The productFamily of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

The deferredRevenueAccountingCode of a standalone charge.

Note: This field is available when the Standalone Orders and Zuora Finance features are enabled.

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

This field defines the priority of rollover, which is either first or last.

Possible values:

• "ApplyLast"
• "ApplyFirst"

Specifies the revenue recognition rule, such as Recognize upon invoicing or Recognize daily over time.

The productLine of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

Specifies when a charge becomes active.

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.

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.

Possible values:

• "ContractEffective"
• "ServiceActivation"
• "SpecificDate"
• "CustomerAcceptance"

The chargeModel of a standalone charge. Supported charge models:

• FlatFee
• PerUnit
• Volume

Note: This field is available when the Standalone Orders feature is enabled.

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.

The accountReceivableAccountingCode of a standalone charge.

Note: This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled.

The flag to exclude rate plan charges from revenue accounting.

If both the following features in Advanced Consumption Billing are enabled in your tenant, you must ensure the excludeItemBookingFromRevenueAccounting field is set consistently for a prepayment charge and the corresponding drawdown charge.

• Prepaid with Drawdown
• Unbilled Usage

Note: This field is only available if you have the Order to Revenue or Zuora Billing - Revenue Integration feature enabled.

Default value: false

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.

Specifies when a charge becomes inactive.

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.

Date in YYYY-MM-DD format. Only applicable if the value of the endDateCondition field is Specific_End_Date.

Unit of time that the charge duration is measured in. Only applicable if the value of the endDateCondition field is Fixed_Period.

Possible values:

• "Days"
• "Months"
• "Billing_Periods"
• "Weeks"
• "Years"

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 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.

Possible values:

• "FixedPeriod"
• "AlignToApplyToCharge"
• "SpecificEndDate"

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.

Possible values:

• "Subscription_End"
• "Fixed_Period"
• "Specific_End_Date"

Container for custom fields of a Rate Plan Charge object.

The name of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

Number of a product rate-plan charge for this subscription.

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.

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The conversion rate between Usage UOM and Drawdown UOM for a drawdown charge. Must be a positive number (>0).

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The period in which the prepayment units are valid to use as defined in a prepayment charge.

Possible values:

• "MONTH"
• "SUBSCRIPTION_TERM"
• "QUARTER"
• "ANNUAL"
• "SEMI_ANNUAL"

The taxCode of a standalone charge.

Note: This field is available when the Standalone Orders feature is enabled.

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.

Internal identifier of the product rate plan charge that the charge is based on.

The taxMode of a standalone charge. Values:

• TaxExclusive
• TaxInclusive

Note: This field is available when the Standalone Orders feature is enabled.

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.

This field is used to dictate how to perform the accounting during revenue recognition.

Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether the feature is suitable for your use cases.

Note: This field is only available if you have the Prepaid with Drawdown feature enabled.

The number of units included in a prepayment charge. Must be a positive number (>0).

Name of the standalone rate plan.

Note: This field is available when the Standalone Orders feature is enabled.

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.

Number of a subscription rate plan for this subscription.

Internal identifier of the product rate plan that the rate plan is based on.

Number of a product rate plan for this subscription.

Container for the terms and renewal settings of the subscription.

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.

Possible values:

• "RENEW_TO_EVERGREEN"
• "RENEW_WITH_SPECIFIC_TERM"

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.

Duration of the renewal term in months, years, days, or weeks, depending on the value of the periodType field.

Unit of time that the renewal term is measured in.

Possible values:

• "Week"
• "Day"
• "Year"
• "Month"

Specifies whether the subscription automatically renews at the end of the each term. Only applicable if the type of the first term is TERMED.

Information about the first term of the subscription.

End date of the first term, in YYYY-MM-DD format.

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.

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.

Possible values:

• "EVERGREEN"
• "TERMED"

Unit of time that the first term is measured in. Only applicable if the value of the termType field is TERMED.

Possible values:

• "Week"
• "Day"
• "Year"
• "Month"

Start date of the first term, in YYYY-MM-DD format.

Notes about the subscription. These notes are only visible to Zuora users.

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.

Subscription number of the subscription. For example, A-S00000001.

If you do not set this field, Zuora will generate the subscription number.

Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.

The fields populated for a quote when a quote is sent to Zuora Billing from Zuora Quote.

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

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

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

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

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.