This is the REST API reference for Zuora Collections. This reference provides detailed descriptions about functions, requests, and responses of the APIs for the following two component apps. Rest APIs for other component apps will be included in this reference when they are released.

• Advanced Payment Manager
• Collections Window
• Configurable Payment Retry
• Notes
• Statement Generator

Note: The Collections Window, Notes, Advanced Payment Manager, Payment Plans, and Statement Generator features are entering end of support on June 3, 2024. For more information, please refer to the Product and Feature End of Support page.

Advanced Payment Manager, Collections Window, Configurable Payment Retry, and Statement Generator use basic authentication. The user name is your email address for logging in to Zuora. The password is the API token shown in the Collections feature's settings. Notes use API-token only for authentication. Alternatively, you can use "API-Token" as the header key and the API token shown in the Setting of Notes as the value.

Note: The Collections Window, Notes, Advanced Payment Manager, Payment Plans, and Statement Generator features are entering end of support on June 3, 2024. For more information, please refer to the Product and Feature End of Support page.

Base URLs for different components are different. Click the drop-down arrow at the end of an endpoint to display the full endpoint.