Reseller License Manager

Latest ReleaseCurrent VersionIncluded in WHMCS
July 19, 20214.0.7No

The Reseller License Manager is an addon for members of the WHMCS Reseller Program.

It allows you to:

  • View all license keys within your account.
  • Associate license keys with customers’ products and services.
  • Automate issuance and assignment of license keys for new customer signups.
  • Manage license keys, including reissuance, upgrades, reservations, and cancellations.
  • Provision new licenses.
  • View client limit status and automated email notifications and upgrades.

Activation

Before you can activate this addon, you must download and install it.

To do this:

  1. Download the addon.
  2. Unzip the ZIP file to a directory on your computer.
  3. Upload the files to the /modules/addons/whmcslicenses/ directory on your WHMCS installation.
  4. Go to Configuration () > System Settings > Addon Modules.
  5. Click Activate for WHMCS License Manager.
  6. Click Configure.
  7. Select the admin role groups that will have access to this addon.
  8. Click Save Changes.
  9. Go to Addons > WHMCS License Manager to verify that the installation succeeded.
    Entering data in the Reseller License Manager addon.
  10. Enter your registered email address and API key for the reseller. You can find your API key in the WHMCS Member area.

Using this Addon

Bundled Offering

A bundled offering allows you to include a free WHMCS license with certain purchases (for example, with a reseller hosting package).

Bundled offerings in the Reseller License Manager addon.

To configure bundled offerings:

  1. Go to Addons > WHMCS License Manager.
  2. Click Automation Setup.
  3. Under Bundled Offering, select the products that will include free licenses with their initial purchase.
    • You can choose between issuing a Starter or Plus license as a bundled license.
    • The system will not charge the customer for a bundled license.
    • Each product can only have a single license type.

A paid addon offering allows you to offer a WHMCS license as an optional extra product addon during the initial order process.

Paid addons in the Reseller License Manager addon.

To configure a paid addon offering:

  1. Go to Addons > WHMCS License Manager.
  2. Click Automation Setup.
  3. Under Paid Add-on Purchase, locate a product addon for the license type that you want to offer:
    1. If there is one, click on it and modify the Applicable Products list to include the products to offer it with.
    2. If there is not one, create one in one of the following locations:
      • Create an addon at Configuration () > System Settings > Product Addons, selecting WHMCS License Reselling as the module.
      • Click Create Missing License Products in the Automation Setup tab.

Settings

You can configure the following settings:

Client Upgrades

Check to send an email when your clients are approaching or have exceeded the client limit for their license product. The email contains a link to upgrade to the next license tier.

The link will not display on the service details page.
For more information about client limit upgrades, see Automated License Upgrades below.

Notify Clients Approaching Limit

This setting is only available if you disabled Client Upgrades.

Check to send clients an automated email notification when they reach the approaching client limit warning level.

Approaching Limit Email

This setting is only available if you disabled Client Upgrades and enabled Notify Clients Approaching Limit.

Select the email template to send when clients approach the client limit.

  • This defaults to WHMCS License Client Limit Imminent.
  • You can edit email templates at Configuration () > System Settings > Email Templates.

Notify Clients At Limit

This setting is only available if you disabled Client Upgrades.

Check to send clients an automated email notification when they reach the client limit.

At Limit Email

This setting is only available if you disabled Client Upgrades and enabled Notify Clients At Limit.

Select the email template to send when clients reach the client limit.

  • This defaults to WHMCS License Client Limit Reached.
  • You can edit email templates at Configuration () > System Settings > Email Templates.

Check for Unassigned License Keys

Check to find the first unassigned license key that is already active in your reseller account. This option can slow provisioning if a large number of licenses are active in your account.

Automated License Upgrades

Versions 4.0 and later of this addon include a self-serve automated license upgrade process for end users. When a license key reaches or exceeds the client limit, customers will receive an email containing a link to upgrade their license. They will see a page listing their current license, the new license type (based on the active clients), and the cost difference for the upgrade. The system calculates upgrade costs on a prorata basis by billing the new product price for the number of days between today and the next due date. Then, it applies a credit for the days remaining until the next due date at the current product price.

