Manage payment schedule items for a payment schedule

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 new items 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.
• 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 items, you can view the items 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 transit from pending to canceled.

You can cancel a payment schedule item under the following conditions:

• The status of the payment schedule item should be pending.
• The payment schedule item should not have any payments associated to it.

You can use the Cancel a payment schedule item REST API to cancel items.

Skip payment schedule items

You can skip a payment schedule item in a recurring payment schedule. The skipped payment schedule item will turn to the canceled status, and a new item will be scheduled on the next recurring date after the last existing scheduled date. 

Note that only payment schedule items in recurring payment schedules can be skipped, and the item must be in the pending status.

After the payment schedule item is skipped, the Cancellation Reason field of the item will turn to Skip Payment.

Take the following steps to skip a payment schedule item:

1. In the Payment Schedule Items section, select the payment schedule item that you want to skip.
2. Under the Actions tab, click Skip. 

You can use the Skip a payment schedule item REST API to cancel items.

Retry failed payment schedule items

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.

Note that you can retry a payment schedule item only when the payment schedule item is either in the Error or Pending status.

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