Recurly

Last updated on Sep 29, 2022
On This Page

Recurly is a subscription management and billing platform that enables you to manage your customers’ billing and payment processes. It gives you more visibility into your subscription business, thus allowing you to optimize your subscription growth strategy and reduce involuntary churn.

Hevo uses the Recurly API to ingest data from your Recurly account and load it to the desired Destination for scalable analysis.

Prerequisites

Creating the Recurly API Key

Perform the following steps to create an API key:

  1. Log in to your Recurly account.

  2. In the Home page, in the left navigation pane, click Integrations, and then click API Credentials.

    Click API Credentials

  3. In the API Credentials page, click Add Private API Key.

    Add private API key

  4. In the Add Private API Key page, in the API Key Information section, specify the following:

    • KEY NAME: A unique name for your API key.

    • Read-Only: Select the check box to grant read-only permission to your Recurly data.

    Click Save Changes.

    Save changes

  5. You have successfully created your API key. You can view the API key that you created in the API Credentials page. Use this API key for creating Hevo Pipelines.

    Use this API key

Configuring Recurly as a Source

Perform the following steps to configure Recurly as the Source in your Pipeline:

  1. Click PIPELINES in the Asset Palette.

  2. Click + CREATE in the Pipelines List View.

  3. In the Select Source Type page, select Recurly.

  4. In the Configure your Recurly Source page, specify the following:

    Configure your Recurly Source

    • Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.

    • API Key: The private key that you created in your Recurly account, to enable Hevo to read data.

    • EU Environment (only visible to users in the Europe region of Hevo): Enable this if your Recurly account is in the European Union (EU) region. Read Data Hosting in Recurly to know about all the regions that Recurly supports.

    • Historical Sync Duration: The duration for which the existing data in the Source must be ingested. Default duration: 3 Months.

  5. Click TEST & CONTINUE.

  6. Proceed to configuring the data ingestion and setting up the Destination.

Data Replication

Default Pipeline Frequency Minimum Pipeline Frequency Maximum Pipeline Frequency Custom Frequency Range (Hrs)
3 Hrs 15 Mins 24 Hrs 1-24

Note: The custom frequency must be set in hours, as an integer value. For example, 1, 2, 3 but not 1.5 or 1.75.

  • Historical Data: In the first run of the Pipeline, Hevo ingests the historical data for all the objects using the Recent Data First approach. The data is ingested on the basis of the historical sync duration selected at the time of creating the Pipeline and loaded to the Destination. Default duration: 3 Months.

  • Incremental Data: Once the historical load is complete, all new and updated records are synchronized with your Destination as per the ingestion frequency.

Schema and Primary Keys

Hevo uses the following schema to upload the records to the Destination database:

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Object Description
Account Contains the details of all your customers.
Account Acquisition Contains the details of an account’s acquisition data, such as the marketing channel and campaign through which the account was acquired.
Add on Contains the details of all the add-ons associated with a subscription plan. An add-on is a charge billed through each billing period in addition to a subscription’s base charge.
Coupon Contains the details of the coupons available for the customers on your site.
Credit Payment Contains the details of the credit payments made to the customers.
Invoice Contains the details of the invoices of all the billing events in your Recurly account.
Item Contains the details about the items available for purchase by the customers. Item is the term used to refer to all your physical, digital, or service-oriented offerings collectively in Recurly.
Line Item Contains the details about line items. Line items are the charges and credits on your customer’s invoices.
Measured Unit Contains the details about the measured units of a site. Measured units provide a display name for the quantity of a usage-based add-on. For example, Gigabytes (GB) for an add-on offering additional data.
Plan Contains the details about all the plans available for your customers.
Shipping Method Contains the details of the methods used to ship products to customers.
Subscription Contains the details of subscriptions of a customer. Subscriptions are created when your customers subscribe to one of the plans.
Transaction Contains the details about the transactions made by the customers. Transactions refer to the process of sending the purchasing information to your payment gateway. The purchasing information includes the customer’s billing information and the amount of money to be charged, voided, or refunded.

Revision History

Refer to the following table for the list of key updates made to this page:

Date Release Description of Change
Sep-05-2022 NA Updated section, Data Replication to reorganize the content for better understanding and coherence.
Jun-09-2022 1.90 New document.
Was this page helpful?

Tell us what went wrong