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

Use payment schedules to split invoice or account balances into several installments and automatically process payments for the installments.For more information about payment schedules, see Payment Schedules.

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

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

14 operations 11 paths 27 schemas 4 GET4 POST6 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 14

Across 11 paths, the API surfaces 14 operations — 4 GET, 4 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Payment Schedules 14

Use payment schedules to split invoice or account balances into several installments and automatically process payments for the installments. For more information about payment sc…

POST
/v1/payment-schedules
Create a payment schedule
POST_PaymentSchedule 9 params → 200
GET
/v1/payment-schedules
List payment schedules by customer account
GET_PaymentSchedules 11 params → 200
POST
/v1/payment-schedules/batch
Create multiple payment schedules at once
POST_PaymentSchedules 9 params → 200
GET
/v1/payment-schedules/{paymentScheduleKey}
Retrieve a payment schedule
GET_PaymentSchedule 10 params → 200
PUT
/v1/payment-schedules/{paymentScheduleKey}
Update a payment schedule
PUT_PaymentSchedule 9 params → 200
PUT
/v1/payment-schedules/{paymentScheduleKey}/preview
Preview the result of payment schedule updates
PUT_PaymentScheduleUpdatePreview 9 params → 200
PUT
/v1/payment-schedules/{paymentScheduleKey}/cancel
Cancel a payment schedule
PUT_CancelPaymentSchedule 9 params → 200
POST
/v1/payment-schedules/{paymentScheduleKey}/items
Add payment schedule items to a custom payment schedule
POST_AddItemsToCustomPaymentSchedule 10 params → 200
GET
/v1/payment-schedules/statistics/{yyyy-mm-dd}
Retrieve payment schedule statistic of a date
GET_PaymentScheduleStatistic 7 params → 200
GET
/v1/payment-schedule-items/{item-id}
Retrieve a payment schedule item
GET_PaymentScheduleItem 8 params → 200
PUT
/v1/payment-schedule-items/{item-id}
Update a payment schedule item
PUT_PaymentScheduleItem 9 params → 200
PUT
/v1/payment-schedule-items/{item-id}/cancel
Cancel a payment schedule item
PUT_CancelPaymentScheduleItem 8 params → 200
PUT
/v1/payment-schedule-items/{item-id}/skip
Skip a payment schedule item
PUT_SkipPaymentScheduleItem 8 params → 200
POST
/v1/payment-schedule-items/retry-payment
Retry failed payment schedule items
POST_RetryPaymentScheduleItem 9 params → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are PaymentRunStatistic (6 properties), GETPaymentScheduleStatisticResponse (4 properties), POSTRetryPaymentScheduleItemInfo (3 properties), POSTPaymentSchedulesEach (2 properties). Each schema is shown below with its type and property counts.

GETPaymentScheduleResponse
GETPaymentSchedulesResponse
array
Container for payment schedules.
PUTPaymentScheduleRequest
PaymentRunStatistic
object
Payment run statistic.
6 properties
PUTPaymentScheduleItemRequest
PaymentScheduleItemCommonResponse
POSTRetryPaymentScheduleItemResponse
object
2 properties
PaymentScheduleCustomFields
object
Container for custom fields of a Payment Schedule object.
POSTPaymentScheduleRequest
PaymentScheduleCommonResponse
LinkedPaymentID
object
1 property
POSTRetryPaymentScheduleItemRequest
object
1 property
POSTPaymentSchedulesRequest
object
1 property
PUTPaymentScheduleItemResponse
PaymentScheduleItemCommon
PUTCancelPaymentScheduleRequest
object
1 property 1 required
PUTPreviewPaymentScheduleRequest
POSTPaymentSchedulesEach
object
2 properties
GETPaymentScheduleStatisticResponse
object
The object that contains the payment schedule statistic of the specified date.
4 properties
POSTAddItemsToPaymentScheduleRequest
object
Container for the payment schedule items to be added to the payment schedule.
1 property
PaymentScheduleItemCustomFields
object
Container for custom fields of a Payment Schedule Item object.
GETPaymentScheduleItemResponse
POSTPaymentSchedulesResponse
object
Container of the payment schedules that are created.
2 properties
PaymentSchedulePaymentOptionFields
object
2 properties
POSTPaymentScheduleResponse
PUTSkipPaymentScheduleItemResponse
POSTRetryPaymentScheduleItemInfo
object
Information of the payment schedule items to be retried.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-payment-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