Knowledge Center

Knowledge Center > API > SOAP API > SOAP API Complex Types > BillingPreviewResult

BillingPreviewResult

The BillingPreviewResult object provides the result of an invoice item preview for a single customer account. This SOAP API reference describes this complex type including supported calls and field descriptions.

This feature is in Limited Availability. We are actively soliciting feedback from a small set of early adopters before releasing as generally available.

As of Zuora R181, WSDL version 61.0, the feature formerly known as forecast API was renamed to Billing Preview API. Zuora recommends that you upgrade to this latest version as soon as possible. Download WSDL version 61.0+ to use the Billing Preview API. See  Zuora WSDL for information about downloading the current version.

Supported Calls

You can use this complex type with the​ billingPreview call.

Walkthroughs and Use Cases

The BillingPreviewResult complex type provides the result of an invoice item preview for a single customer account. To use this complex type:

  1. Request an invoice item preview for a single customer account by using a BillingPreviewResult complex type​ as the argument to a billingPreview call.
  2. Results are returned synchronously as an array of InvoiceItem objects in a BillingPreviewResult complex type.

Field Descriptions

Name Required? Allowed Operations Description

AccountId

required

Query
Filter

The ID of the customer account to which the billing preview applies.

Type: string

Character limit: 25​

Version notes: WSDL 61.0+

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

Success

required

Query
Filter

Indicates whether the billing preview request succeeded (TRUE) or did not succeed (FALSE).

Type: boolean

Character limit: 5

Version notes: WSDL 61.0+

Values: TRUEFALSE

Size

optional

Query
Filter

The number of invoice items returned in the billing preview result.

Type: int

Version notes: WSDL 61.0+

Values: automatically generated

Errors

optional

Query
Filter

An array of errors generated by the failure of the billing preview request.

Type: zns:Error​[]

Version notes: WSDL 61.0+

Values: automatically generated

InvoiceItem

optional

Query
Filter

An array of InvoiceItem objects returned as the result of the billing preview request.

Type: InvoiceItem[]

Version notes: WSDL 61.0+

Values: automatically generated

Last modified
09:42, 9 Oct 2015

Tags

Classifications

(not set)