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 Invoice Schedules API

Use invoice schedules to trigger invoice generation processes. For more information about invoice schedules, see Billing Schedule overview.

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

Tagged areas include Invoice Schedules. The published artifact set on APIs.io includes an OpenAPI specification.

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

7 operations 5 paths 13 schemas 1 DELETE1 GET2 POST3 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 7

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

Invoice Schedules 7

Use invoice schedules to trigger invoice generation processes. For more information about invoice schedules, see Billing Schedule overview .

POST
/v1/invoice-schedules
Create an invoice schedule
POST_CreateInvoiceSchedule 8 params → 200
PUT
/v1/invoice-schedules/{scheduleKey}
Update an invoice schedule
PUT_UpdateInvoiceSchedule 8 params → 200
GET
/v1/invoice-schedules/{scheduleKey}
Retrieve an invoice schedule
GET_InvoiceSchedule 9 params → 200
DELETE
/v1/invoice-schedules/{scheduleKey}
Delete an invoice schedule
DELETE_InvoiceSchedule 7 params → 200
PUT
/v1/invoice-schedules/{scheduleKey}/pause
Pause an invoice schedule
PUT_PauseInvoiceSchedule 7 params → 200
PUT
/v1/invoice-schedules/{scheduleKey}/resume
Resume an invoice schedule
PUT_ResumeInvoiceSchedule 7 params → 200
POST
/v1/invoice-schedules/{scheduleKey}/execute
Execute an invoice schedule
POST_ExecuteInvoiceSchedule 9 params → 200

Schemas 13

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

ExecuteInvoiceScheduleBillRunResponse
UpdateScheduleItems
ScheduleItemsResponse
CommonResponseType
object
3 properties
InvoiceScheduleResponses
BillRunFilters
POSTCreateInvoiceScheduleRequest
InvoiceScheduleItemCustomFields
object
Container for custom fields of an Invoice Schedule Item object.
POSTScheduleItemType
InvoiceScheduleSpecificSubscriptions
object
3 properties
InvoiceScheduleCustomFields
object
Container for custom fields of an Invoice Schedule object.
POSTExecuteInvoiceScheduleRequest
PUTUpdateInvoiceScheduleRequest

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-invoice-schedules-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 Billing Preview Run API