POST /v1/subscriptions/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 minor version of the Zuora REST API.

You need to set this parameter if you use the following fields:

• targetDate
• includeExistingDraftDocItems
• previewType
• taxationItems

If you have the Invoice Settlement feature enabled, you need to specify this parameter. Otherwise, an error is returned.

.

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.

Duration of the first term of the subscription, in whole months. If termType is TERMED, then this field is required, and the value must be greater than 0. If termType is EVERGREEN, this field is ignored.

Specifies whether to include draft invoice items in subscription previews. Values are:

• true (default). Includes draft invoice items in the preview result.
• false. Excludes draft invoice items in the preview result.

Note: This field is in Zuora REST API version control. Supported minor versions are 207.0 or later available versions.

Specifies whether to include draft invoice items in previews. Values are:

• true (default). Includes draft invoice items in the preview result.
• false. Excludes draft invoice items in the preview result.

Note: This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0.

Effective contract date for this subscription, as yyyy-mm-dd.

The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date.

Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.

Note: This field is in Zuora REST API version control. Supported minor versions are 207.0 or later available versions. To use this field in the method, you must set the zuora-version parameter to the minor version number in the request header.

Container for one or more rate plans for this subscription.

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.

The ID of the external source system. You can use this field and externalCatalogPlanId to specify a product rate plan that is imported from an external system.

Note: If both externalCatalogPlanId, externalIdSourceSystem and productRatePlanId are provided. They must point to the same product rate plan. Otherwise, the request would fail.

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.

This optional container is used to override the quantity of one or more product rate plan charges for this subscription.

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. These 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 for each usage record.

This field is only available for the usage-based charges that use the Multi-Attribute 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 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.

Specifies a rating group based on which usage records are rated.

Possible values:

• ByBillingPeriod (default): The rating is based on all the usages in a billing period.
• ByUsageStartDate: The rating is based on all the usages on the same usage start date.
• ByUsageRecord: The rating is based on each usage record.
• ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv).
• ByGroupId: The rating is based on all the usages in a custom group.

Note:

• The ByBillingPeriod value can be applied for all charge models.
• The ByUsageStartDate, ByUsageRecord, and ByUsageUpload values can only be applied for per unit, volume pricing, and tiered pricing charge models.
• The ByGroupId value is only available if you have the Active Rating feature enabled.
• Use this field only for Usage charges. One-Time Charges and Recurring Charges return NULL.

Description of the charge.

The period type used to define when the charge ends.

Values:

• Billing_Periods
• Days
• Weeks
• Months
• Years

You must use this field together with the upToPeriods field to specify the time period.

This field is applicable only when the endDateCondition field is set to Fixed_Period.

Specifies the type of charges that you want a specific discount to apply to.

Values:

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

Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month the customer is billed.

Values: 1-31

Specifies which day of the week is the bill cycle day (BCD) for the charge.

Values:

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

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.

Determines whether to credit the customer with unused units of usage.

Values:

• NoCredit
• CreditBySpecificRate

Specifies when to start billing the customer for the charge.

Values:

• UCE
• USA
• UCA
• USD

Aligns charges within the same subscription if multiple charges begin on different dates.

Values:

• AlignToCharge
• AlignToSubscriptionStart
• AlignToTermStart

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 Billing - Revenue Integration feature enabled.

Default value: false

Defines when the charge ends after the charge trigger date.

Note:

• This field is only applicable when the endDateCondition field is set to Specific_End_Date.

• If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date.

Container for Volume, Tiered, or Tiered with Overage charge models. Supports the following charge types:

• One-time
• Recurring
• Usage-based

Price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing.

Unique number that identifies the tier that the price applies to.

Starting number of a range of units for the tier.

Indicates if pricing is a flat fee or is per unit.

Values:

• FlatFee
• PerUnit

End number of a range of units for the tier.

Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the PriceChangeOption field to SpecificPercentageValue.

Value must be a decimal between -100 and 100.

Billing timing for the charge for recurring charge types. Not avaliable for one time, usage, and discount charges.

Values:

• IN_ADVANCE (default)
• IN_ARREARS

Applies an automatic price change when a termed subscription is renewed. The Billing Admin setting Enable Automatic Price Change When Subscriptions are Renewed? must be set to Yes to use this field. Values:

• NoChange (default)
• SpecificPercentageValue
• UseLatestProductCatalogPricing

