Set up your Recurly integration

Set up the Recurly integration to retrieve recurring billing and subscriptions data from your SMB customers.

Before you can use the integration, your SMB customers (merchants who use Recurly) need to retrieve their secure API credentials from their Recurly account and enter them in Link. Recurly does not require any global credentials for accessing the API.

To set up the integration, you perform these tasks:

  • Enable the Recurly integration
  • Create companies in Codat and then share the Link URL with your SMB customers

Next, the SMB customer performs this task:

  • Connects their Recurly account to Codat

Enable the Recurly integration

When you've been granted access to the integration, enable it in the Codat Portal.

  1. On the navigation bar, click Settings > Commerce.
  2. Click the toggle next to Recurly to set the integration to Enabled.

If the integration was enabled successfully, the switch remains set to Enabled. You can also enable this integration directly from its Integration settings page.

Create a company and share the Link URL with your SMB customers

📘

Options for SMB authentication

Using Link for SMB authentication is optional. You can also build your own authentication flow using the Codat API (the platform key for Recurly is required).

In the Codat Portal:

  1. Click Companies > New company.
  2. In the Add new company dialog, enter a name for the company, then click Add. The Link URL is displayed.
  3. Provide the Link URL to your SMB customers.

SMB customer: Connects their Recurly account to Codat

Your SMB customer connects their Recurly account to Codat using Link. To authenticate with Codat, they need to get their Private API key from Recurly.

For help with this procedure, see Authentication in the Recurly documentation.

Your SMB customer performs the following steps:

  1. Opens the Link URL in their browser.

  2. On the Commerce step in Link , they select the Recurly tile, then click Next.

  3. Reviews the requested permissions on the Connect to Recurly page, then clicks Next.

    The Your Recurly API key page is displayed.

    Your Recurly API keyYour Recurly API key

  4. Opens a new browser tab, visits app.recurly.com, and signs in to their Recurly account.

  5. In the side panel, clicks Integrations then API Credentials.

  6. Clicks the eye icon to reveal the Private API Key.

  7. Enters their key in the Your Recurly API key page.

  8. Clicks Continue.

  9. If the data connection was successful, they click Finish to close Link.

Your SMB customer has now connected their Recurly account to Codat.


Did this page help you?