cPanel Licensing

Latest ReleaseCurrent VersionIncluded in WHMCS
N/AN/ANo

The cPanel Licensing module uses cPanel’s Manage2 API to provide an automated solution for cPanel Partners to provision, manage, and bill for cPanel & WHM licenses.

  • Make certain that you are using the correct addon module:
    • The cPanel Licensing addon automates purchases of cPanel & WHM licenses through Manage2.
    • The Software Licensing addon allows you to generate and check licenses for software products that you develop.
  • To use this module, you must be a cPanel Partner.

Activation

You will need to download and upload the module before you can activate the addon through the Admin Area.

  1. Download the latest version from the WHMCS Marketplace.
  2. Extract the ZIP file.
  3. Upload the cpanellicensing directory to the /modules/addons folder of your WHMCS installation.
  4. Go to Configuration () > System Settings > Addon Modules.
  5. Click Activate for cPanel Licensing.
  6. Click Configure.
  7. Select the admin role groups that will have access to this addon.
  8. Select the admins who can configure settings within the addon.
  9. Click Save Changes.

Using the cPanel Licensing Module

After configuring the module, you will need to authenticate into Manage2.

To do this, go to Addons > cPanel Licensing and log in using your Manage2 username and password. The system will import your Manage2 data into WHMCS. This may take several minutes depending on the number of licenses in your Manage2 account.

Logging in to Manage2 in the cPanel Licensing addon.

You can view the information that the module imports from Manage2 in the Licenses, Groups, and Packages tabs.

If you change your username or password in Manage2, you must manually reauthenticate with Manage2 in the cPanel Licensing addon. To do this, go to the cPanel Licensing Settings tab, click Logout, and then perform the steps above to log in again.

Licenses

In the Licenses tab, you can view and modify the license data in Manage2.

The cPanel Licensing addon's Licenses tab.

The addon associates licenses to specific services. You can manage the remaining data for services in the Products/Services.

The list of licenses displays the following license information:

  • License ID
  • Package/Group
  • IP/Hostname
  • Assigned Service
  • Status

You can also perform the following actions for each license:

ActionDescription
Assign LicenseAssign the license to an existing service. For more information, see Assigning Licenses to Services below.
Change IPChange the license’s associated IP address.
Change GroupChange the license’s group.
Change PackageChange the license’s package.
ExpireExpire the license in Manage2.
Expiring the license will not stop billing for that license. To stop billing, you must also set the parent service’s configurable option to None and recalculate the Recurring Amount value.
View License DetailsView additional detailed license information.

Groups

In the Groups tab, you can view and modify your groups in Manage2. Groups let you organize your licenses in categories.

The cPanel Licensing addon's Groups tab

The list of groups displays the following information:

  • Group ID
  • Name
  • Attributes
  • Licenses

You can also perform the following actions for each group:

ActionDescription
Change NameChange the group’s name.
Change Tax StatusChange the group’s status.
Show LicensesDisplay the list of licenses for that group.

Packages

In the Packages tab, you can view and modify your packages in Manage2. Packages represent the products, features, or bundled options for a license.

The cPanel Licensing addon's Packages tab.

The list of packages displays the following information:

  • Package ID
  • Name
  • Attributes
  • Licenses

You can also click Show Licenses in the Actions column to display the list of licenses for that package.

Pricing

In the Pricing tab, you can set pricing for license-related configurable options and metric pricing for cPanel accounts.

The cPanel Licensing addon's Pricing tab.

Configurable options can be for a product that can use a cPanel license, like a VPS or Dedicated server. You can also sell them as standalone products.

The list of configurable options displays the following information:

  • ID
  • Configuration Name
  • Selections
  • Auto-Scale

You can click the wrench icon in the Manage column to manage that option.

Create an Option

You can create options for offering cPanel licenses to your customers.

Creating an option in the cPanel Licensing addon.

To create a new option:

  1. Click New in the top-left corner.
  2. For Parent Group, select the option group to contain the new option. Choose Create New Group to enter a group name for a new option group.
  3. For Option Name, enter the configurable option’s display name.
  4. For Option Type, enter the configurable option’s type. You can choose Dropdown or Radio.
  5. For Auto-Populate, check to automatically populate the new option with the default cPanel license packages and recommend retail pricing.
  6. For Hardware Type, select whether to offer licenses for dedicated or VPS servers.
  7. For Default Visibility, set whether the configurable option is hidden or visible on the order form.
  8. Click Create.

