Start a conversation

Integrating Recurly with CustomerSuccessBox


CustomerSuccessBox supports integration with Recurly to pull in Account, Subscription and Invoice data. In this article, we explore the steps and requirements to integrate with Recurly.

Why should I integrate with Recurly?

Integrating Recurly with CustomerSuccessBox, enables you to 

  • Have a 360 degree view of your customers
  • Configure Risk Alerts on Invoice/Subscription status, Due/Paid Amount, Due/Paid Dates
  • Set up Financial Health
  • Segment Accounts on MRR, Amount, Plan Quantity, Plan Names, Invoice Status etc. 


Your Customer Success Manager will discuss the different options available to you for bringing in data from Recurly during the kick-off call. 

Finalize Account and User Identifiers

CustomerSuccessBox requires a unique identifier for Account and User records that should be immutable. The source of truth for the identifiers can be your tenant/instance, Recurly or any third-party system. 

Source of truth
Set the unique identifier of tenant/instance on a custom field belonging to the Account or Subscription object in Recurly
Set unique identifiers of Recurly Account/Subscription to all systems the data would be pulled/pushed from
Other Third Party Tools
Set the unique identifier of third-party on a custom field belonging to the Account or Subscription object in Recurly

To learn more about creating Cutom Fields in Recurly refer to the Reculy Documentation on Custom Fields

Finalize Mapping Details

Once you have finalized the source of truth for unique Account and User identifiers, share the object_name and field_name where the unique identifier is available and/or set in Recurly with your Customer Success Manager or fill the details in the onboarding document shared with you. 

Creating Accounts and Subscriptions

You can choose Recurly as the source of truth for the creating and updating Accounts and Subscriptions data in CustomerSuccessBox, if you prefer. Account and Subscription attributes can be updated on an ongoing basis - either manually, via APIs, or the data can be pulled from Recurly. You can choose one of the two options available below

  1. Daily Sync: Overrides any manual changes done in CustomerSuccessBox
  2. Import Only: One time import of new and existing Account and Subscription data from Recurly. Attributes can be updated either manually or pushed via APIs
To learn more about creating Accounts and Users, refer to 'When should an account be created?' section of the Getting Started Guide
To learn more about unique Account ID and User ID, refer 'What should be the unique identifier for account and user?' section of the Getting Started Guide

Authorizing Access to Recurly

Follow the steps below to authorize CustomerSuccessBox access to Recurly 

  1. Generate 'API Key' in Recurly. If you need help on how to generate the key, follow the steps here 
  2. Log-in to your CustomerSuccessBox instance 
  3. Navigate to the Integrations Hub from Settings (Gear Icon) > Integrations 
  4. Find and click on on Recurly in the Integrations Hub 
  5. You can choose to integrate a Single Instance or Multiple Instances of Recurly
    • Single Instance:
      1. Enter your 'subdomain name' in the Site field
      2. Fill in the API key in the API Key field
    • Multiple Instances
      1. Enter 'Recurly' in the Site field
      2. Fill the API key in the API Key field the format below
"subdomain1": "API_key1",
"subdomain2": "API_key2",
"subdomain3": "API_key3"

Once all the above steps are done, drop a line to us via Chat on the left navigation panel. CustomerSuccessBox engineering team will do the heavy lifting and complete Recurly integration for you. 

Contact Us

In most cases, you would have a dedicated Customer Success Manager who will be your point-of-contact for any queries or assistance. You may also,

  1. Initiate a chat directly from within CustomerSuccessBox. Use chat option from Chat option under help tab present on the top navigation bar
  2. Create a conversation from here
  3. Send an email to


Choose files or drag and drop files
Was this article helpful?
  1. Pervez

  2. Posted