ARMember Affiliate Addon

Important Note: This Addon will only work if ARMember plugin is installed with version 2.0 or higher

This plugin lets you run your own affiliate program and allows you to create and reward (pay commission) your affiliates for referring other users to your website.

When a user pay for ARMember membership plan on your site, this addon will check to see if the user was referred to your site by an affiliate. It will then give commission to the affiliate who referred the user.


Steps For Installation And Activation

You can install plugin in following two ways.

New install via FTP

  1. Download the plugin and extract it. You will find a directory armemberaffiliate.
  2. In your WordPress installation directory, upload armemberaffiliate to wp-content/plugins/
  3. Activate the ARMember - Affiliate plugin through the Plugins menu from WordPress admin panel.

New install via the WordPress Uploader

  1. Download the plugin.
  2. Log in to your WordPress admin panel.
  3. Go to Plugins -> Add New -> Upload
  4. Click on “choose file” and browse the download package. When the plugin uploads successfully, click on Activate Plugin.

ARMember – Affiliate Setup Wizard

After activating the plugin, you will be able to see ARMember Affiliate admin menu in left side.

Let’s setup ARMember – Affiliate for your website :

  1. When plugin activated then Affiliate menu and pages will be display.

  2. For view list of all affiliate user with user details go to the Manage Affiliate menu from the admin interface.

  3. To view list of all referrals with their details go to the Manage Referrals menu from the admin interface.

  4. To check all payouts with their details go to the Manage Payouts menu from the admin interface.

  5. To view list of all banners with their details go to the Manage Banners menu from the admin interface.

  6. On the Affiliate Statistics page you can track site statistics like Total Earnings, Total Paid, Total Unpaid, Total Visitor, Total Referral, Total Affiliate user.

  7. Affiliate basic settings are available in Affiliate Settings. Please see below at Affiliate Settings section to get more detail.

  8. Also when plugin activated Affiliate section will be displayed in ARMember -> Manage Plans -> Add / Edit Plan.

    Here Affiliate Settings On Recurring Payment will be displayed when Subscription / Recurring payment plan type is selected.

    Important Note: Here referral on recurring payment is supported from ARMember 2.2.1.

    Please see below screen.

  9. You will be able to enable and disable referrals plan wise.

  10. You can set referral rate in ‘Fixed Rate’ or ‘Percentage’ wise.

    Also you need to set this settings for each plan.

    For easy way to configure referral for each plan you may change directly at Manage User Commission where all plans are available at ARMember Plans Affiliates section and change affiliate settings for each plans easily.

  11. ARMember Affiliate supports data migration from AffiliateWP and Affiliate Pro plugins which helps you to migrate affiliate accounts to the ARMember Affiliate plugin.

  12. Allow to give referral to affiliates on purchase membership plan with coupon code.

    An administrator can set an Affiliate user per coupon and when the membership plan is purchased from that coupon, the affiliate will receive the reward.

  13. Allow Affiliate user to Refer or Invite friends by email.


Manage Affiliate

To view list of all Affiliate with their details go to the Manage Affiliate menu from the admin interface. Also here you can track how many user visit your website using affiliate user referral link and Display how many visitor converted as user through the affiliate user referral link.

Here you are able to see all affiliate user listed with their details like Username, email, Affiliate Starts From, User status, Affiliate Id, Number Of visitors, Converted As Users and Revenue Amount. Also Affiliate username, email, Number Of visitors, Converted As Users and Revenue Amount column is sortable here.

Please see below screen.

