Retrieve a billing preview run

Retrieves a preview of future invoice items for multiple customer accounts through a billing preview run. If you have the Invoice Settlement feature enabled, you can also retrieve a preview of future credit memo items. 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.

A billing preview run asynchronously generates a downloadable CSV file containing a preview of invoice item data and credit memo item data for a batch of customer accounts. Note that if you set storageOption to Database, no CSV file is generate; instead, you can have a record in the billing preview result. You can use data source to query Billing Preview Run Result.

Request
path Parameters
billingPreviewRunId
required
string

Id of the billing preview run.

header Parameters
Accept-Encoding
string

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.

Content-Encoding
string

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.

Authorization
string

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

Zuora-Track-Id
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 (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Ids
string

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.

Zuora-Org-Ids
string

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.

zuora-version
string

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:

  • batch
  • batches
Responses
200
get/v1/billing-preview-runs/{billingPreviewRunId}
Request samples
Response samples
application/json
{
  • "assumeRenewal": "Autorenew",
  • "batches": "",
  • "chargeTypeToExclude": "OneTime",
  • "createdById": "4028906d58240f960158241132be0003",
  • "createdDate": "2016-11-04 16:18:56",
  • "endDate": "2016-11-04 16:19:00",
  • "errorMessage": null,
  • "includingDraftItems": false,
  • "includingEvergreenSubscription": true,
  • "runNumber": "BPR-00000010",
  • "startDate": "2016-11-04 16:19:00",
  • "status": "Completed",
  • "succeededAccounts": 7,
  • "success": true,
  • "targetDate": "2016-12-01",
  • "totalAccounts": 7,
  • "updatedById": "4028906d58240f960158241132be0003",
  • "updatedDate": "2016-11-04 16:19:00"
}