Import an Existing Option

If you already have configurable options that you want to use, you can import them:

Importing an option in the cPanel Licensing addon.

To import existing configurable options to use with cPanel license products:

  1. Click Import in the top-right corner.
  2. Choose the desired configurable option group.
  3. Click Continue. The list of options for that option group will appear.
  4. For each option under Selectable Options, select the associated cPanel package.
    • Select Not a cPanel License Option to skip importing this option.
    • You can only import options that use the Dropdown and Radio option types.
  5. Click Import.

After you finish importing configurable options, you can view and manage them in the Pricing tab’s list of options.

Manage Options

Click Manage to manage a configurable option group, update pricing, and create new options within the group.

Managing an option in the cPanel Licensing addon.

A new window will display information about the configurable option group and its settings.

Update the Configurable Option Group

To update settings for the configurable option group:

  1. Select the desired option type (Dropdown or Radio).
  2. Toggle Visibility to show or hide the option group on the order form.
  3. Toggle Autoscale Option to enable or disable autoscaling.

The system will automatically save your changes.

Reorder Options

You can reorder the list of options under Options to change how they display on the order form. To do this, click the arrow icon next to the option name and drag it to the desired position in the list.

The system will automatically save your changes.

Update an Option

To update settings and pricing for an individual option:

  1. Click on the desired option under Options.
  2. To show or hide the option on the order form, toggle Visibility.
  3. To set the associated cPanel package, choose one for Package.
  4. To set pricing:
    1. Click on the desired billing cycle tab.
    2. Enter the desired Base Recurring and Setup Fee prices.
    3. For products that include unlimited cPanel accounts:
      • For Metric: cPanel Accounts, enter the price for each cPanel account that a customer uses beyond the Threshold setting. For more information, see Per-Account Billing below.
      • For Threshold, enter the maximum number of accounts that a customer can have before billing them on a per-account basis.
    4. If you are updating prices in the Monthly tab, toggle Auto populate other billing cycles based on monthly pricing to automatically populate prices for other billing cycles. If you do this, you will not be able to select the other billing cycle tabs.
  5. Click Save.

You can also click Delete to delete the option.

Per-Account Billing

The cPanel Licensing addon can bill customers for the number cPanel accounts that they use above a set threshold. This requires a package that includes unlimited cPanel accounts and an option for which you have configured Metric: cPanel Accounts and Threshold.

When a customer places an applicable order, the system takes a snapshot of the current price. This ensures that changes to a package’s metric pricing will not affect existing orders.

  • The system stores the snapshot and uses it when generating future renewal invoices for the service.
  • To update the pricing snapshot for a service to use the current metric pricing, select Auto Recalculate on Save when you make changes to the product in the Products/Services tab in the client profile. This discards the previous snapshot and create a new one.

The cPanel Licensing addon retrieves the number of cPanel accounts from Manage2 at the time of invoice generation. This ensures the most accurate value relative to Manage2.

Manage2 does not provide the historical data necessary to calculate any prior month’s usage and the cPanel Licensing addon does not take snapshots to augment this data.

Settings

In the Settings tab, you can configure settings for Manage2, autoscaling, and license sales.

The cPanel Licensing addon's Settings tab.

Click the Settings tab to configure the following settings:

SettingDescription
Manage2 AccountThe currently-authenticated Manage2 account email address. Click Logout to log out of the account.
Provisioning Default GroupSelect the default Manage2 group for new licenses.
PermissionsSelect the access controls for functionality within this addon.
Invoicing Line Item FormatEnter the invoice line item description for packages that offer bulk cPanel accounts.
Option Info TooltipEnter a tooltip to display with the license configurable options during checkout. This setting is optional and supports HTML.
Option Description FormatEnter the configurable option selection format to display on the order form for packages that offer bulk cPanel accounts.
Autoscale LabelEnter the label display on the order form.
Autoscale Notification EmailThe email template to send when autoscaling makes a change (see below).

Autoscaling

Autoscaling allows the cPanel Licensing addon module to dynamically adjust a service’s configurable options using the number of accounts on its cPanel license.