Specifies when to start billing the customer for the charge. Required if the triggerEvent field is set to USD.

The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.

Percentage of discount for a percentage discount.

Price for units over the allowed amount.

Specifies the amount of fixed-amount discount.

Specifies the number of units in the base set of units for this charge. Must be >=0.

Specifies the number of periods to use when calculating charges in an overage smoothing charge model.

The date when the rate plan charge is created through an order or amendment. This field is not updatable.

This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue.

Price for units in the subscription rate plan.

Specifies the rate to credit a customer for unused units of usage. This field applies only for overage charge models when the OverageUnusedUnitsCreditOption field is set to CreditBySpecificRate.

Unique number that identifies the charge. Max 50 characters. System-generated if not provided.

Billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD). Values:

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

Number of units. Must be a decimal >=0.

When using chargeOverrides for creating subscriptions with recurring charge types, the quantity field must be populated when the charge model is "Tiered Pricing" or "Volume Pricing". It is not required for "Flat Fee Pricing" charge model.

Defines when the charge ends after the charge trigger date. If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date.

Values:

• Subscription_End
• Fixed_Period
• Specific_End_Date
• One_Time

The list price base for the product rate plan charge.

Values:

• Per_Billing_Period
• Per_Month
• Per_Week
• Per_Year
• Per_Specific_Months

The flag to exclude rate plan charges from revenue accounting.

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

Default value: false

The number of months for the list price base of the charge. This field is required if you set the value of the listPriceBase field to Per_Specific_Months.

Note:

• This field is available only if you have the Annual List Price feature enabled.
• The value of this field is null if you do not set the value of the listPriceBase field to Per_Specific_Months.

Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends.

Note: You must use this field together with the upToPeriodsType field to specify the time period.

• This field is applicable only when the endDateCondition field is set to Fixed_Period.
• If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end.

Specifies how to determine the billing day for the charge. When this field is set to SpecificDayofMonth, set the BillCycleDay field. When this field is set to SpecificDayofWeek, set the weeklyBillCycleDay field.

Values:

• DefaultFromCustomer
• SpecificDayofMonth
• SubscriptionStartDay
• ChargeTriggerDay
• SpecificDayofWeek

Specifies the number of month or week for the charges billing period. Required if you set the value of the billingPeriod field to Specific_Months or Specific_Weeks.

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

Specifies if the discount applies to the product rate plan only, the entire subscription, or to any activity in the account.

Values:

• rateplan
• subscription
• account

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

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.

ID of a product rate plan for this subscription.

Number of a product rate plan for this subscription.

The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd.

Default value is dependent on the value of other fields. See Notes section for more details.

The period type of the initial term.

Supported values are:

• Month
• Year
• Day
• Week

The default period type is Month.

String of up to 500 characters.

Invoice owner account number or ID.

Note: This feature is in Limited Availability. If you wish to have access to the feature, submit a request at Zuora Global Support.

Possible values are: TERMED, EVERGREEN.

The date of the billing document, in yyyy-mm-dd format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos.

• If this field is specified, the specified date is used as the billing document date.
• If this field is not specified, the date specified in the targetDate is used as the billing document date.

Customer account number or ID.

You must specify the account information either in this field or in the previewAccountInfo field with the following conditions:

• If you already have a customer account, specify the account number or ID in this field.
• If you do not have a customer account, provide account information in the previewAccountInfo field.

Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date.

Note: This field is in Zuora REST API version control. Supported minor versions are 186.0, 187.0, 188.0, 189.0, 196.0, and 206.0. .

The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd.

Default value is dependent on the value of other fields. See Notes section for more details.

The type of preview you will receive.

This field is in Zuora REST API version control. The supported values of this field depend on the REST API minor version you specified in the request header.

• If you do not specify the REST API minor version or specify the minor version number to one of following values in the request header:

  • 186.0
  • 187.0
  • 188.0
  • 189.0
  • 196.0
  • 206.0

  The following values are supported in the previewType field:

  • InvoiceItem
  • ChargeMetrics
  • InvoiceItemChargeMetrics

  The default value is InvoiceItem.

• If you specify the REST API minor version to 207.0 or later available versions in the request header, the following values are supported in the previewType field:

  • LegalDoc
  • ChargeMetrics
  • LegalDocChargeMetrics

  The default value is LegalDoc.

.