Skip to main content

Manage payment schedule items for a payment schedule

Zuora

Manage payment schedule items for a payment schedule

After a payment schedule was created, you can view, update and cancel the payment schedule items of that payment schedule. You can also add new payment schedule items to the payment schedule, or retry payment schedule items that are failed with updated configurations.

View the payment schedule items of a payment schedule

Take the following steps to view the payment schedule items

  1. Click the payment schedule number on the Payment Schedules page.
  2. On the payment schedule details page, you can view the information of payment schedule items under Payment Schedules Items.
  3. Click Payment Method and Payment Gateway to view the payment method and gateway information of a payment schedule item.

You can also use Retrieve a payment schedule REST API to retrieve the payment schedule items of a payment schedule.

Update payment schedule items in a payment schedule

You can edit the items of a payment schedule. Take the following steps to edit a payment schedule item:

  1. On the payment schedule details page, locate the item in the Payment Schedule Items section.
  2. Click edit.

You can update all the fields for pending payment schedule items.

Note that for recurring payment schedules, the Occurrences, Run Hour, and Period fields can also be edited in the Basic Information section of the payment schedule.

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

Add payment schedule items to a payment schedule

You can add items to existing payment schedules.  

  • To add a new item to a custom payment schedule, click New Payment Schedule Item in the Payment Schedule Items section. In the window that pops up, specify the required fields and click save.
  • New payment schedule items can be added to recurring payment schedules. To add new items to a recurring payment schedule:
    1. Click Edit Basic Information.
    2. Increase the value of the Occurrences field.
    3. Update the Run Hour, and Period fields as needed.
    4. Click Save Changes.

After you’ve created the item, you can view it in the Payment Schedule Item list. 

You can use the Add payment schedule item REST API to add items.

Cancel payment schedule items

You can cancel a payment schedule item of a payment schedule by clicking the cancel action button of the item. The status of the payment schedule item will then turn to canceled.
You can use the Cancel a payment schedule item REST API to cancel items.

Retry failed payment schedule item

You can retry failed payment schedule items by clicking retry in the action column. 

The payment method and payment gateway of the failed payment can be updated to new values before retrying.

A payment schedule item can be retried only when it has met the following conditions:

  • The payment schedule items must be either in the Error or Processed status.
  • The payment schedule items must haven’t created any payment yet, or the payment gets created is in the Error status.

You can use the Retry failed payment schedule items REST API to retry failed items in batch.