Class: Affiliates

Affiliates(config)

Allows you to manage your Project Management module in WHMCS.

Constructor

new Affiliates(config)

Parameters:
Name Type Description
config Object Object containing your API credentials.
Properties
Name Type Attributes Description
serverUrl string URL to your installation. Remember to point to /includes/api.php
username string <optional>
password string <optional>
identifier string <optional>
secret string <optional>
Source:

Extends

  • WHMCS

Methods

affiliateActivate(opts)

Activate affiliate referrals for a client. - https://developers.whmcs.com/api-reference/affiliateactivate/
Parameters:
Name Type Description
opts Object
Properties
Name Type Description
userid Number The client ID to activate affiliate status for
Source:

getAffiliates(opts)

Obtain an array of affiliates - https://developers.whmcs.com/api-reference/getaffiliates/
Parameters:
Name Type Description
opts Object
Properties
Name Type Attributes Description
limitstart Number <optional>
 The offset for the returned affiliate data (default: 0)
limitnum Number <optional>
 The number of records to return (default: 25)
userid Number <optional>
 Obtain affiliate data for a specific client account
visitors Number <optional>
 Provide affiliates that match a specific visitor count
paytype String <optional>
 Provide affiliates matching the paytype provided. One of “, ‘percentage’, ‘fixedamount’
payamount Number <optional>
 Provide affiliates matching a specific overridden payout amount
onetime Number <optional>
 Provide affiliates configured to receive one time affiliates
balance Number <optional>
 Provide affiliates that have this balance
withdrawn Number <optional>
 Provide affiliates that have withdrawn this amount
Source: