Get started with Payment Schedules

Prerequisites

The following prerequisites are required for Payment Schedules:

1. Invoice Settlement or Invoice Settlement Harmonization must have been enabled for your tenant.
2. To access Payment Schedules, you must have been assigned a Payments user role that contains one or more of the following permissions required to create, view, and manage payment schedules and payment schedule items:
    
   • Create Payment Schedule & Item 
   • Update Payment Schedule & Item 
   • Cancel Payment Schedule & Item 
   • Delete Payment Schedule & Item 
3. The invoice level auto-pay flag should be set to false when adding the invoice to a payment schedule. This is because when you create a payment schedule, the expected outcome is to collect payments for the invoice by payment schedule installments, instead of automatically collecting payment for the invoice via payment run.

See User Roles for more information. Contact an administrator of your tenant to acquire the appropriate permissions. 

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

1. The Payment Method failure count changes from 0 to 1 if no payment is generated. The PSI-1 status will reflect 'Pending.'
2. 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-1 on 2 January 2023 at 10:00 hours

1. If no payment is generated, the PSI-2 status will reflect 'Error.'