Pro plugin Version 1.2.1 Updated

Affireo - Affiliates for WooCommerce documentation

Affireo - Affiliates for WooCommerce runs an affiliate program inside your WooCommerce store. Affiliates sign up and share a personal referral link, and you review their referrals and pay commissions from the Affiliates menu in WordPress.

Try the live demo Get Affireo

Overview

Affireo - Affiliates for WooCommerce turns your WooCommerce store into an affiliate program. People apply through a signup form on your site. Once you approve them, they share a personal referral link, and the plugin records their visits and credits the orders they bring in.

You manage everything from the Affiliates menu in WordPress admin. You can review applications, check referrals and visits, run payouts, view reports and export data. Settings cover commission rates, tracking, affiliate approval, payout methods, the affiliate portal and more.

This is the complete Pro edition and works on its own. You do not need the free version installed. If you are upgrading from the free version, your affiliates, commissions, payouts and settings carry over with nothing to import.

Requirements

  • WordPress 6.2 or later
  • PHP 7.4 or later
  • WooCommerce 8.0 or later (required plugin)

Installation

Affireo needs WooCommerce, so install and activate WooCommerce first. You do not need the free edition of Affireo. Download the plugin zip from your ProPluginsLab account under My Account > Downloads.

  1. Make sure WooCommerce is installed and active.

  2. In WordPress admin, go to Plugins > Add New > Upload Plugin.

  3. Choose the zip file you downloaded from My Account > Downloads and click Install Now.

  4. Click Activate Plugin. If the free version of Affireo is active, Pro deactivates it for you automatically.

  5. Go to Affiliates > Settings to set up your program.

License and automatic updates

Affireo works fully as soon as it is activated. The license key turns on automatic updates, so new versions arrive in WordPress like any other plugin update. Pro features never depend on it.

Activate your license

  1. Find your license key in My Account on propluginslab.io, in the license keys section. It is also in your order confirmation email.

  2. In WordPress, open Affiliates > License. When two or more ProPluginsLab plugins or add-ons are active on the site, WooCommerce > Licenses also appears and lists all of them in one place.

  3. Paste the key into the Affireo - Affiliates for WooCommerce Pro row and click Activate. The status changes to Active and automatic updates are on.

The license screen with a license key field, an Activate button and the license status
Affiliates > License: paste the key and click Activate.

Receive updates automatically

Once the license is active, new versions of Affireo show up under Dashboard > Updates and on the Plugins screen. Click Update now, or click Enable auto-updates in the Affireo row on the Plugins screen and WordPress installs every future release for you.

Good to know

  • Keys are checked once a day in the background, so your site never waits for the license server. If the server is briefly unreachable, the plugin keeps its last known status.
  • An expired key or a key that is not accepted only stops updates. Affireo keeps working. After renewing, click Check now in its row.
  • Moving to a new domain: click Deactivate on the old site first, then activate the key on the new one. The status shows Site address changed, checking until the new address is confirmed.
  • On the command line: wp ppl-license list, wp ppl-license activate <plugin> <key>, wp ppl-license check and wp ppl-license deactivate <plugin>.

Quick start

  1. Set your default commission

    Go to Affiliates > Settings and open the Commissions tab. Enter the Default commission and choose Percent of the order or Fixed amount per order. Click Save settings.

  2. Create the affiliate page

    Create a page (for example "Affiliate program") and add the [ppl_afw_portal] shortcode to it. Publish the page and note its page ID.

  3. Connect the page to the portal

    In Affiliates > Settings > Portal, enter that page's ID in Dashboard page ID. Optionally set an Accent color and Corner radius to match your theme, then save.

  4. Choose how affiliates get paid

    On the Payouts tab, set the Minimum payout and tick the payout methods affiliates can pick: PayPal, Bank transfer, Stripe Connect, Store credit coupon or Manual / offline.

  5. Decide how new applications are approved

    On the Affiliates tab, tick Auto approve to activate new applications instantly, or leave it off and review them yourself under Affiliates > All Affiliates. Add your Program terms so applicants see them on the signup form.

  6. Watch referrals come in

    Once affiliates share their links, open Affiliates > Visits to see clicks and Affiliates > Referrals to see credited orders. The Overview screen sums up the last 30 days.

#Overview

Affiliates > Overview gives you a snapshot of your program for the last 30 days. Use it as your starting point each time you check on the program.

At the top you see summary cards:

  • Attributed revenue: order revenue credited to affiliates.
  • Commissions: commission earned by affiliates.
  • Visits: clicks on referral links.
  • Conversions: converted visits and the conversion rate.
  • Active affiliates: how many affiliates are currently active.

Below the cards, the Commissions per day chart shows daily commission totals. When applications are waiting, a notice tells you how many and offers a Review now button that takes you to them. The Top affiliates (30 days) table lists your best performing affiliates with their Conversions and Earnings.

