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 API

Use the Bill Run call to create ad hoc bill runs and Post, Cancel, Query, and Delete bill runs. For more information about bill runs, see Bill runs.

Zuora Bill 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 Bill Run. The published artifact set on APIs.io includes an OpenAPI specification.

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

6 operations 5 paths 10 schemas 1 DELETE1 GET2 POST2 PUT

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 6

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

Bill Run 6

Use the Bill Run call to create ad hoc bill runs and Post, Cancel, Query, and Delete bill runs. For more information about bill runs, see Bill runs .

POST
/v1/bill-runs
Create a bill run
POST_CreateBillRun 8 params → 200
PUT
/v1/bill-runs/{billRunId}/post
Post a bill run
PUT_PostBillRun 8 params → 200
GET
/v1/bill-runs/{billRunId}
Retrieve a bill run
GET_BillRun 7 params → 200
DELETE
/v1/bill-runs/{billRunId}
Delete a bill run
DELETE_DeleteBillRun 7 params → 200
PUT
/v1/bill-runs/{billRunId}/cancel
Cancel a bill run
PUT_CancelBillRun 8 params → 200
POST
/v1/bill-runs/{billRunKey}/emails
Email billing documents generated from a bill run
POST_EmailBillingDocumentsfromBillRun 9 params → 200

Schemas 10

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

CancelBillRunResponseType
BillRunScheduleResponseType
BillRunFilterRequestType
NextRunResponseType
CommonResponseType
object
3 properties
GetBillRunResponseType
BillRunFilterResponseType
POSTEmailBillingDocfromBillRunType
object
1 property
BillRunScheduleRequestType
POSTCreateBillRunRequestType

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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