Articles in this section

Set up a connection to Recurly

Naga Sri Hari Gonaboyina
Updated

Recurly is the subscription management and recurring billing platform that drives transformational growth.

Set up a connection

After you start the connection, configure it in the Create connection panel and complete all of the required * authentication settings:

Note

  • If you select the Recurly v2 API type, you can use only v2 version supported APIs.

  • It is recommended to use the Recurly v3 API type to make use of the v3 version supported APIs, because the v2 API type will be deprecated soon.

Setting

Instructions

Name your connection *

Enter a clear and distinguishable name. Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

API type *

Select your Recurly account API type:

  • v2: Access legacy API endpoints to manage subscriptions, accounts, invoices, and billing workflows for existing integrations.

  • v3: Use the current API to manage subscriptions, plans, customers, invoices, payments, and billing workflows with expanded features and improved resource models for modern integrations.

v2 API type:

API version

Select one of the API versions, either 2.13 or 2.18 depending on the Recurly API version you're using.

Subdomain *

Enter your Recurly subdomain. To find your subdomain, sign in to your Recurly account. For example, if https://pgtest.recurly.com is the URL, then pgtest is your subdomain.

API key *

Enter your Recurly API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API key

v3 API type:

Region *

Select your Recurly account region (US or EU).

API key *

Enter your Recurly API key.

Multiple layers of protection, including AES 256 encryption, are in place to keep your API key safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

dataLoad.svg​​ How to retrieve the API key

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see the Basic universal connector documentation

How to retrieve the API key

  1. Sign in to your Recurly account.

  2. Navigate to Integrations > API credentials > Private API key .

  3. Copy the default Private API key.

    Note

    If required, click Add Private API key to generate a new API key.

Additional references