Affiliate Program Overview screen with summary cards, a Commissions per day chart, a pending applications notice and a Top affiliates table
The notice with the Review now button appears when affiliate applications are waiting for your review.

#All Affiliates

Affiliates > All Affiliates lists everyone who has applied to or joined your program.

Use the status links at the top to filter the list: All, Pending, Active, Suspended and Rejected. The count next to each link shows how many affiliates have that status. Use the search box and Search affiliates to find a specific person.

The table shows:

  • Affiliate: name and email address.
  • Slug: the affiliate's referral slug, used in their referral link.
  • Status: for example Pending or Active.
  • Unpaid: commission earned but not paid out yet.
  • Lifetime: total commission earned.
  • Joined: the date the affiliate signed up.

To act on several affiliates at once, tick them, pick an option from Bulk actions and click Apply. New applications show as Pending until you approve them, unless Auto approve is turned on in the settings.

All Affiliates list with status filters, a search box and columns for affiliate, slug, status, unpaid, lifetime and joined date
Use the Pending filter to find applications that still need a decision.

#Referrals

Affiliates > Referrals lists every commission recorded for an affiliate.

Each row shows the referral ID, the Affiliate, the WooCommerce Order, the referral Type, the Commission, the Order base the commission was calculated on, the Status and the Date.

Use the All statuses and All types dropdowns and click Filter to narrow the list. Tick referrals and use Bulk actions with Apply to update several at once.

Add a manual referral

To credit an affiliate by hand, use the Add manual referral form below the table:

  1. Enter the Affiliate ID.
  2. Optionally enter an Order ID.
  3. Enter the commission Amount.
  4. Add a Note if you want to record why.
  5. Click Add referral.
Referrals list with status and type filters, commission and order base columns, and the Add manual referral form
The Order base column shows the amount each commission was calculated on.

#Visits

Affiliates > Visits logs each visit that arrives through an affiliate's referral link.

The table shows the visit ID, the Affiliate, the Landing page the visitor arrived on, the Referrer site, the Device type, the IP, whether the visit Converted into an order, and the Date.

Use the dropdown next to Filter to narrow the list. Use the page arrows at the top and bottom to move through older visits.

Visits log listing affiliate, landing page, referrer, device, IP, converted and date for each visit
The Referrer and Landing page columns show where each click came from and where it landed.

#Payouts

Affiliates > Payouts is where you pay affiliates and keep a record of payments.

  • Run payouts now creates payouts for every affiliate whose approved balance is eligible. The button shows how many affiliates are eligible right now.
  • Export completed (CSV) downloads completed payouts.
  • Export processing for PayPal (CSV) downloads payouts that are in progress in a format for PayPal.

The table lists each payout with its Invoice, Affiliate, Amount, Method, Status, Reference and Date. Use the All statuses dropdown and Filter to narrow it.

An affiliate becomes eligible once their approved balance reaches the Minimum payout set under Affiliates > Settings > Payouts. Commissions stay locked for the Grace period set on the Commissions tab, so refunded orders are never paid out.

Payouts screen with Run payouts now and CSV export buttons above a table of invoices, amounts, methods and statuses
The number on the Run payouts now button tells you how many affiliates are ready to be paid.

#Reports

Affiliates > Reports shows how your program performs over a date range you choose.

  1. Set the From and To dates.
  2. Click Apply to update the report.

The report shows cards for Attributed revenue, Commissions, Visits and Conversion rate, followed by Visits per day and Commissions per day charts and a Top affiliates table.

Export data
  • Export referrals in range (CSV) downloads referrals in the selected date range. Use Export status to limit the export to Pending, Approved, Paid, Rejected or Refunded referrals, or keep All statuses.
  • Export affiliates (CSV) downloads your affiliate list.
Affiliate Reports screen with date range fields, export buttons, summary cards, visits and commissions charts and a Top affiliates table
The Export status dropdown controls which referrals go into the date range CSV export.

#Tools

Affiliates > Tools groups a few maintenance and communication tasks.

Broadcast announcement

Send a message to every active affiliate. It appears in their portal notification feed and, if you tick Also send by email, in their inbox too.

  1. Enter a Subject.
  2. Write your Message (HTML allowed).
  3. Tick or untick Also send by email.
  4. Click Send announcement.
Data exports

Download Referrals (CSV), Affiliates (CSV) or Completed payouts (CSV) with one click.

Setup wizard

Click Re-run the setup wizard to go through the initial setup again.

Affiliate Tools screen with the Broadcast announcement form, Data exports buttons and a Re-run the setup wizard button
Announcements go to every active affiliate, so check the message before you send it.

#Settings

