AssumeRenewal

optional

Create Filter

Indicates whether to generate a preview of future invoice items with the assumption that the subscriptions are renewed.

Type : string

Character limit : 50

Version notes : WSDL 81.0+

Values : Set one of the following values in this field to decide how the assumption is applied in the billing preview.

• All : The assumption is applied to all the subscriptions. Zuora generates preview invoice item data from the first day of the customer's next billing period to the target date .

• None : (Default) The assumption is not applied to the subscriptions. Zuora generates preview invoice item data based on the current term end date and the target date .

  • If the target date is later than the current term end date: Zuora generates preview invoice item data from the first day of the customer's next billing period to the current term end date.

  • If the target date is earlier than the current term end date: Zuora generates preview invoice item data from the first day of the customer's next billing period to the target date .

• Autorenew : The assumption is applied to the subscriptions that have auto-renew enabled. Zuora generates preview invoice item data from the first day of the customer's next billing period to the target date .

Note : This field can only be used if the subscription renewal term is not set to 0.

If the AssumeRenewal field is set to Autorenew or All , the returned result includes the renewed rate plan charge which is a non-permanent object, so the ID is a transient ID.

Batches

optional

Create Query Filter

The customer batches to include in the billing preview run. You can specify multiple batches separated by comma in this field. If not specified, all customer batches are included.

Type : string

Character limit : 100

Version notes : WSDL 113.0+

Values : Batchn where n is a number between 1 and 20, e.g., Batch15

CreatedById

optional

Query Filter

The ID of the user who created the BillingPreviewRun object.

Type : zns:ID

Character limit : 32

Version notes : WSDL 61.0+

Values : automatically generated

CreatedDate

optional

Query Filter

The date when the BillingPreviewRun object was created in Zuora.

Type : dateTime

Character limit : 29

Version notes : WSDL 61.0+

Values : automatically generated

ChargeTypeToExclude

optional

Create Query Filter

The charge types to exclude from the forecast run.

Type : string

Character limit : 50

Version notes : WSDL 61.0+

Values : OneTime, Recurring, Usage including any comma-separated combination of these values.

EndDate

optional

Query Filter

The date and time when the billing preview run completes.

Type : dateTime

Character limit : 29

Version notes : WSDL 61.0+

Values : automatically generated

ErrorMessage

optional

Query Filter

The error message generated by a failed billing preview run.

Type : string

Character limit : 255

Version notes : WSDL 61.0+

Values : automatically generated

Id

optional

Query Filter

The ID of this object.

Type : zns:ID

Character limit : 32

Version notes : WSDL 61.0+

Values : automatically generated

IncludingDraftItems

optional

Create Query Filter

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. Draft credit memo items are available only if you have the Invoice Settlement feature enabled.

The chargeTypeToExclude , targetDate , includingEvergreenSubscription , and assumeRenewal fields do not affect the behavior of the includingDraftItems field.

Type : boolean

Character limit : 5

Version notes : WSDL 110.0+

Values : FALSE (default), TRUE

IncludingEvergreenSubscription

optional

Create Query Filter

Indicates if evergreen subscriptions are included in the billing preview run. By default, evergreen subscriptions are not included.

Type : boolean

Character limit : 5

Version notes : WSDL 61.0+

Values : FALSE (default), TRUE

ResultFileUrl

optional

Query Filter

The URL of the zipped CSV result file generated by the billing preview run. This file contains the preview invoice item data for the specified customers.

See field descriptions for more information about the generated CSV result file.

Type : string

Character limit : 255

Version notes : WSDL 61.0+

Values : automatically generated

RunNumber

optional

Query Filter

The run number of the billing preview run.

Type : string

Character limit : 50

Version notes : WSDL 61.0+

Values : automatically generated and prefixed with BPR, such as BPR-10000001.

StartDate

optional

Query Filter

The date and time when the billing preview run starts.

Type : dateTime

Character limi t: 29

Version notes : WSDL 61.0+

Values : automatically generated

Status

optional

Query Filter

The status of the >billing preview run.

Type : string
 (enum)

Character limi t: 50

Version notes : WSDL 61.0+

Values : Pending, Processing, Completed, Error

SucceededAccounts

optional

Query Filter

The number of accounts for which preview invoice item data was successfully generated during the billing preview run.

Type : int

​ Version notes : WSDL 61.0+

Values : automatically generated

TargetDate

required

Create Query Filter

The target date for the billing preview run. The billing preview run generates preview invoice item data from the first day of the customer's next billing period to the TargetDate.

If the TargetDate is later than the subscription current term end date, the preview invoice 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 past the end of the subscription current term, specify the AssumeRenewal field in the request.

Type :

• date: Supported as of WSDL version 69+

• dateTime: Supported through WSDL version 68

Character limit : 29

Version notes : WSDL 61.0+

TotalAccounts

optional

Query Filter

The total number of accounts in the billing preview run.

Type : int

Version notes : WSDL 61.0+

Values : automatically generated

UpdatedById

optional

Query Filter

The ID of the user who last updated the billing preview run.

Type : zns:ID

Character limit : 32

Version notes : WSDL 61.0+

Values : automatically generated

UpdatedDate

optional

Query Filter

The date when the billing preview run was last updated.

Type : dateTime

Character limit : 29

Version notes : WSDL 61.0+

Values : automatically generated