This integration is certified by Stitch. For support, contact Stitch support.
A newer version of Recurly is available in Stitch. This version will still continue to function, but may be deprecated at a future date.
Recurly integration summary
Recurly feature snapshot
A high-level look at Stitch's Recurly (v14-09-2016) integration, including release status, useful links, and the features supported in Stitch.
|Singer GitHub repository||
|Configurable Replication Methods||
Recurly setup requirements
To set up Recurly in Stitch, you need:
- A Standard or higher Stitch plan. While those currently in the Free Trial will also be able to set up Recurly, replication will be paused until a Standard plan or higher is selected after the trial ends.
Admin permissions in your Recurly account. This is needed to generate an API key.
Step 1: Generating a Recurly API Key
- Sign into your Recurly account.
- From the Recurly dashboard, click the Developers option in the sidebar.
- Click API credentials.
- Click the Add Private API Key button.
- Enter a name for the key. We recommend something that will tell you, at a glance, who or what is using the key - for example, ‘Stitch.’
The last section - Will this key be used with a third-party application? - is optional.
If you want to enter something here, you can select Other from the dropdown menu and then type Stitch into the Application Name field.
- When finished, click the Save Changes button to generate the key.
Leave this page open for now - you’ll need it to complete the setup in Stitch.
Step 2: Add Recurly as a Stitch data source
- Sign into your Stitch account.
On the Stitch Dashboard page, click the Add Integration button.
Click the Recurly icon.
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.
For example, the name “Stitch Recurly” would create a schema called
stitch_recurlyin the destination. Note: Schema names cannot be changed after you save the integration.
- Enter the subdomain for your Recurly site. For example, if our subdomain were
stitch.recurly.com, we would just enter
stitchinto this field.
- Paste the Recurly API key you generated into the API Key field.
Step 3: Define the historical sync
The Sync Historical Data setting will define the starting date for your Recurly integration. This means that:
- For tables using Incremental Replication, data equal to or newer than this date will be replicated to your data warehouse.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your data warehouse.
Change this setting if you want to replicate data beyond Recurly’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.
Step 4: Create a replication schedule
In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.
Recurly integrations support the following replication scheduling methods:
To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.
Step 5: Set tables to replicate
To complete the setup, you’ll need to select the tables you want to replicate to your data warehouse.
Check out the Schema section to learn more about the available tables in Recurly and how they replicate.
- In the Integration Details page, click the Tables to Replicate tab.
- Locate a table you want to replicate.
To track a table, click the checkbox next to the table’s name. A green checkmark means the table is set to replicate.
- Repeat this process for all the tables you want to replicate.
Initial and historical replication jobs
After you finish setting up Recurly, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.
For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.
Initial replication jobs with Anchor Scheduling
If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.
Free historical data loads
The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.
Recurly table schemas
Schemas and versioning
Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.
The schema and info displayed below is for version 14-09-2016 of this integration.
Table and column names in your destination
Depending on your destination, table and column names may not appear as they are outlined below.
For example: Object names are lowercased in Redshift (
customers), while case is maintained in PostgreSQL destinations (
CusTomERs). Refer to the Loading Guide for your destination for more info.