Affiliates > Settings holds your program settings, split into tabs. Click Save settings on each tab after you make changes.

  • Commissions: the default commission rate and type, what the commission is calculated on (discounted totals, tax, shipping), a minimum order amount, the grace period and self referral blocking. A rate set for an individual affiliate overrides the default.
  • Tracking: the Cookie duration, which is how long after a click a purchase still credits the affiliate, and whether the attribution window ends once a commission is recorded.
  • Affiliates: Auto approve for new applications and the Program terms shown above the terms checkbox on the registration form.
  • Payouts: the Minimum payout and the payout methods affiliates can pick in their dashboard. Affiliates enter their own PayPal email or bank details, which are stored encrypted.
  • Portal: the Dashboard page ID of the page that contains [ppl_afw_portal], plus the portal's Accent color and Corner radius.
  • Advanced: the Settings mode and Delete data on uninstall.

Settings mode is set to Simple (recommended) out of the box. Simple mode hides the multi-level and fraud tabs and less common options. Switch to Advanced (show all options) at any time to see everything.

See the settings reference below for every field on each tab.

Affiliate Settings screen on the Commissions tab, with tabs for Commissions, Tracking, Affiliates, Payouts, Portal and Advanced
Each tab has its own Save settings button.

#Referral links and tracking

Each affiliate has a slug, shown in the Slug column under Affiliates > All Affiliates. Their referral link uses that slug in one of these forms:

  • ?ref=yourslug added to any page URL on your store
  • a tidy link such as /go/yourslug/

The plugin also supports custom vanity slugs, first click or last click attribution, coupon based tracking (affiliates earn without anyone clicking a link), direct link tracking from an affiliate's verified website domain, and campaign and sub ID tracking.

Active affiliates get a toolbar shortcut on the front end that gives them the tracked referral link for whatever page they are viewing, with one click copying.

How long a click keeps crediting the affiliate depends on Cookie duration under Affiliates > Settings > Tracking.

Settings reference

Affiliates > Settings > Commissions

SettingTypeDefaultWhat it does
Default commission number 20 The commission rate or amount used when no more specific rate applies. Percentages are capped at 100%. A per affiliate rate overrides this default.
Default commission select Percent of the order How the default commission is applied: Percent of the order or Fixed amount per order.
Calculate commission on the discounted line totals checkbox on Shown as Exclude discounts. Calculates the commission on line totals after discounts.
Add line tax to the commission base checkbox off Shown as Include tax. Adds line tax to the amount the commission is calculated on.
Add shipping to the commission base checkbox off Shown as Include shipping. Adds shipping to the amount the commission is calculated on.
Minimum order amount number 0 Orders below this total earn no commission. 0 disables the check.
Grace period number 14 In days. Commissions stay locked this long so refunded orders are never paid out.
Affiliates cannot earn on their own purchases checkbox on Shown as Block self referrals. Stops affiliates from earning commission on orders they place themselves.

Affiliates > Settings > Tracking

SettingTypeDefaultWhat it does
Cookie duration number 30 In days. How long after a click a purchase still credits the affiliate.
End the attribution window once a commission is recorded checkbox on Shown as Clear cookie on purchase. Once an order earns a commission, later purchases are no longer credited from the same click.

Affiliates > Settings > Affiliates

SettingTypeDefaultWhat it does
Activate new applications instantly checkbox - Shown as Auto approve. When ticked, new applicants become active affiliates right away. When unticked, they wait as Pending until you review them.
Program terms textarea - Shown above the terms checkbox on the registration form.

Affiliates > Settings > Payouts

SettingTypeDefaultWhat it does
Minimum payout number 50 In your store currency. Affiliates are paid once their approved balance reaches this amount.
PayPal checkbox on Lets affiliates choose PayPal as their payout method in their dashboard. Affiliates enter their own PayPal email, stored encrypted.
Bank transfer checkbox on Lets affiliates choose bank transfer in their dashboard. Affiliates enter their own bank details, stored encrypted.
Stripe Connect checkbox off Lets affiliates choose Stripe Connect in their dashboard. This method talks to the Stripe API directly and needs a restricted secret key with transfer permission.
Store credit coupon checkbox on Lets affiliates choose to be paid in store credit.
Manual / offline checkbox on Lets affiliates choose a manual or offline payout.

Affiliates > Settings > Portal

SettingTypeDefaultWhat it does
Dashboard page ID number - ID of the page containing the [ppl_afw_portal] shortcode. It shows the signup form and, once approved, the full dashboard.
Accent color text #4f46e5 Hex color used in the affiliate portal, for example #4f46e5.
Corner radius text 10px CSS size for rounded corners in the portal, for example 10px.

Affiliates > Settings > Advanced