To use autoscaling, you must set pricing for all of the associated configurable options.

Autoscaling uses the following procedure:

  1. A server administrator provisions an extra cPanel account, pushing the server to the next cPanel license tier.
  2. cPanel’s Manage2 software detects this and changes the license tier for billing purposes in the cPanel Partner account.
  3. WHMCS syncs with Manage2 at specific intervals to detect this change.
  4. The Control Panel configurable option in WHMCS changes to match the new cPanel license tier. As a result, the service price recalculates to include the additional cost of the new license tier.
  5. The next renewal invoice that the service generates (per the Next Due Date) will reflect the new cPanel license tier.

Autoscale Notification Email

The cPanel Licensing module can send a custom email notification to a client whenever it makes an autoscaling change.

To configure this:

  1. Create the custom email template at Configuration () > System Settings > Email Templates.
    • The template must use the Product/Service Messages or Notification Messages types.
    • The template can use the following merge fields:
      • newOption — The display name of the configurable option that autoscaling upgraded to.
      • oldOption — The display name of the previous configurable option.
      • isUsageUpgrade — A Boolean value that indicates whether the upgrade is due to usage activity.
  2. Go to Addons > cPanel Licensing.
  3. Click on the Settings tab.
  4. Set Autoscale Notification Email to the new email template.
  5. Click Save Changes.

Standalone Product

To present a standalone product that provisions a cPanel license, use the cPanel Licensing addon with the Auto Release provisioning module:

  1. Go to Configuration () > System Settings > Products/Services.
  2. Click Create a New Product.
  3. Select Other for Product Type.
  4. Enter a product name.
  5. Select Auto Release for Module Name.
  6. Click Continue.
  7. Select the Pricing tab.
  8. Choose Recurring for Payment Type.
    Recurring pricing settings.
  9. Check the checkboxes in the One Time/Monthly column.
  10. Specify Setup and Price values of 0.00.
  11. Select the Module Settings tab.
  12. Select Automatically setup the product as soon as the first payment is received.
    Configuring the Auto Release module.
  13. Select the Configurable Options tab.
  14. Click the configurable option group for the cPanel license types. The cPanel Licensing addon creates this.
  15. Configure any other desired options.
  16. Click Save Changes.

When clients order this product, they will see the cPanel License Tier configurable option at the product configuration stage of the shopping cart. The system will provision the license with payment.

Service Management

cPanel Licensing details will display for associated services in the client’s profile’s Products/Services tab.

Managing licenses in the client profile.

You can also perform the following actions:

ActionDescription
Sync IPChange the license’s IP address to use the Dedicated IP or IP Address settings.
Sync PackageChange the license’s package to the package for the cPanel Licensing configurable option.
View DetailsView the cPanel License information.
ExpireExpire the license in Manage2.
Expiring the license will not stop billing for that license. To stop billing, you must also set the parent service’s configurable option to None and recalculate the Recurring Amount value.

You can also perform the following actions for all services in the client’s profile’s Products/Services tab, regardless of whether they include cPanel licensing:

ActionDescription
Provision New cPanel LicenseAutomatically provision a new license in Manage2. This license will use the cPanel Licensing configurable option’s displayed package and the Dedicated IP or IP Address setting.
Link to Existing LicenseSearch for existing licenses to assign to the service. For more information, see Assigning Licenses to Services below.

Assigning Licenses to Services

In the cPanel Licensing module Licenses tab and in the cPanel Licensing panel for the service, you can manually associate services and licenses.

To do this:

  1. Search for and select the desired service (Assign License) or license (Link to Existing License). Assigning licenses in the cPanel Licensing addon Linking licenses in the cPanel Licensing addon
  2. Click Assign.
  • The system will not automatically select the appropriate configurable options. You must set this for the service in the Products/Services tab using the appropriate package or using autoscaling. Otherwise, automated billing will not occur.
  • You can only assign one active license to a service. If you perform the above steps for a service that already has an associated license, the new associated license replaces the existing license.

Upgrading

If you have an earlier version of the cPanel Licensing module and want to upgrade:

  1. Download the latest version from the WHMCS Marketplace.
  2. Extract the .zip file.
  3. Upload the cpanellicensing directory to the /modules/addons folder of your WHMCS installation.

Change Log

N/A

Last modified: June 5, 2024