The Reference Docs Developer Hub

Welcome to the Reference Docs developer hub. You'll find comprehensive guides and documentation to help you start working with Reference Docs as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

MailChimp Integration

Recurly makes it simple to connect with MailChimp so that your subscriber lists are automatically kept up to date and fresh. Once your MailChimp account is connected with Recurly, you can easily segment your campaigns in MailChimp and target your communications based on a variety of attributes passed from Recurly to MailChimp.

Configuration

To start, you will need a MailChimp account and a Recurly account. Sign up for a free MailChimp account if you do not yet have a MailChimp account.

Log into MailChimp and create a new Mailing List. Recurly can synchronize with an existing list, but it's best to start fresh.

When your list is ready, log into Recurly and:

  1. Click Integrations.
  2. Click MailChimp.
  3. Enter your MailChimp API key, and click Connect to MailChimp.
  4. Recurly asks you to select an existing mailing list to synchronize with. Choose the list created earlier. If you do not have any lists in MailChimp, you will need to create one and then refresh this page within Recurly. If you have more than 10 MailChimp lists and the desired list does not appear as an option in Recurly, you may need to delete or consolidate your MailChimp lists in order for the desired list to appear.
  5. Click Use MailChimp List.

You're all set! Recurly synchronizes twice a day, so it may take up to 12 hours for your first sync to occur. Recurly will automatically create all the merge fields it uses and will keep your account list up to date. There's nothing else to do but set up a mail campaign and start communicating with your customers.

Synchronization

After you setup MailChimp integration, Recurly will synchronize changes to your accounts twice a day. During the synchronization, Recurly will submit new and updated account information for your accounts. Closed accounts will automatically be unsubscribed from your mailing list. Changes inside of MailChimp are not synced back, so we recommend making all account updates inside Recurly.

Parameters

During the initial synchronization with MailChimp, Recurly will automatically create any list fields it needs. If you delete a merge tag, Recurly will not recreate the tag. Below is a list of merge tags Recurly uses to submit subscriber data to MailChimp:

EMAIL

Account email address.

ACCOUNT_ID

Recurly account_code.

FNAME

Account first name.

LNAME

Account last name.

COMPANY

Account company name.

PLAN_CODE

Subscription plan code, if the account is a subscriber.

PLAN_NAME

Subscription plan name, if the account is a subscriber.

IN_TRIAL

Yes if the subscriber is in the trial period of a subscription, otherwise No.

SUBSCRIBER

Yes if the subscriber has a subscription (free or paid), otherwise No.

SUB_SINCE

Date the subscription started.

Disabling MailChimp

At any time, you may disable the Recurly MailChimp synchronization from the MailChimp Integration page in your Recurly account. Just click the button labeled Disable MailChimp Integration and confirm the action. The Recurly MailChimp integration will also disable automatically if you remove the mailing list Recurly synchronizes with or if your API credentials no longer work.

MailChimp Integration

Recurly makes it simple to connect with MailChimp so that your subscriber lists are automatically kept up to date and fresh. Once your MailChimp account is connected with Recurly, you can easily segment your campaigns in MailChimp and target your communications based on a variety of attributes passed from Recurly to MailChimp.