Welcome to Zuora Product Documentation

Explore our rich library of product information

Retrieve: Billing Preview Run

This reference describes the Retrieve: Billing Preview Run task.

The billing preview run task asynchronously generates a downloadable CSV file containing a preview of invoice item data for a batch of customer accounts. Use this task to calculate how much a batch of customers will be invoiced from the most recent invoice date to a target date in the future. Alternatively, you can use data source to query Billing Preview Run Result if you do not want a CSV file to be generated.

Additionally, you can use the billing preview task to access the real-time usage data of an individual customer account.

Task settings

  • Assume Renewal - Select the renewal model to be used in the preview run.

    • All - The preview will be run based on the assumption that all subscriptions will renew when they expire.

    • None - The preview will be run based on the assumption that no subscriptions will renew when they expire.

    • Autorenew - The preview will be run based on the assumption that only subscriptions that are set to renew automatically will renew.
      Note: Do not select Autorenew when the billing preview includes usage-based charges, including prepaid with drawdown charges and tiered with overage charges. Select None instead. If you need to simulate renewal, complete the subscription renewal before you run the billing preview.
  • Batch - Select the batch of customer accounts for the billing preview run.

  • Charge Type to Exclude - Select the charge types that you want to filter out in the preview run. Note that you can select multiple charge types.

  • Target Date - Select the target date for the preview run.

  • Include Evergreen - Select whether to include evergreen subscriptions in the preview run.

  • Concurrency Mode: Controls whether Workflow processes tasks in a single or multi-threaded manner for this task type. Select Sequential to single-thread, or Parallel to allow multi-threaded processing.

    If you select Parallel, the Max Concurrency setting controls the maximum number of threads for this task type that can be utilized. You can specify a value from 1 up to the allowed maximum for this task type. A value of 1 behaves the same as Sequential processing.