Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuora Billing Preview Run API

A billing preview run asynchronously generates a downloadable CSV file containing a preview of future invoice item data and credit memo item data for a batch of customer accounts. **Note**: Credit memo item data is only available if you have the Invoice Settlement feature enabled.

Zuora Billing Preview Run API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Billing Preview Run. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

2 operations 2 paths 2 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2023-12-15
Resource Areas
1

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Billing Preview Run 2

A billing preview run asynchronously generates a downloadable CSV file containing a preview of future invoice item data and credit memo item data for a batch of customer accounts.…

POST
/v1/billing-preview-runs
Create a billing preview run
POST_BillingPreviewRun 9 params → 200
GET
/v1/billing-preview-runs/{billingPreviewRunId}
Retrieve a billing preview run
GET_BillingPreviewRun 8 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are GetBillingPreviewRunResponse (22 properties), PostBillingPreviewRunParam (9 properties). Each schema is shown below with its type and property counts.

GetBillingPreviewRunResponse
object
get billingPreviewRun response
22 properties
PostBillingPreviewRunParam
object
9 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-billing-preview-run-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
Zuora Accounting Codes API
Zuora Accounting Periods API
Zuora Accounts API
Zuora Actions API
Zuora Aggregate Queries API
Zuora API Health API
Zuora Attachments API
Zuora Bill Run API
Zuora Bill Run Health API
Zuora Billing Documents API
Zuora Catalog API