Recurly
Automatically apply Recurly coupons, credits, or trial extensions as rewards.
Last updated
Automatically apply Recurly coupons, credits, or trial extensions as rewards.
Last updated
Note: The Recurly integration is only available to users on the LoyaltySurf Business plan or higher.
You must first select a default currency for your LoyaltySurf campaign in order to use Recurly. Your default currency determines whether Recurly coupons, credits, or trial extensions can be applied to your Recurly subscriptions. For example, if your default currency is USD, then the coupon, credit, or trial extension you set up can only be redeemed for Recurly subscriptions using USD.
Step 1: In Campaign Editor > 3. Options > Integrations, open the Recurly integration card, and enter your Recurly API key and test API key.
For the "Enter your Recurly API Key" field, please enter an API key from your production Recurly instance
For the "Enter your Recurly Test API Key" field, you can use the same API key as above, otherwise if you have a separate Recurly instance you use just for development/testing purposes, please enter that one.
Step 2: Once connected, press the 'Connect A Reward' button and select your reward.
Step 3: Click on either coupon, credit, or trial extension. If 'Coupon' is selected, enter the details of the coupon, including the name, type, and discount. You can also click Show advanced coupon settings to view more customization settings.
Advanced feature tip: Issue different reward amounts by using dynamic rewards
Dynamic rewards let you offer different reward values based on specific attributes of the participant (such as the pricing plan they signed up for).
For example, you can issue $50 in credits for normal users and $100 in credits for VIP users.
Note: By default, coupons are recommended. However, if you want rewards to be stackable (e.g., $10 off for every loyalty action), you will want to use credits.
If 'Credit' is selected, enter the credit description and amount to apply to the Recurly customer's account every time this reward is unlocked.
If 'Trial extension' is selected, specify the number of days to extend the trial period.
Please note that due to the way that Recurly subscriptions work, the way that LoyaltySurf extends trial periods for existing subscriptions is by creating a new Recurly subscription and applying a free trial coupon to it.
Then select the Recurly plan to which the free trial coupon should be applied.
The Recurly free trial coupon generated by LoyaltySurf must be redeemed when the Recurly customer has a new subscription created. It cannot be utilized for existing subscriptions. If a Recurly plan is not chosen for the application of the free trial coupon, the customer will still receive the coupon. However, it can only be redeemed at a later time. For more information about free trial coupons, click here.
Step 4: Then hit Save. Now, anytime this reward is unlocked by a winning participant, a Recurly coupon, credit, or trial extension will also be applied to the Recurly subscription associated with the LoyaltySurf participant email address.
Step 5 (optional): To ensure the legitimacy of your campaign and prevent any fraudulent activities, it is advisable to establish Recurly webhooks. By setting up webhooks, LoyaltySurf can monitor any modifications customers make to their email addresses on Recurly using the customer's unique Recurly ID.
Step 6: Toggle the Recurly webhooks switch to enabled within LoyaltySurf, then go to your Recurly dashboard and create a new Recurly webhook by navigating to Integrations > Webhooks. Click on the configure button and select the New Endpoint option to create a new endpoint. Use the webhook URL displayed in the LoyaltySurf Recurly integration as the endpoint URL. Next, generate a username and password for your endpoint, scroll down to the Notification section, and select account.updated. Finally, click the Save Changes button at the bottom of the page. To complete the integration, return to the LoyaltySurf Recurly integration and input the username and password for your Recurly webhook.
Important Note: Only the following notification should be selected for your Recurly webhook:
account.updated
Our Recurly integration comes with a test mode that allows you to test coupons/credits and trial extensions based on the test API key that you initially provided. This helps you keep development/testing separate from production. When you toggle Test Mode on, LoyaltySurf will apply coupons/credits and trial extensions using your test API key.
To enable test mode, toggle the Test Mode switch at the bottom-right, then connect a reward.
Please note that the rewards you connect to while Test Mode is enabled are completely separate from those you connect to in live mode.
Important note: When you go live with your campaign, please make sure to switch back to live mode. Otherwise, rewards will not be issued in live mode while test mode is enabled.
If there is an issue with applying Recurly coupons, credits, or trial extensions, LoyaltySurf will send out a notification email to the campaign owner. The issue will also be stated in the participant's detail page when you view their reward or when you view the participant's activity logs.
Here are some common reasons why there may be failures:
The customer with the associated LoyaltySurf participant email address does not exist in Recurly (please make sure to check live or test mode depending on if you have toggled on Test Mode in the LoyaltySurf Recurly integration)
If dynamic reward rules are enabled for the Recurly reward, there may have been no matching rule found.
If you were expecting a reward to be applied in live mode, double-check that you do not have test mode enabled.
If there was a failure, you will need to manually issue the Recurly reward from your Recurly dashboard.
If you have manual reward approval enabled for your campaign: Recurly coupons, credits, and trial extensions will only be issued to the winner(s) after you approve the reward.
If the loyalty action was triggered recently (or if the reward was approved recently), please allow for a few minutes of server processing before viewing the participant's reward from your LoyaltySurf admin dashboard. During this time, the data displayed for the participant's reward may not be accurate.