If the customer continues, the system generates an invoice that they can pay using any available payment gateway. After payment succeeds and the system applies it to the invoice, the system will upgrade the license key instantly. Invoices will remain in an Unpaid status for up to 24 hours. If it remains unpaid after that time, the system will automatically cancel the invoice. After this, the customer must follow the link again to see the revised upgrade price calculation and generate another invoice.

The pricing configuration in your product addons for WHMCS license types determines prices for the upgrade. To ensure that the system can perform upgrades for all license tiers, make certain that you have a product addon for each available WHMCS license tier.

You can find a list of product addons that exist for each WHMCS license tier in the Automation Setup tab. You can also automatically create product addons for any license tiers for which you do not currently have an addon product.

Upgrading

To upgrade the addon to a newer version:

  1. Download the newest version of the addon.
  2. Unzip the ZIP file to a directory on your computer.
  3. Upload the files to the /modules/addons/whmcslicenses/ directory in your WHMCS installation, overwriting all existing files.
  4. Log in to the Admin Area.
  5. Go to Configuration () > System Settings > Addon Modules.
  6. Locate Reseller License Manager in the list of addon modules.
  7. Click Activate.

Changelog

v4.0.0

  • Performance improvements should make pages within the addon faster to load
  • A new provisioning module is now included for the provisioning and management of WHMCS Licenses and should be assigned to all product addons used for WHMCS licenses.
  • All existing addons for WHMCS licenses have been automatically updated to use the new module.
  • The Automation Setup page has been updated to simplify the process of configuring products which should include a free WHMCS license.
  • For WHMCS licenses offered as a paid optional extra, these should now be configured via the native Product Addons UI, the same as with any other addon products.
  • This release includes a new self-serve automated license upgrade process for your customers. This functionality replaces the current Client Notification settings.
  • When a license key reaches or exceeds the client limit, customers will receive an email containing a link to upgrade their license.
  • Upgrade costs are calculated on a prorata basis, based on the prices defined in your Product Addons for WHMCS licenses.
  • To ensure upgrades can be performed for all license tiers, it is important to ensure you have a Product Addon for each tier of license available for WHMCS.
  • The Automation Setup page provides a list of Product Addons that exist for each tier of WHMCS license.
  • A button to auto-create Product Addons for any license tiers for which you do not currently have an addon product set up is also available here.
  • Existing WHMCS license addons without pricing configured have been automatically set to the Recommended Retail Price. This is to enable automated upgrades. You can modify prices via the Product Addons page.
  • The self-service upgrade functionality can be disabled within the Settings tab if desired.
  • A ‘Migration License Product’ Product Addon is created and assigned automatically for any WHMCS licenses that were previously assigned using the ‘custom addon’ functionality. If no custom addons existed, this migration product will not have been created.

v4.0.1

  • RLM-62 - Add backwards compatibility for WHMCS v8.1 and earlier

v4.0.2

  • RLM-63 - Correct Trait automatic loading

v4.0.3

  • RLM-64 - Ensure correct addons are associated with the WHMCS License Reselling Module

v4.0.4

  • RLM-66 - Show license key custom field when viewing the addon details in the Client Area

v4.0.5

  • RLM-67 - Correct exception when manually assigning licenses
  • RLM-68 - Resolve connection issue for WHMCS v7.10
  • RLM-69 - Correct cancellation of addon service when cancelling license

v4.0.6

  • RLM-70 - Resolve uncaught exception on manual license assignment

v4.0.7

  • RLM-72 - On license upgrade, ensure Client Limit and License Type display correctly
  • RLM-73 - Allow provisioning of new Business license products
  • RLM-74 - Correct query for license assignment on existing Service Addon

v4.0.8

  • RLM-77 - Improve load performance of license list page
  • RLM-79 - PHP 8.1 Support

Last modified: May 28, 2024