View payment schedules
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 fitler 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.
To view information about a recurring payment schedule through the REST API, use the following operations:
- View payment schedules
- List payment schedules by account
- Retrieve the payment schedule statistic of a specific date
- Retrieve payment schedule items
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. |
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. |
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. |
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. |
Status |
The status of the 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. |