View payment schedules

Last updated
Save as PDF

After a payment schedule is created, you can view its detailed information on the payment schedule details page.

To view detailed information about a payment schedule through the Zuora UI, perform the following steps:

In the left navigation section, navigate to Payments > Payment Schedules.
On the Payment Schedules page, click the number of the payment schedule that you want to view information about.
On the payment schedule details page, view detailed information about the payment schedule.

Tip: You can use the Views section to filter the most recent payment schedules, or payment schedules with a specific status. You also have the option to filter payment schedules by payment schedule number or account information in the Search section.

You can also view a summary of payment schedules in the Payment Schedules section of the account details page.

The status of payment schedule item/payment schedule will be changed when the payments associated with the item are updated. This is based on the balance change of the payment schedule item caused by refund, void, or cancellation of the associated payments.

To view information about a recurring payment schedule through the REST API, use the following operations:

Status information

The following table lists the information about payment schedule status that is displayed at the top of the payment schedule details page.

Field	Description
Active	The payment schedule still has pending payment schedule items to be processed. If a payment schedule is in the Completed status or if an associated payment has been refunded, voided, or cancelled.
Completed	All the payment schedule items of the payment schedule have been processed.
Canceled	The payment schedule has been canceled.

Field

Description

Active

The payment schedule still has pending payment schedule items to be processed.

If a payment schedule is in the Completed status or if an associated payment has been refunded, voided, or cancelled.

Completed

All the payment schedule items of the payment schedule have been processed.

Canceled

The payment schedule has been canceled.

Basic information

The following table lists the information about the payment schedule displayed in the Basic Information section.

Field	Description
Start Date	The date when the first payment is collected.
Customer Account	The number of the customer account
Is Custom	Whether the payment schedule is custom.
Generate Standalone Payments	Whether the payment schedule generates standalone payments.
Description	The description of the payment schedule.
Total	The total amount of the payments collected during the payment schedule.
Occurrences	The number of payment schedule items included in the payment schedule. Visible only for recurring payment schedules.
Period	The payment schedule item creation period. Visible only for recurring payment schedules.
Run Hour	The hour of the day in the tenant’s time zone when the payment is collected. Visible only for recurring payment schedules.
Billing Document Selection	Information about the billing document that the payment schedule pays.

Item information

The following table lists the information about payment schedule items displayed in the Payment Schedule Items section.

Field	Description
Number	The sequence number of the payment schedule item.
Collection Date	The date when the payment is collected within this payment schedule item.
Run Hour	The hour of the day in the tenant’s time zone when the payment is collected.
Amount	The amount of the payment collected during the payment schedule item.
Balance	The Balance field stores the remaining balance of the current payment schedule item. For example, Payment Schedule Item Amount = $10, but only $2 was collected by PAY-01, then Payment Schedule Item Balance = $8.
Status	The status of the payment schedule item. Cancelled: The payment schedule item is canceled. Pending: The payment schedule item is waiting to be processed. Processed: The payment schedule item has processed and the payment is created. Note the created payment could be either in the processed or error status. Error: Failed to collect the payment.
Cancellation Reason	The reason for canceling a payment schedule item.
Payment Method	The payment method that you want to collect the payment.
Payment Gateway	The payment gateway that processes the payment.
Payment	The unique ID of the payment collected during the payment schedule item.
Actions	The actions that you can take on the payment schedule item.

Billing documents information

The following table lists the information about associated billing documents displayed in the Associated Billing Documents section.

Field	Description
Billing Document Number	The sequence number of the billing document item.
Due Date	The due date of the billing document item.
Total Amount	The total amount of the billing document item.
Balance	The Balance field stores the remaining balance of the current payment schedule item. For example, Payment Schedule Item Amount = $10, but only $2 was collected by PAY-01, then Payment Schedule Item Balance = $8.