The Zuora integration connects your Zuora tenant to Recurly Engage, so you can sync subscription data and manage subscriptions directly from prompts.

Available on all Recurly Engage subscription plans

1Definition 2Key benefits 3Key details

Prerequisites

You must have Company or App Administrator permissions in Recurly Engage.
You must have a Zuora tenant with API access credentials (Client ID and Client Secret).

Definition

The Zuora connector synchronizes subscription traits and product rate plans from Zuora into Recurly Engage, so you can attach 1-Click actions to prompt interactions and manage subscriptions.

Key benefits

Real-time subscription control Add, remove, or modify rate plans within your prompts.

Lifecycle management Suspend, resume, or cancel subscriptions through in-app actions.

Automated data flows Keep Recurly Engage updated with the latest account and subscription balances.

Key details

Required settings

Under Settings > Connectors, configure your Zuora connector by providing:

API URL: Your Zuora REST API endpoint.
Client ID and Client Secret: OAuth credentials for API authentication.

Data integration

Coordinate with Customer Success, or contact [email protected], to schedule daily imports of the following Zuora account and subscription traits into Recurly Engage through Amazon Web Services (AWS) S3 or your preferred comma-separated values (CSV) pipeline:

Trait name	Values
`account_number`	Zuora account number
`status`	`Active`, `Canceled`, `Draft`
`payment_term`	Configured payment term (for example, Net 30)
`balance`	Outstanding account balance
`total_invoice_balance`	Total invoiced balance
`credit_balance`	Available credit balance
`contracted_mrr`	Contracted monthly recurring revenue
`term_type`	`TERMED`, `EVERGREEN`
`subscription_start_date`	Date the subscription term starts
`subscription_end_date`	Date the subscription term ends
`term_start_date`	Start date of the current term (may differ from subscription start if renewed)
`term_end_date`	End date of the current term (null or cancellation date for evergreen subscriptions)
`auto_renew`	`true` or `false`
`rate_plan_name`	Name of the most recent rate plan

1-Click actions

Once your connector is activated and rate plans have synchronized, you can configure these 1-Click actions in your prompt editor. The account_number trait must be present on user records to target actions.

Action	Description	Additional instructions
Add Plan	Add a specified rate plan to an account	Select the desired Product Rate Plan from the dropdown
Remove Plan	Remove a specified rate plan from an account	Select the Product Rate Plan to remove from the dropdown
Cancel Subscription	Cancel the active subscription	Choose a Cancellation Policy (`EndOfCurrentTerm`, `EndOfLastInvoicePeriod`, `SpecificDate`) and Apply Credit (`true`/`false`)
Suspend Subscription	Pause an active subscription	Specify Suspend Policy (`Today`, `EndOfLastInvoicePeriod`, `SpecificDate`, `FixedPeriodsFromToday`)
Resume Subscription	Reactivate a suspended subscription	Select Resume Policy (`Today`, `FixedPeriodsFromSuspendDate`, `FixedPeriodsFromToday`, `SpecificDate`)
Change Auto Renewal	Toggle auto-renewal setting	Choose AutoRenew (`true` or `false`)
Create Subscription	Create a new subscription with specified rate plan	Provide contractEffectiveDate, renewalTerm, Rate Plan, and Term Type

Configure a 1-Click Zuora action

Add an action

In your prompt editor, select Add Action.

Choose Zuora

Choose Zuora as the connector and select the action you want (for example, Add Plan).

Pick the plan or policy

Pick the Product Rate Plan or policy settings from the dropdown.

Save and publish

Save and publish your prompt.

Additional references

Zuora API reference