Primary

[affiliates_referrals]

Your affiliates will want to know how many referrals they have made. Use this shortcode to show the total number of referrals recorded by an affiliate, how much has the affiliate earned so far and how much will the affiliate earn.

The [affiliates_referrals] shortcode will show the total number of referrals that have been accepted or closed for the affiliate.

To show the number of referrals for an affiliate by status, embed it like examples below:

Accepted referrals: [affiliates_referrals status="accepted"]

Closed referrals: [affiliates_referrals status="closed"]

Pending referrals: [affiliates_referrals status="pending"]

Rejected referrals: [affiliates_referrals status="rejected"]

If you add the show="total" attribute to that shortcode, it will make a list of earnings by currency.

Examples:

  • Total amount for paid and unpaid referrals: [affiliates_referrals show="total"]
  • Total for unpaid referrals: [affiliates_referrals show="total" status="accepted"]
  • Total for paid referrals: [affiliates_referrals show="total" status="closed"]
  • Total for referrals pending approval: [affiliates_referrals show="total" status="pending"]
  • Total for rejected referrals: [affiliates_referrals show="total" status="rejected"]

Optional attributes:

  • from – Show the number of referrals from the given date. Format: YYYY-MM-DD. Can be combined with until attribute.
    Example [affiliates_referrals from="2012-01-01"]
  • until – Show the number of referrals until the given date.
  • for – shows the number of referrals for the current day, week or month. Possible values: "day", "week", "month". Cannot be combined with from or until attributes.
    Example: [affiliates_referrals for="month"]
  • status – see above
  • currency – three-letter currency code
  • if_empty – when used with show="total", allows to render plain text when there are no results