Reseller License Manager

From WHMCS Documentation

Revision as of 16:22, 2 July 2021 by Andrew (talk | contribs) (v4.0.4)

- Addon Name: Reseller License Manager
- Latest Version: 4.0.4
- Release Date: 2nd July 2021
- Compatible With: WHMCS 7.3 and later. Latest WHMCS 8.x is recommended.

The WHMCS Reseller License Manager is an add-on designed for members of the WHMCS Reseller Program.

The add-on integrates with WHMCS to provide a drop-in solution for managing, issuing and assigning licenses to customers.

Functionality includes:

  • Ability to view all license keys within your account
  • Ability to associate license keys with customers products & services
  • Automated license key issueing and assignment to new customer signups
  • License key management including reissues, upgrades, reserving and cancellation
  • Ability to provision new licenses
  • Client limit status visibility and automated email notifications/upgrades

Download

To download the add-on, visit the Reseller Portal located within our Members Area at the url below.

https://www.whmcs.com/members/reseller

Installation

To install the add-on, follow the steps below.

  1. Download the latest add-on files from https://www.whmcs.com/members/reseller
  2. Unzip the zip file download to a directory on your computer
  3. Upload the files to the ~/modules/addons/whmcslicenses/ directory within your WHMCS installation
  4. Login to the admin area and navigate to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
  5. Locate WHMCS License Manager in the list of Addon Modules and hit the Activate button
  6. Ensure your administrator role group is granted permission to access the add-on and hit Save.

Now visit Addons > WHMCS License Manager to verify the installation was successful.

Enter your registered Email Address and API Key for the Reseller API on the splash screen shown. WHMCS Licenses Splash Screen

If you do not have a Reseller API Key yet, visit https://www.whmcs.com/members/reseller to generate one

Upgrading

To upgrade the add-on to a newer version, follow the steps below.

  1. Download the latest add-on files from https://www.whmcs.com/members/reseller
  2. Unzip the zip file download to a directory on your computer
  3. Upload the files to the ~/modules/addons/whmcslicenses/ directory within your WHMCS installation, overwriting all existing files

Login to your WHMCS admin area and visit Addons > WHMCS License Manager to complete the update process and access the addon.

Usage

Getting Started

Bundled Offering

A bundled offering allows you to include a WHMCS license free of charge when certain products are purchased. For example with a Reseller Hosting Package.

To configure bundled offerings, follow the steps below:

  1. Navigate to Addons > WHMCS License Manager
  2. Click Automation Setup
    WHMCS Licenses Bundled Offering
  3. Under the Bundled Offering section, select the products you wish to be issued with free licenses upon their initial purchase. You can choose between issueing a Starter or Plus license as a bundled license. No fee will be billed to the customer for a bundled license.
    • Each product can only be assigned to a single license type.
    WHMCS Licenses Bundled Offering

A paid add-on offering allows you to offer a WHMCS license as an optional extra Product Addon during the initial order flow.

To configure a paid add-on offering, follow the steps below.

  1. Navigate to Addons > WHMCS License Manager
  2. Click Automation Setup
  3. Under the Paid Add-on Purchase section, you will see a list of Product Addons that are currently configured to provision a WHMCS license key upon purchase.
  4. If you see a Product Addon for the license type you wish to offer, simply click into it and modify the Applicable Products to include the product or products you wish for it to be offered with.
  5. If you do not see an existing Product Addon for the license type you wish to offer, you can create one by navigating to Configuration () > System Settings > Product Addons and creating a Product Addon, ensuring to select 'WHMCS License Reselling' as the module.
  6. Alternatively, the button labelled "Create Missing License Products" on the Automation Setup tab can be used to create Product Addons for all the available WHMCS license types.

Settings

WHMCS Licenses Settings

Client Upgrades

Enable this option to allow your clients to receive an email when they are approaching, or exceeded, the client limit for their license product. The client will be able to place an order for an upgrade to the next available license tier.

Notify Clients Approaching Limit

Only available when Client Upgrades are disabled.

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

Approaching Limit Email

Only available when Client Upgrades are disabled.

Select the email template to be sent when the above option is enabled. Default: WHMCS License Client Limit Imminent. The email template can be edited via Configuration () > System Settings > Email Templates or, prior to WHMCS 8.0, Setup > Email Templates.

Notify Clients At Limit

Only available when Client Upgrades are disabled.

Enable this option to send clients an automated email notification when they reach the client limit.

At Limit Email

Only available when Client Upgrades are disabled.

Select the email template to be sent when the above option is enabled. Default: WHMCS License Client Limit Reached. The email template can be edited via Configuration () > System Settings > Email Templates or, prior to WHMCS 8.0, Setup > Email Templates.

Check for Unassigned License Keys

Enable this option to find the first unassigned license key already active within your reseller account on module provision. When enabled, this option can slow down provisioning if a large number of licenses are active in your account.

Automated Upgrade Flow

Version 4.0 and later includes 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. Upon following this link, end users will be presented with a page itemising their current license, the new license type required based on the active clients, and the cost difference for the upgrade.

Whmcs-rlm-upgrade-preview.png

Upgrade costs are calculated on a prorata basis, calculated by billing the new product price for the number of days between today and the next due date, with a credit applied for the days remaining until the next due date at the current product price.

If the customer selects to continue, an invoice is generated and can be paid using any available payment gateway. Upon payment being completed successfully and the payment applied to the invoice, the license key will be upgraded instantly.

Whmcs-rlm-upgrade-invoice.png

Invoices will remain in an Unpaid status for up to 24 hours. If it remains unpaid after that time, the invoice will be automatically cancelled and the upgrade link should be followed again to see the revised upgrade price calculation and generate another invoice if desired.

Prices for the upgrade are taken from the pricing configured in your Product Addons for WHMCS license types. 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 setup is also available here.

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 setup 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