Zuora

Configuration guide for the Zuora connector in Recurly Engage, including setup, data sync, and 1-Click subscription actions.

Overview

Required plan

This feature or setting is available to all customers on any Recurly Engage subscription plan.

Prerequisites & limitations

  • Company or App Administrator permissions in Recurly Engage.
  • 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, allowing you to attach 1-Click actions to prompt interactions for seamless subscription management.

Key benefits

  • Real-time subscription control: Add, remove, or modify rate plans within your prompts.
  • Lifecycle management: Suspend, resume, or cancel subscriptions via 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

Automated data sync

Coordinate with Customer Success to schedule daily imports of the following Zuora account and subscription traits into Recurly Engage via AWS S3 or your preferred CSV pipeline:

Trait NameValues
account_numberZuora account number
statusActive, Canceled, Draft
payment_termConfigured payment term (e.g., Net 30)
balanceOutstanding account balance
total_invoice_balanceTotal invoiced balance
credit_balanceAvailable credit balance
contracted_mrrContracted monthly recurring revenue
term_typeTERMED, EVERGREEN
subscription_start_dateDate the subscription term starts
subscription_end_dateDate the subscription term ends
term_start_dateStart date of the current term (may differ from subscription start if renewed)
term_end_dateEnd date of the current term (null or cancellation date for evergreen subscriptions)
auto_renewtrue or false
rate_plan_nameName 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 within your prompt editor. The account_number trait must be present on user records to target actions.

ActionDescriptionAdditional Instructions
Add PlanAdd a specified rate plan to an accountSelect the desired Product Rate Plan from the dropdown
Remove PlanRemove a specified rate plan from an accountSelect the Product Rate Plan to remove from the dropdown
Cancel SubscriptionCancel the active subscriptionChoose a Cancellation Policy (EndOfCurrentTerm, EndOfLastInvoicePeriod, SpecificDate) and Apply Credit (true/false)
Suspend SubscriptionPause an active subscriptionSpecify Suspend Policy (Today, EndOfLastInvoicePeriod, SpecificDate, FixedPeriodsFromToday)
Resume SubscriptionReactivate a suspended subscriptionSelect Resume Policy (Today, FixedPeriodsFromSuspendDate, FixedPeriodsFromToday, SpecificDate)
Change Auto RenewalToggle auto-renewal settingChoose AutoRenew (true or false)
Create SubscriptionCreate a new subscription with specified rate planProvide contractEffectiveDate, renewalTerm, Rate Plan, and Term Type

Guide: Configuring a 1-click Zuora action

  1. In your prompt editor, click Add Action.
  2. Choose Zuora as the connector and select the desired action (e.g., Add Plan).
  3. Pick the Product Rate Plan or policy settings from the dropdown.
  4. Save and publish your prompt.

Additional references