Skip to navigation
PaymentsConfigurable Payment Retry

List the amount recovered metrics

View as Markdown
Gets the Amount Recovered metrics, including the total amount recovered and the amount recovered over the last 30 days broken down by currency.

Authentication

AuthorizationBasic
The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry.

Response

currencylist of objectsOptional

An array containing the following information for each available currency. If no payment of a given currency has been processed over the last 30 days, the currency will not appear in the array.

  • The total amount recovered to date
  • The amount recovered over the last 30 days
successbooleanOptional

Indicates whether the metrics are retrieved successfully.

If no data is loaded yet, a 200 response code will be returned with the success field set to true. All expected fields will be present but the value will be null.