Install Configurable Payment Retry
This article enables you to install Configurable Payment Retry (CPR).
Before you can use an app, you must install the app on your Zuora tenant.
Prerequisites
Before installing CPR, ensure the following tasks are completed:
-
You must have a Zuora Connect account. For more information, see Link your Connect account to your Zuora account.
-
You must have purchased the app.
-
You must have created an OAuth login for your Zuora tenant. For more information, see Create an OAuth Login in Zuora Connect.
-
To install CPR, you must have the Platform Admin role. For more information about platform roles, see Platform roles.
Procedure
To install CPR to your Zuora tenant, complete the following steps:
-
Log into your Zuora tenant.
-
Navigate to Marketplace > Purchases.
-
Locate the Configurable Payment Retry app, hover over it, and click Deploy.
-
In the New Configuration window that opens, specify the configuration details for the app:
- Name - A name is automatically populated. Modify the name if necessary.
- Run Mode -See the app's documentation to learn about how to choose a run mode. For CPR, the run mode is Universal.
- Execution - Select External unless otherwise specified in the app's documentation.
- Build Name - Select Production - US, irrespective of your environment.
- Source, Target, etc - Select the tenant login for the app. Some apps or functions require using OAuth. For CPR, select the OAuth tenant login for the installation.
-
Click Create.
The app will be installed and populated under Marketplace in Zuora tenant shortly. You may need to refresh the page for the app name to display.
After the app is installed in the tenant, you can launch, configure, and use the app in Zuora tenant.
Create required custom fields
When you create CPR with Oauth credentials, Zuora will create the required custom fields. The custom fields will be created once the app has been launched and settings saved. The following are the CPR custom fields:
| Object and Category | Field Label | API Name | Data Type |
|---|---|---|---|
|
Account Fields (Indexed) |
Retry Status |
RetryStatus__c |
Text (255) |
|
Debit Memo Only available if the Invoice Settlement feature is enabled on your tenant. |
Retry Status |
RetryStatus__c
|
Text (255) |
|
Invoice Fields (Indexed) |
Retry Status |
RetryStatus__c |
Text (255) |
Custom fields may not generate automatically if you have reached the number limit of custom fields. If so, you must remove the existing custom fields and create existing custom fields manually. For more information on how to add a new indexed or non-indexed custom field, see How to manage custom fields. The maximum number of indexed custom fields and non-indexed custom fields for each customizable object varies depending on your Zuora edition or Zuora modules. For more information, see Zuora Editions and Zuora Modules.
What's next 
After installing Configurable Payment Retry, you need to complete initial configurations before it is ready for use. For instructions about configuring the app, see Configure Configurable Payment Retry.