Skip to main content

Manage payment schedules

Zuora

Manage payment schedules

After a payment schedule was created, you can update the payment schedule and the payment schedule items it contains. You can also cancel the payment schedule as needed.

Edit payment schedules

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

  • 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

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

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.

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
}