Manage Affiliate

  • Bulk Actions

  • This option will be helpful when same action need to be performed on multiple user rows at same time.

    1. Delete

      Select number of rows that you want to delete and select Delete Bulk Action then click on Go button.

  • Actions

  • For each row of grid there are some action options provided which are as following

    1. Delete

      Each Referral can be deleted by just one click on DELETE Icon at right side.

    2. Active & Inactive

      You can ACTIVE or INACTIVE direct login using single switch.

  • Search

  • You have Search Box at top of the grid plus other filter options are also available which are FILTER BY STATUS.

    Create Affiliate User

    For create affiliate user click on Create Affiliate User.

    Please see below Screen.

    Add Affiliate

    You can select user that you want to create affiliate user.

    click on Save button.


    Manage Referrals

    To view list of all Referrals with their details go to the Manage Referrals menu from the admin interface.

    Here you are able to see all referral listed with their details like Affiliate User, Amount, Plan Name, Reference User, Date, Status and Link. Also Affiliate user, Amount and date column is sortable here.

    Please note that, if affiliate user is referred with any payment transaction then referral will be added on purchased plan amount. If plan has trial active and transact with trial amount then referral will be added on trial amount.

    Please see below screen.

    • Bulk Actions

    • This option will be helpful when same action need to be performed on multiple user rows at same time.

      1. Delete

        Select number of rows that you want to delete and select Delete Bulk Action then click on Go button.

    • Actions

    • For each row of grid there are some action options provided which are as following

      1. Accept

        Each Referral Can be accepted by just one click on ACCEPT Icon at right side. When you accept any referral then status should be unpaid.

      2. Reject

        If you see any bad Referral then you will be able to reject by just one click on REJECT Icon at right side

      3. Edit Referral Amount

        For edit referral amount click onEdit Referral Amount button. And set your new amount in popup amount text-box and click on save.

        Please see below screen.

      4. Delete

        Each Referral can be deleted by just one click on DELETE Icon at right side.

    • Search

    • You have Search Box at top of the grid plus other filter options are also available which are FILTER BY MEMBERSHIP PLAN, FILTER BY STATUS, FILTER BY DATE.

    • Export To CSV

    • This button provides the facility to export the records and display those records in the CSV file.


      Manage User Commission

      From this page you can set commission on individual affiliate accounts.


      ARMember User Commissions

      If you want to set different referral rate for particular affiliate account then here it is possible at ARMember User Commissions.

      Click on Add New User Commission button to add new affiliate account and different referral rate and type. You will get popup where you can select your affiliate account and configure referral settings.

      ARMember Affiliates Commission Setup

      You will be able to update/delete affiliate settings for affiliates by click on action buttons displayed by hovering on each row of affiliate accounts in grid.

      • Edit : Click here to update referral setting for particular affiliate account.
      • Delete : Click here to remove referral settings for particular affiliate account.

      Please note that, When you add affiliate settings for particular affiliate account then it will overwrite all other affiliate settings. User specific affiliate settings will have first priority always. Let’s get understand by example below.


      For example,

      If you have Subscription Plan with affiliate referral enabled and referral rate is 5% for subscription plan. And an affiliate account ARM_Affiliate is added with referral rate 15% at Manage User Commission.

      Now whenever any user register with your Subscription Plan and refer ARM_Affiliate then ARM_Affiliate will get 15% referral on plan amount instead of 5%.

      Please note that, when affiliate is referred on registration without payment then Default Referral Amount will be applied from Affiliate Settings.


      ARMember Plans Affiliates

      You may enable and configure referrals in particular plan at ARMember -> Manage Plans -> Add / Edit Plan. Same things are available here to configure referral settings on particular plan directly without edit plan in ARMember. Same affiliate settings are also available here as you can see in screenshot.

      ARMember Affiliate Plans Commission Setup

      Note: Affiliate Settings On Recurring Payment will be available for subscription plans only.


      Manage Payouts

      To view list of all payouts with their details go to the Manage Payouts menu from the admin interface.

      Here you are able to see all payouts listed with their details like Affiliate User, Total Earnings, Paid Amount, Due Amount. Also the all column is sortable here.

      Please see below screen.

      • Actions

      • For each row of grid there are some action options provided which are as following

        1. Export To CSV

          For Specific affiliate user payment history export by just one click on EXPORT TO CSV icon.

        2. Payment History

          You will be able to see each affiliate user payment history by click on PAYMENT HISTORY icon.

          Please see below screen.

        3. Pay to User

          For Pay to user click on PAY TO USER button. And set amount that you want to pay to user in popup text-box and click on Pay button.

      • Search

      • You have Search Box at top of the grid.

      • Export To CSV

      • You will click on it the button and able to download displayed record in CSV file.


      Affiliate Banners

      To view list of all Banners with their details go to the Manage Banners menu from the admin interface.

      Banners or text links allows your affiliates user to easily promote your web site. The text or banner links your affiliates will use to traffic to your web site.

      This allows your affiliates user to log into their affiliate area and get the code for the advertisement.

      Affiliate user can copy and paste the banner code to their site for send visitors to your web site

      • Bulk Actions

      • This option will be helpful when same action need to be performed on multiple user rows at same time.

        1. Delete

          Select number of rows that you want to delete and select Delete Bulk Action then click on Go button. When you click on Go button then only visitor will be deleted.

      • Actions

      • For each row of grid there are some action options provided which are as following

        1. Edit Banner

          For edit Banner click onEDIT BANNER button. And you can edit all banner details than click on save button.

        2. Delete

          Each Banner can be deleted by just one click on DELETE Icon at right side.

      • Add Banner

      • For create banner click on ADD BANNER Button.

        Please see below Screen.

        You can insert all details and click on SAVE button.


      Affiliate Statistics

      Here you can track site statistics like Total Earnings, Current Month Earnings, Total Payment(Paid), Current Month Payment(Paid), Total Payments(Unpaid), Current Month Payments(Unpaid), Total Visitor, Current Month Visitor, Total Referral, Current Month Referral, Total Affiliate User, Current Month Affiliate user.

      • Visits

      • Here you are able to see your web site through affiliate users visits listed with their details like Date Time, Browser, IP, Country, Visitor Converted as user, Affiliate user, Referred user(Display username if visitor converted as user), Commission and Membership Plan.

        Also Affiliate user, Referred user, Commission and membership plan column is sortable here.

      • Search

      • You have filters at top of the grid, filter options are also available which are FILTER BY AFFILIATE USER FILTER BY MEMBERSHIP PLAN FILTER BY DATE.

      • Export To CSV

      • You will click on it the button and able to download displayed record in CSV file.


      • Summery

      • Here you are able to see day wise your web site Total Visitor, Total Converted, Commission, Revenue Amount.

      • Search

      • You have filters at top of the grid, filter options are available which are FILTER BY MEMBERSHIP PLANFILTER BY DATE.


      Affiliate Settings

      Go to the Affiliate Settings menu from the admin interface.

      Let’s check each option in detail:

      Please see below screenshot.

      • Affiliate URL Parameter Name

      • You can change the URL variable for referral URLs. The default value is armaff.

      • Referral Cookie Expiration

      • This option is for How many days should the referral tracking cookie be valid for?

        If you enter 0, referrals will only be valid until the visitor closes the browser (session).

        The default value is 1. In this case, if a visitor comes to your site via an affiliate link, a suggested referral will be valid until 1 days after she or he clicked that affiliate link.

      • Default Referral Amount

      • If visitor visit the site using shared link and register using simple ARMember Registration page then this amount should be commission.

      • Referral URL

      • The default referral URL will be your website’s URL. You will be able to change this URL to any page you want your referrals to redirect when they sign-up.

      • Referral Status

      • You can able to set default referral status. So when new referral is create then the default status should be selected.

        By default referral status should be pending.

      • Allow Referrals on Renew / Change Plan

      • This option Allows you to give affiliate user commission when someone refer to affiliate and renew OR change plan then affiliate user get the commission.

      • Do Not Allow Zero Amount Commission

      • This option Allows you to block zero amount referrals. This Option is default allow zero amount referrals.

      • Automatic Create Affiliate link upon new Registration

      • If this option is enable then. New user create in your wordpress site then automatic new affiliate user will be create.

      • Affiliate Id Encoding

      • You can able to set encoding affiliate URL value using this option.

        If you change Affiliate Id Encoding and Affiliate URL Parameter Name setting and have distributed affiliate links or permalinks, make sure that these are updated. Unless the incoming affiliate links reflect the current encoding, no affiliate hits, visits or referrals will be recorded.

      • Enable Fancy Affiliate URL

      • Enable this option to provide fancy URL to your affiliates to share their affiliate referral URLs.

        Example: http://yoursite.com/armaff/affiliate_id

      • Form Settings

      • Form settings are available for form replaced with shortcode:

        [arm_affiliate_register]

        Following options are available to customize form.

        Form Input Style

        Here you have choice to set form input style from Material Style and Standard Style. Default Material Style will be applied.


        Form Title

        Here you are able to change form title to display at front form.


        Field Options

        You have field options where you are able change Label and Required status for each fields and submit button in form.


      • WooCommerce Integration

      • ARMember Affiliate supports WooCommerce Integration, you will have WooCommerce section visible at affiliate settings if you have installed and activate WooCommerce plugin.

        Enable Integration

        Enable integration to get WooCommerce support in ARMember Affiliates. If you have enabled integration, affiliates will get referrals created on each order of WooCommerce product if he/she is referred.

        At Manage Referrals, you have Order column referring to the Order Id in WooCommerce for which affiliate is referred.

      • Support for Easy Ditiald Download Plugin

      • ARMember Affiliate supports Easy Digital Download Plugin.

        Enable Referral for the EDD Download Items

        Enable Referral to get EDD support in ARMember Affiliates. If you have enabled referral, affiliates will get referrals created on each order of Easy Digital Download items if he/she is referred.

        At Manage Referrals, you have Order column referring to the Order Id in Easy Digital Download for which affiliate is referred.


      Migration tool

      Here you need to Select Plugin from where you would like to migrate affiliate accounts, and then click on Migrate button.

      On click migrate, before start to migrate affiliate accounts you have following points to note and options to check if you need to apply after complete migration.

      • While migrating Banners / Creative with duplicate ID will be skipped as it is not possible to migrate without duplicating an banner ID.
      • Deactivate {AFFILIATE} plugin After Complete Migration.

        This will deactivate plugin from where you are migrating affiliate accounts after complete migration to prevent conflicts with affiliate accounts when register new user. This is checked default.

      • Change affiliate parameter name

        Affiliate URL parameter(variable) may different in plugin from where you are going to migrate affiliate accounts, so to make all affiliates referral URL same you may need to change parameter name in ARMember Affiliate. This is default checked.

      • Replace shortcodes after complete migration

        Replace shortcodes of {AFFILIATE} plugin from where you are migrating affiliate accounts with ARMember affiliate supported shortcodes at all pages/posts.

      • Enable Fancy URL

        Check this option to enable fancy URL after complete migration as this may needed if you have enabled pretty URL in {AFFILIATE} plugin.

      • Enable Affiliate Id Encoding

        Check this option if you need to enable affiliate id after complete migration.

      Click on Continue to start migration of affiliate accounts.

      Important Note:
      If you already have exist affiliate accounts in ARMember Affiliate then migration can be possible if last affiliate Id exist in ARMember Affiliate is less then first affiliate Id in plugin from where you need to migrate.


      Dashboard Widgets

      Recent Referrals

      Here you have list of 6 recently added referrals with their Affiliate user, Amount and Referral User. You can view all referral by clicking on View All Referrals link.


      Email Notifications

      ARMember allows you to enable and configure email notification for different activities. To configure email for community activities please go to ARMember -> Email Notification.

      Click on Add New Response you will get popup open to configure email notification where you have options of all community activities in Message To Be Sent input as you can see in following image.

      ARMember Affiliate Email Notification

      Now, after configuring email notification content you need to enable particular notification from Community Settings. Following are community activities for which you can enable email notification.

      On user register as affiliate account

      This event will trigger when register new affiliate account. You can set individually event for each plan or multiple plan.


      On Affiliate user Refer/Invite friends

      This event will trigger when affiliate user Refer/Invite friends. You can set individually event for each plan or multiple plan.


      Notify admin when one user refer to other user

      This event will trigger when one user refer to other user. You can set individually event for each plan or multiple plan.


      Notify the affiliates when credited with a referral

      This event will trigger when affiliates credited with a referral. You can set individually event for each plan or multiple plan.


      Affiliate Shortcodes

      [arm_affiliate]

      Place this shortcode to display affiliate’s detail in your page like display referral URL for current logged in affiliate. Make sure to add {URL} in your content to display affiliate’s referral URL.

      Possible Arguments:
      social_fields Social network name(ex: facebook / twitter / linkedin / vkontakt / email)
      affiliate_text Affiliate text that you want to display in affiliate area for affiliate user. Use : {URL} (For display referral URL.)

      [arm_user_referral]

      Use this shortcode to allow your affiliate users to get their referrals detail in your site.

      Possible Arguments:
      title Section Heading.
      per_page Number of Records per Page
      message_no_record record Display Message if no records found.
      label Referrals – Grid Column Label
      value Referrals – Grid Column Label Value

      [arm_user_payout_transaction]

      This shortcode will be replaced with the grid containing payout transactions for current logged in affiliate user.

      Possible Arguments:
      title Section Heading.
      per_page Number of Records per Page
      message_no_record record Display Message if no records found.
      label Payouts Transaction – Grid Column Label
      value Payouts Transaction – Grid Column Label Value

      [arm_aff_banner]

      Place this shortcode in your page where you want to display your specific banner with embed code for affiliates.

      Possible Arguments:
      item_id Id of affiliate banner.

      [arm_affiliate_register]

      You may have users who does not have created affiliate or you may disabled Automatic Create Affiliate link upon new Registration then users can create affiliate from where you have placed this shortcode in your site while they are logged in.

      While user who has no affiliate account is logged in this shortcode will be replaced with form having some required fields and while user who has affiliate account is logged in this shortcode will be replaced with user’s affiliate detail.

      You are also able to change form title, form input style and field options from Affiliate Settings > Form Settings.

      [arm_aff_visits]

      This shortcode will be replaced with the total number of visits for current logged in affiliate.

      [arm_if_affiliate]…[/arm_if_affiliate]

      You may want to add specific content in your page which should be visible only for affiliates. This shortcode can be useful for that case.
      For Example,

      [arm_if_affiliate] 
      This content will be visible only for affiliates.
      [/arm_if_affiliate]

      [arm_if_non_affiliate]…[/arm_if_non_affiliate]

      Using this shortcode you are also able to add specific content in your page which should be visible only for non affiliates.
      For Example,

      [arm_if_non_affiliate] 
      This content will be visible only for non affiliates.
      [/arm_if_non_affiliate]

      [arm_referrals_friend_invite]

      Place this shortcode to display form for Refer or Invite friend by email and you can enter multiple email by comma separate in email field. This shortcode only accessible for affiliate users.

      Possible Arguments:
      form_id Display Form Design from signup form Default: 101
      title Section Heading Default: Refer a Friend
      email_label Label for email field Default: Email Address
      submit_button_text Form submit button text label Default: Send Email
      success_msg Form submited after success message Default: Mail sent successfully

      [arm_aff_statistics]

      Place this shortcode to display statistics. This shortcode only accessible for affiliate users.

      Possible Arguments:
      earning_back_color Display earnings background color
      paid_payment_back_color Display paid payment background color
      unpaid_payment_back_color Display unpaid payment background color
      visitor_back_color Display visitor background color
      referral_back_color Display referral background color
      earning_title Display earning title
      payment_paid_title Display paid payment title
      payment_unpaid_title Display unpaid payment title
      visitor_title Display visitor title
      referral_title Display referral title

      [arm_aff_earning]

      Place this shortcode to display earning. This shortcode only accessible for affiliate users.

      Possible Arguments:
      duration (Optional) Display last month earning (value:1)

      [arm_aff_payment_paid]

      Place this shortcode to display paid payment. This shortcode only accessible for affiliate users.

      Possible Arguments:
      duration (Optional) Display last month paid payment (value:1)

      [arm_aff_payment_unpaid]

      Place this shortcode to display unpaid payment. This shortcode only accessible for affiliate users.

      Possible Arguments:
      duration (Optional) Display last month unpaid payment (value:1)

      [arm_aff_referral]

      Place this shortcode to display referral. This shortcode only accessible for affiliate users.

      Possible Arguments:
      duration (Optional) Display last month referral (value:1)