Skip to content

Recurly

This page describes how to configure a Recurly data source. With Data Loader, you can replicate and load your source data into your target destination.

Recurly is a Flex connector. In the Data Productivity Cloud, Flex connectors are preconfigured connectors that satisfy a number of endpoints (see below).

You can use the Recurly connector in its preconfigured state, or you can edit the connector by adding or amending available endpoints in your Recurly source as per your use case. You can edit Flex connectors in the Custom Connector user interface.

Schema Drift Support: Yes. Read Schema Drift to learn more.

Return to any page of this wizard by clicking Previous.

Click X in the upper-right of the UI and then click Yes, discard to close the pipeline creation wizard.

Prerequisites

Read the Allowed IP addresses topic before you begin. You may not be able to connect to certain data sources without first allowing the Batch IP addresses. In these circumstances, connection tests will always fail and you will not be able to complete the pipeline.

Endpoints

The following endpoints are available by default for the Recurly Flex connector:

Endpoint Name Description Documentation
Accounts The account object stores the entire Recurly history of your customer and acts as the entry point for working with a customer's billing information, subscription data, transactions, invoices and more. Click here
Coupons Coupons can either be single codes that easily allow mass distribution by many customers or bulk coupons that can generate many unique coupons that can allow for individual delivery and tracking. Click here
Coupons Redemptions for Accounts Coupon redemptions are created when a coupon is applied to an account or subscription. Click here
Coupons Redemptions for Invoice List the coupon redemptions applied to an invoice. Click here
Coupons Redemptions for Subscription List the coupon redemptions for a subscription. Click here
Invoice An invoice relates charges, credits, and payments together. Click here
Plan A plan tells Recurly how often and how much to charge your customers. Click here
Plan Addons An add-on is a charge billed each billing period in addition to a subscription's base charge. Click here
Subscriptions Subscriptions are created when your customers subscribe to one of your plans. Click here
Transactions Purchasing information is sent to your payment gateway in an action called a transaction. Click here

Create pipeline

  1. In Data Loader, click Add pipeline.
  2. Choose Recurly from the grid of data sources. You can also use the search bar.

:::info{title='Note'} When you create a Recurly Flex connector, it will become accessible from the Custom Connectors tab of the Choose sources menu. Read Flex connector setup for more information. :::

Choose endpoints

Select one or more endpoints to use. Use the arrow buttons to move endpoints to the Endpoints to extract and load listbox and then reorder any tables with click-and-drag. Additionally, select multiple tables using the SHIFT key.

Click Continue with X endpoints to move forward.

Configure your endpoints

You need to configure each endpoint you wish to use. These instructions assume you have kept Configuration Mode set to "Basic".

General

The General tab displays the endpoint URL. In this tab, you can set your data warehouse table name and choose either "Basic" or "Advanced" configuration.

  1. Provide a data warehouse table name.
  2. Choose either Basic or Advanced. Advanced configuration requires more manual user input. Read Custom Connector batch pipeline to learn more.

Authentication

Recurly uses basic authentication. You'll need a Recurly username and password.

  1. Specify your Recurly username.
  2. Click Manage underneath the Password drop-down.
  3. Use the Manage Passwords dialog to save your password in the password entry.
    1. Click + Add new password.
    2. In the Add new password dialog, provide a unique, descriptive password label.
    3. Provide the literal value of the password.
    4. Click Save password.
    5. Click Done.
    6. In the Password drop-down menu, choose your newly created password.

Behaviour (advanced mode)

In the Behaviour tab you can choose which elements you want to include as columns in the target table. By default, all elements are selected.

Parameters

Recurly does not require any parameters.

Parameters (advanced mode)

Recurly does not require any parameters.

Keys (advanced mode)

In the Keys tab:

  1. Add a key column by selecting a property from the drop-down. Use the + Add property button to add further properties as required.
  2. Select required parameters from the drop-down menu.

Choose destination

Choose an existing destination or click Add a new destination.

  • Read Set up Snowflake to configure your Snowflake account to use Snowflake as a destination within Data Loader.
  • Read Connect to Snowflake to use Snowflake as your destination for batch-loading a pipeline.

Set frequency

Property Description
Pipeline name A descriptive label for your pipeline. This is how the pipeline appears on the pipeline dashboard and how Data Loader refers to the pipeline.
Sync every The frequency at which the pipeline should sync. The minimum frequency is every 5 minutes. Day values include 1—7. Hour values include 1—23. Minute values include 5—59. The input is also the length of delay before the first sync.

:::info{title='Note'} Currently, you can't specify a start time. :::

Once you are happy with your pipeline configuration, click Create pipeline to complete the process and add the pipeline to your dashboard.

Support

For any queries or assistance, visit Getting support or visit our support portal.