Zuora
Learn how to integrate Zuora with Revaly to optimize subscription payment approvals
Introduction
This guide explains how to integrate Zuora with Revaly's approval engine to optimize subscription payment approvals.
Once configured, Zuora sends billing events to Revaly through Event Notifications. Revaly then assumes control of the approval lifecycle, determining when and how subsequent payment attempts should occur based on its AI-driven optimization models.
Zuora remains the system of record for subscriptions, invoices, and payments, while Revaly manages approval strategy and execution.
Required Information
The following information is required to configure the Zuora integration with Revaly:
- API User: A dedicated API user that allows Revaly to interact with your Zuora tenant. The user must have permission to create payments, cancel invoices, and cancel subscriptions, along with read access to the billing objects required for approval optimization.
- Event Notifications: Callout Notifications configured to send billing events from Zuora to Revaly. These notifications allow Revaly to receive payment and subscription events in near real time.
- Temporary UI Access (Recommended): Temporary access to your Zuora environment is recommended during implementation and launch. This allows the Revaly team to validate configuration, troubleshoot issues, and verify the integration before and after go-live.
Enabling the Integration
To enable the integration with Zuora, you will configure API access, create Event Notifications, and complete testing before activating Revaly in your production environment.
This guide assumes your Revaly account is already configured. If not, contact your Client Success Manager or email [email protected].
The integration consists of the following steps:
Create a dedicated API user for Revaly. The API user must be able to perform the following actions:
- Create Payments
- Cancel Invoices
- Cancel Subscriptions
These permissions allow Revaly to execute payment retries and manage the approval lifecycle within Zuora.
The following API endpoints require write access:
In addition, the API user must have read access to:
- Accounts
- Invoices
- Payments
- Products
- Refunds
Configure Zuora Callout Notifications to send billing events to the webhook endpoint provided by Revaly.
These notifications allow Revaly to receive payment events as they occur and begin managing the approval lifecycle.
Follow Zuora's documentation to configure Callout Notifications.
Testing
Before enabling the integration in production, validate the integration using your Zuora staging environment.
Providing temporary UI access to a Revaly team member is recommended for both staging and production environments. This allows configuration to be validated and simplifies troubleshooting if issues arise after launch.
The testing process typically includes the following steps:
- Provide the required API credentials and Event Notification configuration for the staging environment.
- Create test subscriptions and intentionally trigger failed payments.
- Verify that Revaly successfully retrieves the required billing information and schedules retry activity.
- Confirm that payment activity and subscription updates behave as expected in Zuora.
- Complete a joint Go/No-Go review before enabling the production environment.
Go-Live
After testing has been successfully completed, the production integration can be enabled.
The launch process typically consists of the following steps:
- Provide the required API credentials and Event Notification configuration for the production environment.
- Allow Revaly to temporarily operate in test mode while validating production data.
- Disable Zuora's existing dunning process.
- Disable Revaly's test mode to begin live approval optimization.
Once these steps are complete, new failed payment events received from Zuora will be managed by Revaly's approval engine.
Updated 1 day ago