How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Zuora

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.

Documentation Provider Profile APIs.io OpenAPI GitHub

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 3.2.0, at version 2023-12-15.

Requests are made against a single base URL, https://rest.zuora.com/.

14 operations 11 paths 27 schemas 4 GET4 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-12-15
Server
https://rest.zuora.com/
Contact
docs@zuora.com
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 8 params body → 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 8 params body → 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 8 params body → 200
PUT
/v1/payment-schedules/{paymentScheduleKey}/preview
Preview the result of payment schedule updates
PUT_PaymentScheduleUpdatePreview 8 params body → 200
PUT
/v1/payment-schedules/{paymentScheduleKey}/cancel
Cancel a payment schedule
PUT_CancelPaymentSchedule 8 params body → 200
POST
/v1/payment-schedules/{paymentScheduleKey}/items
Add payment schedule items to a custom payment schedule
POST_AddItemsToCustomPaymentSchedule 9 params body → 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 8 params body → 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 8 params body → 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.

PaymentScheduleItemCommon
POSTRetryPaymentScheduleItemRequest
object
1 property
PaymentRunStatistic
object
Payment run statistic.
6 properties
POSTPaymentScheduleResponse
PaymentScheduleCommonResponse
GETPaymentScheduleItemResponse
PaymentScheduleCustomFields
object
Container for custom fields of a Payment Schedule object.
POSTRetryPaymentScheduleItemResponse
object
2 properties
POSTPaymentSchedulesRequest
object
1 property
PaymentScheduleItemCustomFields
object
Container for custom fields of a Payment Schedule Item object.
PUTPaymentScheduleRequest
PUTPaymentScheduleItemResponse
PUTPreviewPaymentScheduleRequest
GETPaymentScheduleResponse
POSTPaymentSchedulesResponse
object
Container of the payment schedules that are created.
2 properties
PaymentSchedulePaymentOptionFields
object
2 properties
PUTSkipPaymentScheduleItemResponse
GETPaymentScheduleStatisticResponse
object
The object that contains the payment schedule statistic of the specified date.
4 properties
PaymentScheduleItemCommonResponse
GETPaymentSchedulesResponse
array
Container for payment schedules.
PUTPaymentScheduleItemRequest
POSTAddItemsToPaymentScheduleRequest
object
Container for the payment schedule items to be added to the payment schedule.
1 property
POSTPaymentScheduleRequest
PUTCancelPaymentScheduleRequest
object
1 property 1 required
LinkedPaymentID
object
1 property
POSTRetryPaymentScheduleItemInfo
object
Information of the payment schedule items to be retried.
3 properties
POSTPaymentSchedulesEach
object
2 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
AE Profile APIs.io
Zuora Accounting Codes API
AE Profile APIs.io
Zuora Accounting Periods API
AE Profile APIs.io
Zuora Accounts API
AE Profile APIs.io
Zuora Actions API
AE Profile APIs.io
Zuora Aggregate Queries API
AE Profile APIs.io
Zuora API Health API
AE Profile APIs.io
Zuora Attachments API
AE Profile APIs.io
Zuora Bill Run API
AE Profile APIs.io
Zuora Bill Run Health API
AE Profile APIs.io
Zuora Billing Documents API
AE Profile APIs.io
Zuora Billing Preview Run API
AE Profile APIs.io
#Payment Schedules
← Back to Z APIs
API Details
ID
zuora:zuora-payment-schedules-api
Server
https://rest.zuora.com/
Docs
https://developer.zuora.com/v1-api-reference/introduction
Provider
Zuora
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=zuora-payment-schedules-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zuora-payment-schedules-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Zuora Payment Schedules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.