Creates a billing preview run for multiple customer accounts.
The maximum supported preview duration is 20 years, calculated from the current date to the target date.
You can run up to 20 billing preview runs in batches concurrently. A single batch of customer accounts can only have one billing preview run at a time. So you can have up to 20 batches running at the same time. If you create a billing preview run for all customer batches, you cannot create another billing preview run until this preview run is completed.
Note that the preview results for each billing preview run will be stored in the system for 180 days; after that they will be purged.
string <= 255 characters
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.
If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a
The value is in the
string <= 64 characters
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 (
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.
The minor version of the Zuora REST API. See Minor Version for information about REST API version control.
This header affects the availability of the following request fields:
Indicates whether to generate a preview of future invoice items and credit memo items with the assumption that the subscriptions are renewed.
Set one of the following values in this field to decide how the assumption is applied in the billing preview.
string <= 255 characters
The customer batch to include in the billing preview run. If not specified, all customer batches are included.
string <= 1000 characters
The customer batches to include in the billing preview run. You can specify multiple batches separated by comma. If not specified, all customer batches are included.
The charge types to exclude from the forecast run.
Possible values: OneTime, Recurring, Usage, and any comma-separated combination of these values.
Whether draft document items are included in the billing preview run. By default, draft document items are not included.
This field loads draft invoice items and credit memo items. The
Whether evergreen subscriptions are included in the billing preview run. By default, evergreen subscriptions are not included.
Enum: "Csv" "Database"
The saving options. The default value is
The target date for the billing preview run. The billing preview run generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date.
The value for the
If the target date is later than the subscription current term end date, the preview invoice item data and credit memo item data is generated from the first day of the customer's next billing period to the current term end date. If you want to generate preview invoice item data and credit memo item data past the end of the subscription current term, specify the AssumeRenewal field in the request.
Note: The credit memo item data is only available if you have Invoice Settlement feature 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.
- "assumeRenewal": "None",
- "batches": "Batch1, Batch2",
- "chargeTypeToExclude": "",
- "includingDraftItems": "false",
- "includingEvergreenSubscription": "true",
- "targetDate": "2017-01-10"
- "success": true,
- "billingPreviewRunId": "402890b757d1ec1b0157d5aa3d6802aa"