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 Bill Run Health API

Zuora System Health dashboard for Bill Run (Bill Run dashboard) collects and displays data about bill run usage, failure, and performance in near real time. Through the Bill Run dashboard, you can view data about all the bill runs in your Zuora tenant within the last 30 days. For more information, see Bill Run dashboard.

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

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

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 2.0, at version 2023-12-15.

1 operations 1 paths 3 schemas 1 GET

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 1

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

Bill Run Health 1

Zuora System Health dashboard for Bill Run (Bill Run dashboard) collects and displays data about bill run usage, failure, and performance in near real time. Through the Bill Run d…

GET
/system-health/billing-documents/volume-summary
List billing document volume summary records
GET_SystemHealthBillingDocVolumeSummary 8 params → 200400

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are SystemHealthErrorResponse (5 properties), GetBillingDocVolumeSummaryResponse (1 property). Each schema is shown below with its type and property counts.

BillingDocVolumeSummaryRecord
A volume summary record.
SystemHealthErrorResponse
object
5 properties
GetBillingDocVolumeSummaryResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-bill-run-health-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 Billing Documents API
Zuora Billing Preview Run API
Zuora Catalog API