Get started with Payment Schedules
Learn how to get started with Payment Schedules, manage features, and access detailed instructions for each step.
Payment Schedules is now generally available. To manage and access features from the self-service interface, see Manage Features.
This topic gets you started with the Payment Schedules feature. For detailed instructions on each step, click the links to get to the corresponding page.
To learn more about the basic concepts of this feature, see Payment Schedules overview .
Quick-start guide
After you have got the appropriate user permissions, take the following steps to create, view, and manage payment schedules and payment schedule items:
The following operations are available at the payment schedule level:
-
Create payment schedules
-
Create recurring payment schedules
-
Create custom payment schedules
-
Create multiple payment schedules at once (API-only)
-
-
View payment schedules
-
View payment schedule details
-
Retrieve the payment schedule statistic of a specific date (API-only)
-
-
Manage payment schedules
-
Edit payment schedules
-
Preview the result of updating payment schedules (API-only)
-
Cancel payment schedules
-
-
Link payments with existing payment schedules
The following management operations are available at the payment schedule item level:
-
View the payment schedule items of a payment schedule
-
Add payment schedule items to payment schedules
-
Manage existing payment schedule items
-
Update a payment schedule item
-
Cancel payment schedule items
-
Manually retry failed payment schedule items
-
Meanwhile, payment schedules are supported by the following Zuora services:
-
Configure notifications for payment schedules using Custom Events .
-
Leverage Data Source Export and Data Query to query against the Payment Schedule and Payment Schedule Item objects.
-
Audit trail the payment schedule related activities on your tenant.
Known Limitation
You can trigger a Payment Schedule Item(PSI) through Payment Run. If you have enabled OOTB payment to retry through Configure Payment Retry Rules, the rule applies to payments collected through the Payment Schedule Item.
This can be explained through the following example.
Precondition: Enable the payment retry rule with the max failure count value set to 1.
Case 1: Schedule a PSI-1 on 1 January 2023 at 10:00 hours
- The Payment Method failure count changes from 0 to 1 if no payment is generated. The PSI-1 status will reflect 'Pending.'
- The system retries and creates another Payment Run at 11:00 hours. If no payment is generated, the PSI-1 status will reflect 'Error.'
Case 2: Schedule a PSI-2 on 2 January 2023 at 10:00 hours
- If no payment is generated, PSI-2 Status will reflect 'Error' status as the Payment Method still does not meet the Payment Retry Rules.