Stitch Documentation
has moved!

Please update your bookmarks to https://www.stitchdata.com/docs

If you're not automatically redirected after 5 seconds, click here.

Expected Recurly Data

Now that Recurly is successfully connected to your Stitch account, what comes next? In this article, we'll cover:

Replicating Recurly Data

Historical Sync

By default, a historical sync of Recurly data goes back one year from the Stitch connection date.

Frequency

Stitch will replicate Recurly data based on the frequency you define. The default setting is every half hour, but you can change it to more or less frequent based on your needs.

Replication Methods

The majority of Recurly tables are replicated using Incremental Table replication.This means that every time Recurly data is queued for replication, only new and updated rows will be replicated.

The only exception to this is the plans table, which uses Full Table Replication. This means that during every replication attempt, all the rows in this table - including existing, new, and updated - will be replicated.

Due to the potentially high number of rows for each replication attempt, we recommend choosing a less often replication frequency setting to keep your row count down.

Recurly Tables in Your Data Warehouse

Below is a list of the main and subtables that will be created in your data warehouse. Because Recurly uses nested arrays to structure data in some of its API's endpoints, Stitch will de-nest these arrays and create subtables. Refer to the Handling of nested data structures doc for more info.

Click the table name to see a full list of attributes for that table in Recurly's API documentation.

accounts
Primary Key:
account_code

The accounts table contains comprehensive customer account information.

Attributes include the account code, billing info URL, subscription URL, state (status), username, email, contact information, tax info, creation info, and more.

add_ons
Primary Key:
add_on_code

The add_ons table contains information about plan add-ons, which are additional products in your plan that recur.

Attributes include the add-on code, name, tax code, unit amount, accounting code, and created at date.

  • add_ons__unit_amount_in_cents - This subtable is created from the unit amount in cents array, which contains unit amounts and currency codes.

    The composite key for this table - the add on ID and unit amount ID  - can be used to tie it back to its parent table, add_ons: _sdc_source_key_add_on_code:_sdc_level_0_id

 

billing_info
Primary Key:
account_href

The billing_info table contains information about your customers' billing details.

Attributes include the account code, contact info, card type, bank info, and more.

Note that while there is not sensitive info (e.g. credit card numbers) in this table, but you should still work to keep this data private as there are columns containing bank information.

coupons
Primary Key:
coupon_code

The coupons table includes information on active coupons.

Attributes include the coupon code, name, state, discount type, redeem by date, max # of redemptions, plan application, duration, and more.

invoices
Primary Key:
invoice_number

The invoices table contains invoice data.

Attributes include the invoice ID (invoice_number), state (ex: failed), account info, contact info, tax info, address info, collection method, currency, customer notes, net terms, PO number, subscription URL, subtotal in cents, terms and conditions, vat number, and closed and created at dates.

  • invoices__line_items - This subtable is created from the line items array, which can contain adjustment, transaction, invoice, and subscription info.

    The composite key for this table - the invoice number and line item ID  - can be used to tie it back to its parent table, invoices: _sdc_source_key_invoice_number:_sdc_level_0_id

plans
Primary Key:
plan_code

The plans table houses the data relating to each of your plans.

Attributes include the plan code, name, description, interval length and unit, trial interval length and unit, total billing cycles, accounting code, tax info, setup fee, and creation info.

redemptions
Primary Key:
uuid

The redemptions table contains data on coupon redemptions at the account level.

Attributes include the redemption ID (uuid), total discount, currency, state, and creation information.

subscriptions
Primary Key:
uuid

The subscriptions table is a record of all your subscriptions.

Attributes include the subscription ID (uuid), plan code, name, ID, state (status), currency, activation date, cancellation and expiration info, trial info, tax info, and add-on info.

transactions
Primary Key:
uuid

The transactions table includes account transaction information.

Attributes include the transaction ID (uuid), account and account details, invoice, and subscription info, transaction amount, currency, status, payment method, source, refundable, IP address, and creation info.

Related:

Was this article helpful?
0 out of 0 found this helpful

Comments

Questions or suggestions? If something in our documentation is unclear, let us know in the comments!