SettingTypeDefaultWhat it does
Settings mode select Simple (recommended) Simple (recommended) hides the multi-level and fraud tabs and less common options. Advanced (show all options) shows everything. You can switch at any time.
Permanently remove all affiliate tables, options, and user meta when the plugin is deleted checkbox off Shown as Delete data on uninstall. Leave it unticked to keep your affiliate data when the plugin is deleted.

Shortcodes

[ppl_afw_portal]

Shows the affiliate portal. Visitors who are not affiliates yet see the signup form. Once approved, affiliates see their full dashboard. Put it on one page and enter that page's ID in Dashboard page ID under Affiliates > Settings > Portal.

[ppl_afw_portal]

[ppl_afw_registration]

Affiliate registration shortcode included with the plugin. Add it to a page where you want applicants to sign up.

[ppl_afw_registration]

On your site

Visitors see the affiliate program on the page that contains the [ppl_afw_portal] shortcode.

People who are not affiliates yet see a Join our affiliate program form. In the example below, the form asks for:

  • Full name (required)
  • Website or blog
  • Main social profile
  • Audience size
  • How will you promote us? (required)
  • a checkbox to accept the affiliate program terms

Applicants click Apply now to submit. The text you enter in Program terms under Affiliates > Settings > Affiliates appears above the terms checkbox.

Once an affiliate is approved, the same page shows their full dashboard. The dashboard supports light and dark mode, adapts to screens down to 320px wide, can be used with the keyboard and works without JavaScript. Its accent color and corner radius come from the Portal settings tab.

Active affiliates also get a toolbar shortcut on the front end that copies the tracked referral link for the page they are viewing.

Affiliate program page with the Join our affiliate program form, fields for name, website, social profile, audience size and promotion plans, a terms checkbox and an Apply now button
Fields marked with a red asterisk are required before the application can be sent.

Frequently asked questions

Do I need the free plugin installed as well?

No. Pro is a complete standalone plugin. Only one of the two editions may be active at a time, and Pro deactivates the free one for you.

Will I lose data when I upgrade from the free version?

No. Both editions read and write the same database tables and options, so your affiliates, commissions, payouts and settings carry over with no import step. You can delete the free plugin afterwards without touching your data.

Can I go back to the free version?

Yes. Deactivate Pro and activate the free plugin. Your data stays intact. The premium features simply stop applying.

Does it work with High Performance Order Storage and the Blocks checkout?

Yes. The plugin declares HPOS compatibility, uses the WooCommerce CRUD APIs throughout and is compatible with the Blocks checkout.

Does the Stripe payout method need the Stripe plugin?

No. It talks to the Stripe API directly. Add a restricted secret key with transfer permission under Affiliates > Settings > Payouts.

Can I get an email when an order is credited to an affiliate?

Yes. The optional New referral (admin) email tells the store admin when an order is credited to an affiliate. It is off by default. Turn it on under WooCommerce > Settings > Emails.

Will uninstalling delete my data?

No. Your data is kept unless you first tick Delete data on uninstall under Affiliates > Settings > Advanced.

How long does a click keep crediting an affiliate?

For the number of days set in Cookie duration under Affiliates > Settings > Tracking. If Clear cookie on purchase is ticked, the attribution window ends once a commission is recorded.

Troubleshooting

The plugin will not activate or the Affiliates menu does not appear

Affireo requires WooCommerce. Install and activate WooCommerce 8.0 or later first, then activate Affireo. Also check that your site runs WordPress 6.2 or later and PHP 7.4 or later.

The signup form or affiliate dashboard does not show on the front end
  1. Make sure the page contains the [ppl_afw_portal] shortcode.
  2. Go to Affiliates > Settings > Portal and check that Dashboard page ID matches that page's ID.
  3. If you use a page caching plugin, exclude this page from the cache so each visitor sees their own form or dashboard.
New affiliates stay pending

When Auto approve is off under Affiliates > Settings > Affiliates, every new application waits for you. Open Affiliates > All Affiliates, click the Pending filter and approve them, or click Review now in the notice on the Overview screen. Tick Auto approve if you want applications activated instantly.

Run payouts now shows 0 eligible

An affiliate is only paid once their approved balance reaches the Minimum payout under Affiliates > Settings > Payouts. Commissions also stay locked for the Grace period set on the Commissions tab. Check the referral statuses under Affiliates > Referrals, and lower the minimum payout if it is higher than you want.

An order did not earn a commission

Check the Commissions settings. Orders below the Minimum order amount earn nothing, and with Block self referrals ticked affiliates cannot earn on their own purchases. Also check Cookie duration on the Tracking tab: purchases made after that window no longer credit the affiliate. If the order should count, add it under Add manual referral on the Referrals screen.

I cannot find the multi-level or fraud settings

Settings mode is set to Simple (recommended), which hides the multi-level and fraud tabs and less common options. Go to Affiliates > Settings > Advanced, choose Advanced (show all options) and click Save settings.