Recurly

Recurly provides billing management for many subscription businesses. The Recurly/Grow integration offers businesses a platform to manage all of the subscription data in one place. This article gives you an overview of the integration on how to connect with Grow.

Recurly is only available as a warehoused data source.

Connecting to Recurly

Before you get started you need your Recurly API Key and Domain.

  1. From the Homepage, click on Data.
    This takes you to the Data Connections page.
  2. Click on the blue Connect button.
  3. Search and select Recurly.
  4. Enter your API Key.
    To generate an API Key, you need to have manager or admin permissions in Recurly.
    1. Log in to your Recurly account, then click on Integrations in the menu.
    2. Select API Credentials.
    3. Click on the Add Private API Key button.
    4. Assign a name for your API Key and any notes that you need about what can be used.
    5. Select Grow as the application using the key in the section about a third-party application, .
    6. Select Save Changes.
  5. In the domain field, enter the Subdomain you have created for your account.
  6. Press Submit.

Regenerating an API Key

You can regenerate your API Key using two methods. Note that the existing API Key remains active for 12 hours before getting disabled. The following steps help you regenerate a key:

  1. Navigate to Developers > API Keys.
  2. Select Identify to choose the key you wish to regenerate.
  3. Choose the Regenerate Key option.
  4. Select the behavior you want to apply to the existing API Key.

Warehouse (Alpha)

Accounts

  • Account Shipping Addresses: Account id and information regarding the shipping address.
  • Accounts (Formatted): Id, username, email, first & last name, company, and more in-depth account information.

Add Ons

  • Add On Currencies: Add on id, currency type, and currency amount
  • Add On Tiers:Add on id, ending tier quantity, and tier usage
  • Add Ons (Formatted):Id, name, type, along with usage and item information

Coupons

  • Coupon Items:Coupon id and information regarding items
  • Coupon Plans:Coupon id and information regarding plans
  • Coupons (Formatted)
  • Coupon Redemption History:
  • Recurly Coupon History:
  • Invoice Coupon Redemption History:
  • Subscription Coupon Redemption History:

Credit Payments

  • Credit Payments (Formatted)

Invoices

  • Invoice Credit Payments: Invoice id along with information on credit cards, refunds, and voids
  • Invoice Line Item: Invoice id along with information on line items accounts, invoices and shipping
  • Invoice Transaction:Invoice id, transaction id, account details, along with transaction information
  • Invoice (Formatted): Id, invoice number, collection status & method, and balances

Items

  • Item Currencies
  • Items (Formatted)

Line Items

  • Line Items (Formatted):Id, type, state, subscription id, plan id, invoice id, in-depth information on line items including shipping, purchase amounts, and accounts

Measured Units

Plans

  • Plan Currencies:Plan id, currency type, currency setup fee, and currency unit amount
  • Plans (Formatted):Id, state, name, description, interval units, interval length, and trial units

Sites

  • Sites (Formatted):Id, subdomain, mode, and public api key

Subscriptions

  • Subscription Add Ons:Subscription id, add on id, add on code, and more in-depth information on add ons
  • Subscription Coupon Redemptions:Subscription id along with coupon redemption information
  • Subscription (Formatted):Id, billing info id, along with in-depth information on billing cycles, collections, and accounts

Transaction

  • Transaction (Formatted): Id and in-depth information for transaction data including accounts, billing address, invoices, subscription, and payments
Was this article helpful?