Manage payment schedules

Edit payment schedules

You can update the basic information of a payment schedule, as well as the individual payment schedule items that it contains.

In the left navigation of the Zuora UI, go to the Payment Schedules section under Payments, and then click the number or the edit button of the payment schedule you want to edit.

• For recurring payment schedules, after the Occurrences, Run Hour, or Period fields are updated, individual payment schedule items are automatically updated accordingly. You can also edit the configuration of each of the payment schedule items individually.
• For custom payment schedules, you must edit the configuration of each of the payment schedule items individually.

See Manage payment schedule items for a payment schedule for information about how to manage at the payment schedule item level.

Note that you cannot update the associated billing document of a payment schedule to another billing document.

You can also use the Update a payment schedule REST API to update payment schedules.

Preview the result of updating a payment schedule

Before updating any payment schedules, you have the option to preview the result of the updates by using the Preview result of updating a payment schedule REST API. 

You can use this operation to test if the updates are correct. The request will not update the payment schedules. It only creates a temporary result for you to preview.

Cancel a payment schedule

To cancel a payment schedule, click cancel under the action column of that payment schedule, or click the more action icon on the payment schedule details page, and then click Cancel Payment Schedule.

When a payment schedule is canceled, all the pending payment schedule items are canceled on the specified cancel date.

You can cancel only active payment schedules, that is, the payment schedule should contain pending payment schedule items with no payments associated to them.

For more information on the payment schedule cancellation use case, see Payment schedules use cases.

You can also use the Cancel a payment schedule REST API to cancel payment schedules.

Retrieve the payment schedule statistic of a specific date

You can use the Retrieve the payment schedule statistic of a specific date REST API to retrieve the statistics data of payment schedule for a specific date.

Below is an example of the response body:

{
   "date": "2022-03-08",
   "paymentScheduleItems": {
       "pending": 0,
       "processed": 1,
       "error": 1
   },
   "paymentRuns": [
       {
           "number": "PR-00000100",
           "status": "Completed",
           "executedOn": "2022-03-07 20:53:26",
           "completedOn": "2022-03-07 20:53:46",
           "numberOfErrors": 1,
           "numberOfPayments": 0
       },
       {
           "number": "PR-00000101",
           "status": "Completed",
           "executedOn": "2022-03-07 20:57:17",
           "completedOn": "2022-03-07 20:57:25",
           "numberOfErrors": 0,
           "numberOfPayments": 3
       }
   ],
   "success": true
}