Note: This article relates to the Recurring Referrals pro add-on.

General configuration
Once the Recurring Referrals add-on is installed, you will have a new Recurring Referrals tab added to the Arabianaffiliates settings screen:

To enable recurring referral tracking for the supported platforms, simply check the box and click Save Changes. Once enabled, referrals will be automatically recorded anytime a renewal payment is made for a subscription that was referred by an active affiliate.

You can also, optionally, set the recurring rate. This is the rate that will be used to calculate the amount an affiliate earns on subscription payments.

For example, if you wish to award affiliates 25% on the initial signup and then 10% on every payment thereafter, you would set it up as such:

In Affiliates → Settings → General, set the default rate to 25
In Affiliates → Settings → Recurring Referrals, set the Recurring Rate to 10

Disable recurring referrals for affiliates

If you wish to disable recurring referrals for specific affiliate accounts, you can do so from the affiliate’s edit screen:

Manually creating a recurring referral

 

If you’d like to manually create a referral that gets credited with an order that has recurring transactions, generally, you can specify the subscription ID / order number from the commerce plugin, in the Reference field:

When a subscription payment is recorded, it looks up the original order using the information you provided in this field, then tries to find a referral with that reference.

However, this is a bit different for each integration supported by Recurring Referrals, so we’ve noted those differences below for each.

In general, if a parent subscription/order is found, Arabianaffiliates will create the new referral and attribute all future recurring transactions to the affiliate, and associate those recurring referrals with the relevant parent subscription/order.

Arabianaffiliates will not apply recurring transaction referrals for any past recurring transaction which occurred on the order.

Select your desired integration below for instructions on how to create a recurring referral for that integration:

Easy Digital Downloads
To manually create a recurring referral in Easy Digital Downloads and the EDD Recurring add-on, specify the EDD payment ID of the original EDD subscription payment, in the reference field of an Easy Digital Downloads referral and set the context field to edd.

Gravity Forms
To manually create a recurring referral in Gravity Forms, specify the entry ID of the original transaction of the subscription in the custom field of a Gravity Forms referral and set the context field to gravityforms

iThemes Exchange
To manually create a recurring referral in iThemes Exchange, specify the order ID of the original iThemes Exchange subscription, in the reference field of an iThemes Exchange referral and set the context field to it-exchange.

MemberMouse
Although MemberMouse is supported by the Recurring Referrals add-on, it cannot have referrals be retroactively applied at this time.

MemberPress
When creating the referral for MemberPress, set the custom field to the MemberPress subscription ID and set the context field to memberpress.

Paid Memberships Pro
To manually create a recurring referral in Paid Memberships Pro, specify the Paid Memberships Pro order ID of the subscription in the reference field of a Paid Memberships Pro referral and set the context field to pmp.

Restrict Content Pro
To manually create a recurring referral in Restrict Content Pro, specify the Restrict Content Pro Subscription Key from the Member edit screen in the reference field of a Restrict Content Pro referral and set the context field to rcp.


Stripe (via WP Simple Pay)
To manually create a recurring referral in Stripe, specify the Stripe subscription ID of the of the desired Stripe subscription in the custom field of a WP Simple Pay referral and set the context field to stripe.

Woocommerce
To manually create a recurring referral in WooCommerce and the WooCommerce Subscriptions extension, specify the original WooCommerce parent order ID of the subscription (Not the Subscription id, the accompanying Order id) in the reference field of a WooCommerce referral and set the context field to woocommerce.

Note: Recurring Referrals requires WooCommerce Subscriptions version 2.0 or higher.

Zippy Courses
To manually create a recurring referral in Zippy Courses, specify the Zippy Courses order ID of the transaction in the reference field of a Zippy Courses referral and set the context field to zippycourses.

Note: This article relates to the Recurring Referrals pro add-on.

Setting recurring referral rates with the Recurring Referrals pro add-on
The Recurring Referrals pro add-on allows you to record affiliate commissions anytime a subscription payment is made on a membership that was referred by an affiliate. Instead of just awarding affiliates a commission on the initial signup, you can award them for every payment the members make over the lifetime of their subscription. Recurring Referrals supports certain subscription and membership platforms which are listed on the add-on’s page.

Once installed and activated, the Recurring Referrals add-on will add a new tab to the Affiliates → Settings screen called Recurring Referrals.

Setting the recurring referral rate

Follow these steps to set up recurring referral rates for your subscription product:

Affiliates → Settings→ Recurring Referrals tab, simply check the box and click Save Changes. Once enabled, referrals will be automatically recorded anytime a renewal payment is made for a subscription that was referred by an active affiliate. By default, the recurring referral rate will be your existing global referral rate.

You can choose to set a recurring rate if you’d like to pay your affiliates a higher or lower commission for ongoing subscription payments. Simply enter this number into the Recurring Rate field in the Recurring Referrals tab.

You may also enter a custom recurring referral rate per affiliate, by visiting the Edit screen for the desired affiliate:

Setting the recurring rate type

By default, the recurring referral rate type will be the same as your global referral rate type as defined in Affiliates  Settings General (Flat Rate or Percentage). However, as of Recurring Referrals version 1.6 or later, the recurring rate type may also be specified globally in the Affiliates → Recurring Referrals → Recurring Rate Type.

You may also enter a custom recurring referral rate type per affiliate, by visiting the Edit screen for the desired affiliate:

 

To track recurring referrals with Arabianaffiliates and Stripe Checkout, you will need:

A Stripe.com account
WP Simple Pay Lite 1.5.9 or later or AF Simple Pay Pro
Arabianaffiliates 2.0 or later
Recurring Referrals 1.6 or later

Basic set up
1. Before proceeding, ensure that the Zippy Courses integration is enabled in Arabianaffiliates by checking Zippy Courses in Affiliates → Settings → Integrations:

2. The Recurring Referrals add-on requires the ability to track recurring payments from Stripe, via the AF Simple Pay plugin integration.

In order to do this, a webhook must be entered in your Stripe dashboard. You’ll need to set a webhook url both for test and live Stripe connections. You can find this webhook url in the Affiliates Settings Recurring Referrals tab:

After copying the url, you’ll need to enter it into Stripe within the pop-up window:

After copying the url, you’ll need to enter it into Stripe within the pop-up window:

Note that a webhook must be entered both for test Stripe transactions, and your live Stripe transactions.

3. After setting up a recurring subscription form in AF Simple Pay, recurring referrals will be generated. AF Simple Pay does not store transaction data within your WordPress site, so the referral reference in this case links directly to the relevant data within your Stripe dashboard: