Difference between revisions of "Reseller License Manager"
From WHMCS Documentation
| Line 4: | Line 4: | ||
''' - Compatible With:''' WHMCS 7.3 and later. Latest WHMCS 8.x is recommended. | ''' - Compatible With:''' WHMCS 7.3 and later. Latest WHMCS 8.x is recommended. | ||
| − | The WHMCS Reseller License Manager is an | + | The WHMCS Reseller License Manager is an addon for members of the WHMCS Reseller Program. |
| − | The | + | The addon integrates with WHMCS to provide the following features: |
| − | + | * 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. |
| − | * | ||
| − | * | ||
==Download== | ==Download== | ||
| − | To download the | + | To download the addon, [https://www.whmcs.com/members/reseller click here]. |
| − | |||
| − | https://www.whmcs.com/members/reseller | ||
==Installation== | ==Installation== | ||
| − | To install the | + | To install the addon: |
| − | # | + | # [https://www.whmcs.com/members/reseller Download the addon.] |
| − | # Unzip the | + | # Unzip the ZIP file to a directory on your computer. |
| − | # Upload the files to the | + | # Upload the files to the <tt>/modules/addons/whmcslicenses/</tt> directory in your WHMCS installation. |
| − | # | + | # Log in to the Admin Area. |
| − | # Locate '''WHMCS License Manager''' in the list of | + | # Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. |
| − | # | + | # Locate '''WHMCS License Manager''' in the list of addon modules. |
| − | + | # Click '''Activate'''. | |
| − | + | # Make certain that the correct administrator role group has access to the addon. | |
| − | + | # Click '''Save'''. | |
| − | Enter your registered | + | # Go to '''Addons > WHMCS License Manager''' to verify that installation succeeded. |
| − | [[Image:whmcslicenses_splash.png|900px|WHMCS Licenses Splash Screen]] | + | # Enter your registered email address and API key for the reseller API:[[Image:whmcslicenses_splash.png|900px|WHMCS Licenses Splash Screen]]<div class="docs-alert-info">If you do not have a reseller API key, [https://www.whmcs.com/members/reseller click here].</div> |
| − | <div class="docs-alert-info">If you do not have a | ||
==Upgrading== | ==Upgrading== | ||
| − | To upgrade the | + | To upgrade the addon to a newer version: |
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | # [https://www.whmcs.com/members/reseller Download the newest version of the addon.] | |
| + | # Unzip the ZIP file to a directory on your computer. | ||
| + | # Upload the files to the <tt>/modules/addons/whmcslicenses/</tt> directory in your WHMCS installation, overwriting all existing files | ||
| + | # Log in to the Admin Area. | ||
| + | # Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. | ||
| + | # Locate '''WHMCS License Manager''' in the list of addon modules. | ||
| + | # Click '''Activate'''. | ||
| − | == | + | ==Use== |
===Getting Started=== | ===Getting Started=== | ||
====Bundled Offering==== | ====Bundled Offering==== | ||
| − | A bundled offering allows you to include a WHMCS license | + | A bundled offering allows you to include a free WHMCS license with certain purchases (for example, with a reseller hosting package). |
| − | To configure bundled offerings | + | To configure bundled offerings: |
| − | # | + | # Go to '''Addons > WHMCS License Manager'''. |
| − | # Click ''Automation Setup'' | + | # Click '''Automation Setup'''.[[File:whmcslicenses_bundled_offering.png|thumb|WHMCS Licenses Bundled Offering]] |
| − | + | # Under '''Bundled Offering''', select the products that will include free licenses with their initial purchase. | |
| − | # Under | + | #* You can choose between issuing a Starter or Plus license as a bundled license. |
| − | #* Each product can only | + | #* The system will not charge the customer for a bundled license. |
| − | + | #* Each product can only have a single license type.[[Image:whmcslicenses_paid_addons.png|thumb|WHMCS Licenses Bundled Offering]] | |
| − | ====Paid | + | ====Paid Addon Purchase==== |
| − | A paid | + | A paid addon offering allows you to offer a WHMCS license as an optional extra product addon during the initial order process. |
| − | To configure a paid | + | To configure a paid addon offering: |
| − | # | + | # Go to '''Addons > WHMCS License Manager'''. |
| − | # Click ''Automation Setup'' | + | # Click '''Automation Setup'''. |
| − | # Under | + | # Under '''Paid Add-on Purchase''', locate a product addon for the license type you wish to offer: |
| − | + | ## If there is one, click on it and modify the '''Applicable Products''' to include the product or products to offer it with. | |
| − | # If | + | ## If there is not one, create one in one of the following locations: |
| − | # | + | ### Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Product Addons''', selecting '''WHMCS License Reselling''' as the module. |
| + | ### Click '''Create Missing License Products''' in the '''Automation Setup''' tab. | ||
===Settings=== | ===Settings=== | ||
[[Image:whmcslicenses_settings.png|900px|WHMCS Licenses Settings]] | [[Image:whmcslicenses_settings.png|900px|WHMCS Licenses Settings]] | ||
====Client Upgrades==== | ====Client Upgrades==== | ||
| − | Enable this option to | + | Enable this option to send an email when your clients are approaching, or have 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==== | ====Notify Clients Approaching Limit==== | ||
| − | <div class="docs-alert-info"> | + | <div class="docs-alert-info">This setting is only available when client upgrades are disabled.</div> |
Enable this option to send clients an automated email notification when they reach the approaching client limit warning level. | Enable this option to send clients an automated email notification when they reach the approaching client limit warning level. | ||
====Approaching Limit Email==== | ====Approaching Limit Email==== | ||
| − | <div class="docs-alert-info"> | + | <div class="docs-alert-info">This setting is only available when client upgrades are disabled.</div> |
| − | Select the email template to | + | Select the email template to send when the above option is enabled. |
| + | * This defaults to '''WHMCS License Client Limit Imminent'''. | ||
| + | * You can edit email templates at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Email Templates]]''' or, prior to WHMCS 8.0, '''Setup > Email Templates'''. | ||
====Notify Clients At Limit==== | ====Notify Clients At Limit==== | ||
| − | <div class="docs-alert-info"> | + | <div class="docs-alert-info">This setting is only available when client upgrades are disabled.</div> |
Enable this option to send clients an automated email notification when they reach the client limit. | Enable this option to send clients an automated email notification when they reach the client limit. | ||
====At Limit Email==== | ====At Limit Email==== | ||
| − | <div class="docs-alert-info"> | + | <div class="docs-alert-info">This setting is only available when client upgrades are disabled.</div> |
| − | Select the email template to | + | Select the email template to send when the above option is enabled. |
| + | * This defaults to '''WHMCS License Client Limit Reached'''. | ||
| + | * You can edit email templates at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Email Templates]]''' or, prior to WHMCS 8.0, '''Setup > Email Templates'''. | ||
====Check for Unassigned License Keys==== | ====Check for Unassigned License Keys==== | ||
| − | Enable this option to find the first unassigned license key already active | + | Enable this option to find the first unassigned license key that is already active in your reseller account. This option can slow down provisioning if a large number of licenses are active in your account. |
==Automated Upgrade Flow== | ==Automated Upgrade Flow== | ||
| − | + | Versions 4.0 and later 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. | + | 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. |
[[File:whmcs-rlm-upgrade-preview.png|800px]] | [[File:whmcs-rlm-upgrade-preview.png|800px]] | ||
| − | Upgrade costs are calculated on a prorata basis | + | Upgrade costs are calculated on a prorata basis 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 | + | If the customer continues, the system generates an invoice that they can pay using any available payment gateway. After payment succeeds and is applied to the invoice, the license key will be upgraded instantly. |
[[File:whmcs-rlm-upgrade-invoice.png|800px]] | [[File:whmcs-rlm-upgrade-invoice.png|800px]] | ||
| − | 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 | + | 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. After this, the customer must follow the link again to see the revised upgrade price calculation and generate another invoice. |
| − | Prices for the upgrade are | + | Prices for the upgrade are determined by the pricing configuration in your product addons for WHMCS license types. 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. |
| − | The Automation Setup page provides a list of | + | The '''Automation Setup''' page provides a list of product addons that exist for each WHMCS license tier as well as a button to auto-create product addons for any license tiers for which you do not currently have an addon product. |
== Changelog== | == Changelog== | ||
Revision as of 19:21, 29 September 2021
- Addon Name: Reseller License Manager
- Latest Version: 4.0.7
- Release Date: 19th July 2021
- Compatible With: WHMCS 7.3 and later. Latest WHMCS 8.x is recommended.
The WHMCS Reseller License Manager is an addon for members of the WHMCS Reseller Program.
The addon integrates with WHMCS to provide the following features:
- 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.
Download
To download the addon, click here.
Installation
To install the addon:
- Download the addon.
- Unzip the ZIP file to a directory on your computer.
- Upload the files to the /modules/addons/whmcslicenses/ directory in your WHMCS installation.
- Log in to the Admin Area.
- Go to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
- Locate WHMCS License Manager in the list of addon modules.
- Click Activate.
- Make certain that the correct administrator role group has access to the addon.
- Click Save.
- Go to Addons > WHMCS License Manager to verify that installation succeeded.
- Enter your registered email address and API key for the reseller API:
If you do not have a reseller API key, click here.
Upgrading
To upgrade the addon to a newer version:
- Download the newest version of the addon.
- Unzip the ZIP file to a directory on your computer.
- Upload the files to the /modules/addons/whmcslicenses/ directory in your WHMCS installation, overwriting all existing files
- Log in to the Admin Area.
- Go to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
- Locate WHMCS License Manager in the list of addon modules.
- Click Activate.
Use
Getting Started
Bundled Offering
A bundled offering allows you to include a free WHMCS license with certain purchases (for example, with a reseller hosting package).
To configure bundled offerings:
- Go to Addons > WHMCS License Manager.
- Click Automation Setup.
- 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.
Paid Addon Purchase
A paid addon offering allows you to offer a WHMCS license as an optional extra product addon during the initial order process.
To configure a paid addon offering:
- Go to Addons > WHMCS License Manager.
- Click Automation Setup.
- Under Paid Add-on Purchase, locate a product addon for the license type you wish to offer:
- If there is one, click on it and modify the Applicable Products to include the product or products to offer it with.
- If there is not one, create one in one of the following locations:
- Go to Configuration () > System Settings > Product Addons, selecting WHMCS License Reselling as the module.
- Click Create Missing License Products in the Automation Setup tab.
Settings
Client Upgrades
Enable this option to send an email when your clients are approaching, or have 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
This setting is 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
This setting is only available when client upgrades are disabled.
Select the email template to send when the above option is enabled.
- This defaults to WHMCS License Client Limit Imminent.
- You can edit email templates at Configuration () > System Settings > Email Templates or, prior to WHMCS 8.0, Setup > Email Templates.
Notify Clients At Limit
This setting is 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
This setting is only available when client upgrades are disabled.
Select the email template to send when the above option is enabled.
- This defaults to WHMCS License Client Limit Reached.
- You can edit email templates at 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 that is already active in your reseller account. This option can slow down provisioning if a large number of licenses are active in your account.
Automated Upgrade Flow
Versions 4.0 and later 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.
Upgrade costs are calculated on a prorata basis 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 continues, the system generates an invoice that they can pay using any available payment gateway. After payment succeeds and is applied to the invoice, the license key will be upgraded instantly.
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. After this, the customer must follow the link again to see the revised upgrade price calculation and generate another invoice.
Prices for the upgrade are determined by the pricing configuration in your product addons for WHMCS license types. 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.
The Automation Setup page provides a list of product addons that exist for each WHMCS license tier as well as a button to auto-create product addons for any license tiers for which you do not currently have an addon product.
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
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