Recurly Overview

Vitally's Recurly integration can be used to sync the following Recurly data into Vitally in real time:

Customers - Vitally can import your Recurly customers into Vitally as accounts. When done, we'll add a wealth of new Recurly-defined traits to your Vitally profiles, such as the expiration of the customer's credit card, the plans they are subscribed to, and much more!
Revenue data - Vitally also imports your historical paid invoices from Recurly so that you have immediate, accurate insight into the purchase history of every account in Vitally.

Enabling the Recurly integration

To enable the Recurly integration, navigate to your Settings (⚙️) by selecting your Account Logo on the top left and under Operations select Integrations to find Chargebee (or via Quick Jump). Once you click the switch in the top right, you'll be asked for a Recurly API key.

Recurly has two data centers (EU and US), by default the option is US. If you are on the EU data center, then you can select that option from the drop-down.

Creating your Recurly API Key

For Vitally to be able to access your Recurly data, you will need to provision a Read-Only API key for Vitally. To do so, in your Recurly account, navigate to Integrations -> API Credentials.

Create a new API key and select the Read-Only option. Specify the key name and the application using the key to Vitally.

Finally, copy your new API key into the Vitally integration form and click submit.

Configure the integration

Once you enter your API key, you'll be prompted to select the production subdomain associated with this key. Once you select the subdomain, configure the account name and ID fields to ensure Vitally correctly imports & syncs your Recurly data.

Selecting the right Customer ID field is critical! You must attach the same ID to customers in both Recurly and your analytics data system (e.g. Segment, Mixpanel). Without this, we have no way of matching customers from Recurly to the existing customers we created from your analytics data (and vice versa).

If you are already tracking customer IDs in Recurly, simply select the appropriate trait here and click Update Recurly Configuration. At this point, we'll import your existing Recurly customers and revenue data, and will continue to sync that data as it changes moving forward.

Create a Recurly Webhook to sync changes in real-time

Vitally's Recurly integration requires setting up a webhook in Recurly to notify us of any relevant changes. Follow the instructions in Vitally to set up a new Webhook in Recurly.

The endpoint URL domain differs based on the data center you are on:

US Data Center: https://{yoursubdomain}.app.vitally.io

EU Data Center: https://{yoursubdomain}.app.vitally-eu.io

Please select Format -> XML in Recurly for the Vitally webhook.

Details about the Recurly integration

The Recurly integration works by initially importing all your existing accounts and subscriptions, as well as their past paid invoices.
Moving forward, we then listen for customer, subscription, and invoice changes using Recurly's webhooks. If an account or subscription is created, updated, or deleted in Recurly, we will handle that appropriately by creating, updating, or deleting (churning) the customer in Vitally. Additionally, if a Recurly invoice is paid, we will update the customer's MRR and renewal dates in Vitally.
Once you enable the Recurly integration, we will automatically adjust your revenue and churn tracking configuration to sync with Recurly. This means we will override any past configuration you had. If you'd rather that not happen, please reconfigure each after the integration is enabled. Note that if you have an existing trial tracking configuration, we will not override it. We do this because many teams choose to track trials internally, outside of Recurly.
All Recurly data is also attached to your Vitally customers as traits, giving you the ability to leverage that data in reports and Indicators.

Recurly account traits available in Vitally

When we import a customer from Recurly, we'll automatically add the below traits to your accounts in Vitally. Keep in mind that you can segment accounts by any traits, so you'll be able to run reports across all these fields below in Vitally 🎉

Trait	Type	Description
Account Acquisition Campaign	string	See Recurly account acquisitions
Account Acquisition Channel	string	See Recurly account acquisitions
Account Acquisition Cost	number	See Recurly account acquisitions
Account Acquisition Subchannel	string	See Recurly account acquisitions
Account Card Expiration	date	The date the customer's primary card in Recurly is set to expire
Account Code	string	The code of the account in Recurly
Account Company	string	The defined company in Reculry
Account Email	string	The email of the account in Recurly
Account ID	string	The ID of the account in Recurly
Account State	string	The state of the account in Recurly
Account Username	string	The username of the account in Recurly
Account Currency	string	The currency of the account in Recurly
Current Period Stated At	date	The date the customer's subscription started
Current Period Ends At	date	The date the customer's subscription is set to renew. Note that we'll automatically use this trait as your renewal trait in your Subscribed Customers configuration.
Current Subscription Status	string	Set to either trialing, paying, or canceled. We calculate this trait for you and use it to auto-categorize your customers as trials, subscribed, or churn in Vitally.
Discount Absolute Amount	number	The flat discount the customer applies to their balance, if applicable
Discount Duration	number	The duration the customer's discount is valid for, if applicable
Discount Name	string	The name of the customer's discount, if applicable
Discount Percent	number	The percentage discount the customer applies to their balance, if applicable
Last Invoice Created At	date	The date of the customer's last invoice in Recurly
Last Invoice Due At	date	The date the customer's last invoice was due in Recurly
Last Invoice Id	string	The ID of the customer's last invoice in Recurly
Last Invoice Number	number	The number of the customer's last invoice in Recurly
Last Invoice Subtotal	number	The subtotal of the customer's last invoice in Recurly
Last Invoice Total	number	The total of the customer's last invoice in Recurly
Mrr	number	This is an auto-calculated trait we set for you. It is set to the maximum of either 1) the customer's last invoice amount or 2) the customer's subscription amount. We'll also automatically use this trait as your revenue trait in your Subscribed Customers configuration.
Plan Code	string	The plan code for the customer's primary subscription
Plan Id	string	The plan ID for the customer's primary subscription
Plan Name	string	The plan name for the customer's primary subscription
Subscription Canceled At	date	The date the customer's primary Recurly subscription was canceled
Subscription Expires At	date	The date the customer's primary Recurly subscription will expire
Subscription Id	string	The ID of the customer's primary Recurly subscription
Subscription State	string	The state of the customer's primary subscription in Vitally
Subscription Subtotal	number	The subtotal of the customer's primary subscription in Vitally
Trial Started At	date	The start date of the customer's trial in Recurly
Trial Ends At	date	The end date of the customer's trial in Recurly. Note that we'll automatically use this trait as your trial end trait in your Trials configuration.