WHMCS Documentation - User contributions [en]

Spam Control

2022-02-01T19:22:41Z

PeterB: /* Apache SpamAssassin™ */

Spam can become a big problem. WHMCS comes with spam control filters to reduce the amount of spam you receive. The spam control features will allow you to block email address and keywords or phrases that appear in either the message subject or body. which pipe into the ticket system from email. Messages that you receive via the contact or submit ticket pages are not subject to these spam controls. For those, we recommend [[Security_Tab#Captcha_Form_Protection|using reCaptcha]].

==Adding a Blocked Email Address==

There are two ways to block an email address from opening tickets. The first is the easiest: when viewing a ticket from the email you want to block, click the '''Block Sender''' button next to the ticket opener's details.

For the second method, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Spam Control''' and use the '''Add''' box to enter the email you want to block. Then, submit the form to add it.

==Blocking Keywords or Phrases==

To set up keywords or phrases that, if they're in an email, will prevent the email from opening a ticket, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Spam Control'''. You can then enter the words or phrases and choose where the system looks for them (either the subject or body of the message). If the system finds that the email subject contains the blocked subject, or if the blocked phrase is found within the email body, then a ticket will not be opened. The blocking of keywords or phrases is not case-sensitive.

== Further Protection ==
=== Obscure Addresses ===
If you use common email addresses (especially hosting companies) such as support@ or contact@, you will receive more spam. This is due to spammers blindly emailing these addresses on several domains. If you use less-common addresses, it may reduce your level of incoming spam.

For example, you could use:
* helpme@yourdomain
* support-team@yourdomain
* assistance@yourdomain

=== Apache SpamAssassin™ ===
Outside of WHMCS, you can combat the number of spam emails you are receiving by enabling Apache SpamAssassin™. This tool does a very good job of picking up most spam using its rule-based system and worldwide database of spam messages. For more information, see http://spamassassin.apache.org/

If you have configured your anti-spam system to add a prefix to the email's subject, you can use spam control to block those emails. Visit '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Spam Control''', set the '''Type''' as ''Subject'', and enter the text added by your anti-spam system. For example, if <tt>**SPAM**</tt> is added to the subject, enter that text as the value. Then, click '''Add New Spam Control'''. Any email containing the text in the subject will now be blocked from being imported.

Spam Control

2022-02-01T19:22:23Z

PeterB: /* Blocking Keywords or Phrases */

Spam can become a big problem. WHMCS comes with spam control filters to reduce the amount of spam you receive. The spam control features will allow you to block email address and keywords or phrases that appear in either the message subject or body. which pipe into the ticket system from email. Messages that you receive via the contact or submit ticket pages are not subject to these spam controls. For those, we recommend [[Security_Tab#Captcha_Form_Protection|using reCaptcha]].

==Adding a Blocked Email Address==

There are two ways to block an email address from opening tickets. The first is the easiest: when viewing a ticket from the email you want to block, click the '''Block Sender''' button next to the ticket opener's details.

For the second method, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Spam Control''' and use the '''Add''' box to enter the email you want to block. Then, submit the form to add it.

==Blocking Keywords or Phrases==

To set up keywords or phrases that, if they're in an email, will prevent the email from opening a ticket, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Spam Control'''. You can then enter the words or phrases and choose where the system looks for them (either the subject or body of the message). If the system finds that the email subject contains the blocked subject, or if the blocked phrase is found within the email body, then a ticket will not be opened. The blocking of keywords or phrases is not case-sensitive.

== Further Protection ==
=== Obscure Addresses ===
If you use common email addresses (especially hosting companies) such as support@ or contact@, you will receive more spam. This is due to spammers blindly emailing these addresses on several domains. If you use less-common addresses, it may reduce your level of incoming spam.

For example, you could use:
* helpme@yourdomain
* support-team@yourdomain
* assistance@yourdomain

=== Apache SpamAssassin™ ===
Outside of WHMCS, you can combat the number of spam emails you are receiving by enabling Apache SpamAssassin™. This tool does a very good job of picking up most spam using its rule-based system and worldwide database of spam messages. For more information, see http://spamassassin.apache.org/

If you have configured your anti-spam system to add a prefix to the email's subject, you can use spam control to block those emails. Visit '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support > Spam Control''', set the '''Type''' as ''Subject'', and enter the text added by your anti-spam system. For example, if <tt>**SPAM**</tt> is added to the subject, enter that text as the value. Then, click '''Add New Spam Control'''. Any email containing the text in the subject will now be blocked from being imported.

Spam Control

2022-02-01T19:22:10Z

PeterB: /* Adding a Blocked Email Address */

Spam can become a big problem. WHMCS comes with spam control filters to reduce the amount of spam you receive. The spam control features will allow you to block email address and keywords or phrases that appear in either the message subject or body. which pipe into the ticket system from email. Messages that you receive via the contact or submit ticket pages are not subject to these spam controls. For those, we recommend [[Security_Tab#Captcha_Form_Protection|using reCaptcha]].

==Adding a Blocked Email Address==

There are two ways to block an email address from opening tickets. The first is the easiest: when viewing a ticket from the email you want to block, click the '''Block Sender''' button next to the ticket opener's details.

For the second method, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Spam Control''' and use the '''Add''' box to enter the email you want to block. Then, submit the form to add it.

==Blocking Keywords or Phrases==

To set up keywords or phrases that, if they're in an email, will prevent the email from opening a ticket, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support > Spam Control'''. You can then enter the words or phrases and choose where the system looks for them (either the subject or body of the message). If the system finds that the email subject contains the blocked subject, or if the blocked phrase is found within the email body, then a ticket will not be opened. The blocking of keywords or phrases is not case-sensitive.

== Further Protection ==
=== Obscure Addresses ===
If you use common email addresses (especially hosting companies) such as support@ or contact@, you will receive more spam. This is due to spammers blindly emailing these addresses on several domains. If you use less-common addresses, it may reduce your level of incoming spam.

For example, you could use:
* helpme@yourdomain
* support-team@yourdomain
* assistance@yourdomain

=== Apache SpamAssassin™ ===
Outside of WHMCS, you can combat the number of spam emails you are receiving by enabling Apache SpamAssassin™. This tool does a very good job of picking up most spam using its rule-based system and worldwide database of spam messages. For more information, see http://spamassassin.apache.org/

If you have configured your anti-spam system to add a prefix to the email's subject, you can use spam control to block those emails. Visit '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support > Spam Control''', set the '''Type''' as ''Subject'', and enter the text added by your anti-spam system. For example, if <tt>**SPAM**</tt> is added to the subject, enter that text as the value. Then, click '''Add New Spam Control'''. Any email containing the text in the subject will now be blocked from being imported.

WHMCS OpenID and cPanel Setup Guide

2022-01-13T20:52:39Z

PeterB: Undo revision 31120 by PeterB (talk)

==Why offer OpenID to your users?==

By leveraging WHMCS as an OpenID provider, you enable your clients to authenticate with other systems and applications using the login credentials of your WHMCS Billing & Support system. That means they only have to remember one username and password, and that's the username and password for your website, making things simpler and easier for the end user and keeping your brand in their mind.

For more information, see:
* [[OAuth]]
* http://www.openidexplained.com/
* http://www.connect2id.com/learn/openid-connect

==How does it work?==

When users visit an application that uses WHMCS as an OpenID provider, users will be presented with a "Login with WHMCS" button, which takes them to your WHMCS Client Portal. The user will authenticate using their login credentials for your WHMCS, if they are not already logged in, and then authorize the use of their profile information, if they have not previously done so. WHMCS will return them to the originating application, where an active logged session is established for them.

The referring application never sees the user's password, so there's no risk to the integrity of the client's authentication data. Subsequent logins to the referring application will not require re-authentication WHMCS so long as they are actively logged in there, but instead the two systems perform a background "handshake" on behalf of the user, creating a seamless, one-click login for the user.

== Setting Up OpenID Authentication for cPanel ==

cPanel & WHM 54 introduced support for login using OpenID Connect authentication providers. WHMCS 6.2 and later can act as an [[OpenID Connect|OpenID Connect Authentication Provider]].

To use these features:
# Set up the necessary SSL certificates on the cPanel & WHM server. <div class="docs-alert-danger">OpenID Connect requires a Certificate Authority verified SSL certificate. You must install an SSL certificate on the cPanel & WHM server for the cPanel and WHM service ports and for the WHMCS installation itself.</div>
# Log in to WHM as the <tt>root</tt> user.
# Navigate to '''Security Center > Manage External Authentications'''.
# Select the '''Configure''' tab.
# Click '''Configure''' for '''Log in via WHMCS'''.
# Copy the redirect URI that contains the cPanel port number (usually, <tt>2083</tt>).
# Log in to the WHMCS Admin Area.
# Generate credentials at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[OpenID Connect]]'''. We recommend using the following details, making certain to use the redirect URI you retrieved from WHM:
#* '''Application Name''' cPanel
#* '''Description''' hostname.example.com
#* '''Logo URI''' /modules/servers/cpanel/logo.png
# Copy the generated client ID and client secret and paste them into the appropriate fields within WHM's '''WHMCS External Authentication Provider Configuration''' interface
# In the '''Well Known Config URI''' field, enter your WHMCS system URL.
# Check to confirm that you have used the redirect URIs that WHMCS provided.
# Click '''Save'''.
# Toggle '''Status (cpaneld)''' to ''Enabled''. The '''Log in via WHMCS''' button should immediately begin showing on the cPanel login page.

Repeat this process for each compatible cPanel & WHM server for which you wish to offer WHMCS authentication. We recommend creating a unique set of OpenID Connect API credentials for each server you connect with your WHMCS installation.

==Testing the Integration==

Navigate to your cPanel login URL (for example, <tt><nowiki>https://host.example.com:2083</nowiki></tt>). A '''Log in via WHMCS''' button will display. If you do not see the button, make certain that you completed all of the above steps.

[[File:CPanelWHMCSOpenIDLogin.png]]

===Logging In Using OpenID Connect===

To log in using OpenID Connect:

# Click '''Log in via WHMCS''' on the cPanel login page. The system will redirect you to the WHMCS installation's login page.
# Log in with a valid WHMCS user email address and password.<div class="docs-alert-success">If a user is already authenticated to the WHMCS instance when they click '''Log in via WHMCS''' (either in the current browser session or via a cookie), the user will immediately return to the cPanel interface with an active login session.</div>
# If this is the first time you have logged in using this method:
## Click '''Authorize''' to grant the system permission to provide information to the cPanel & WHM server in order to associate the cPanel account and the WHMCS client account.
## Enter the cPanel account username and password to pair with the WHMCS user account.

The system will then redirect you to the cPanel interface.

<div class="docs-alert-warning">
cPanel does not provide a mechanism, at this time, to associate multiple cPanel accounts (on the same server) to a single OpenID Connect Subscriber. If your client has multiple hosting accounts on the same cPanel & WHM server, they will only be able to pair their WHMCS Billing & Support Client Account with one of those hosting accounts.
</div>

[[File:WHMCSAuthenticationAuthorizationScreen.png]]

WHMCS OpenID and cPanel Setup Guide

2022-01-13T20:51:29Z

PeterB: /* Setting Up OpenID Authentication for cPanel */

==Why offer OpenID to your users?==

By leveraging WHMCS as an OpenID provider, you enable your clients to authenticate with other systems and applications using the login credentials of your WHMCS Billing & Support system. That means they only have to remember one username and password, and that's the username and password for your website, making things simpler and easier for the end user and keeping your brand in their mind.

For more information, see:
* [[OAuth]]
* http://www.openidexplained.com/
* http://www.connect2id.com/learn/openid-connect

==How does it work?==

When users visit an application that uses WHMCS as an OpenID provider, users will be presented with a "Login with WHMCS" button, which takes them to your WHMCS Client Portal. The user will authenticate using their login credentials for your WHMCS, if they are not already logged in, and then authorize the use of their profile information, if they have not previously done so. WHMCS will return them to the originating application, where an active logged session is established for them.

The referring application never sees the user's password, so there's no risk to the integrity of the client's authentication data. Subsequent logins to the referring application will not require re-authentication WHMCS so long as they are actively logged in there, but instead the two systems perform a background "handshake" on behalf of the user, creating a seamless, one-click login for the user.

== Setting Up OpenID Authentication for cPanel ==

cPanel & WHM 54 introduced support for login using OpenID Connect authentication providers. WHMCS 6.2 and later can act as an [[OpenID Connect|OpenID Connect Authentication Provider]].

To use these features:
# Set up the necessary SSL certificates on the cPanel & WHM server. <div class="docs-alert-danger">OpenID Connect requires a Certificate Authority verified SSL certificate. You must install an SSL certificate on the cPanel & WHM server for the cPanel and WHM service ports and for the WHMCS installation itself.</div>
# Log in to WHM as the <tt>root</tt> user.
# Navigate to '''Security Center > Manage External Authentications'''.
# Select the '''Configure''' tab.
# Click '''Configure''' for '''Log in via WHMCS'''.
# Copy the redirect URI that contains the cPanel port number (usually, <tt>2083</tt>).
# Log in to the WHMCS Admin Area.
# Generate credentials at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[OpenID Connect]]'''. We recommend using the following details, making certain to use the redirect URI you retrieved from WHM:
#* '''Application Name''' cPanel
#* '''Description''' hostname.example.com
#* '''Logo URI''' /modules/servers/cpanel/logo.png
# Copy the generated client ID and client secret and paste them into the appropriate fields within WHM's '''WHMCS External Authentication Provider Configuration''' interface
# In the '''Well Known Config URI''' field, enter https://yourdomain.com/whmcs/oauth/openid-configuration.php. You must replace https://yourdomain.com/whmcs with your '''System URL'''.
# Check to confirm that you have used the redirect URIs that WHMCS provided.
# Click '''Save'''.
# Toggle '''Status (cpaneld)''' to ''Enabled''. The '''Log in via WHMCS''' button should immediately begin showing on the cPanel login page.

Repeat this process for each compatible cPanel & WHM server for which you wish to offer WHMCS authentication. We recommend creating a unique set of OpenID Connect API credentials for each server you connect with your WHMCS installation.

==Testing the Integration==

Navigate to your cPanel login URL (for example, <tt><nowiki>https://host.example.com:2083</nowiki></tt>). A '''Log in via WHMCS''' button will display. If you do not see the button, make certain that you completed all of the above steps.

[[File:CPanelWHMCSOpenIDLogin.png]]

===Logging In Using OpenID Connect===

To log in using OpenID Connect:

# Click '''Log in via WHMCS''' on the cPanel login page. The system will redirect you to the WHMCS installation's login page.
# Log in with a valid WHMCS user email address and password.<div class="docs-alert-success">If a user is already authenticated to the WHMCS instance when they click '''Log in via WHMCS''' (either in the current browser session or via a cookie), the user will immediately return to the cPanel interface with an active login session.</div>
# If this is the first time you have logged in using this method:
## Click '''Authorize''' to grant the system permission to provide information to the cPanel & WHM server in order to associate the cPanel account and the WHMCS client account.
## Enter the cPanel account username and password to pair with the WHMCS user account.

The system will then redirect you to the cPanel interface.

<div class="docs-alert-warning">
cPanel does not provide a mechanism, at this time, to associate multiple cPanel accounts (on the same server) to a single OpenID Connect Subscriber. If your client has multiple hosting accounts on the same cPanel & WHM server, they will only be able to pair their WHMCS Billing & Support Client Account with one of those hosting accounts.
</div>

[[File:WHMCSAuthenticationAuthorizationScreen.png]]

Working With Client Area Home Page Panels

2021-12-08T23:35:26Z

PeterB: /* Examples */

Like the client area's navigation and sidebars, the panels displayed on the client area home page are based on a tree structure of menu item objects. These panels are displayed on the home page to present quick information to a client after they log in, such as overdue invoices, links to active products and services, and domains that are soon to expire. Like the client area's navigation and sidebars, these panels can be modified programmatically. Working with these panels is nearly identical to modifying navbars and side bars.

=Panel Structure=

The client area's panels have an invisible root item. Each panel is a child of that invisible root item. Many panels in turn have their own child items that are rendered as lists of links inside the panel.

* ''root item''
** panel item
*** line item
*** line item
*** line item
** panel item
*** line item
*** line item
** panel item

=Panel Layout=

==Desktop Mode==

[[Image:Desktop mode client panels.png|thumb|The WHMCS 6.0 client area homepage panel layout in desktop mode]] When viewed in desktop mode, typically on desktop web browsers, client are homepage panels are rendered in two columns. Odd numbered panels are rendered on the left column and even numbered panels are rendered on the right column.

<div style="clear: both"></div>

==Responsive Mode==

[[Image:Responsive mode client panels.png|thumb|The WHMCS 6.0 client area homepage panel layout in responsive mode]] Responsive mode is activated when the client ares is viewed on a smaller screen, typically on a phone or tablet. Responsive mode renders all panels in a single column, with the left column placed over the right column. This means that odd numbered panels are displayed above even numbered panels in responsive mode.

<div style="clear: both"></div>

=Differences With Navigation And Sidebar Menu Items=

When rendered, a client area home page panel resembles a panel in the sidebar. It uses the same underlying structure as the menu item objects that render the sidebar, though with a number of changes:

A home page panel's label is not a clickable link. Setting a URI on a home page panel has no effect in WHMCS.

Panels can be rendered in a custom color to give it a unique effect. Define the '''color''' menu item attribute to set this color. The following colors are available:

* gold
* green
* red
* blue
* orange
* pink
* purple
* lime
* magenta
* teal
* turquoise
* emerald
* amethyst
* wet-asphalt
* midnight-blue
* sun-flower
* pomegranate
* silver
* asbestos

Finally, a home page panel has an optional button rendered to the right of the panel's label and badge. Define the following menu item extras to render a button in a home page panel:

* '''btn-link''': The URL to load in the user's web browser when the button is clicked.
* '''btn-text''': The text within the button.
* '''btn-icon''': An optional Font Awesome icon to display to the left of the button's text.

<div style="clear: both"></div>

=Default Panels=

The following panels are defined by default. Please note that hooks can register additional panels as well as interact with the default ones, so there is no guarantee that these panels will be visible, or necessarily in the given display orders.

In addition, most of the panels are conditional. They only display when certain conditions are met in addition to the user having the appropriate permissions.

{| class="wikitable"
|-
! Name
! Order
! Required Permission
! Conditions for Display
|-
| Unpaid Invoices
| 10
| Invoices
| At least one unpaid invoice with no overdue invoices
|-
| Overdue Invoices
| 10
| Invoices
| At least one overdue invoices
|-
| Domains Expiring Soon
| 50
| Manage Domains
| At least one domain expiring within 45 days
|-
| Active Products/Services
| 100
| Manage Products
| ''None''
|-
| Recent Support Tickets
| 150
| Support Tickets
| ''None''
|-
| Register a New Domain
| 200
| Orders
| Domain registration enabled
|-
| Your Files
| 250
| ''None''
| At least one file associated with the client's account
|-
| Affiliate Program
| 300
| Affiliate
| An active affiliate account
|-
| Recent News
| 500
| ''None''
| ''None''
|-
|}

=Interacting With Home Page Panels=

WHMCS 6.0 introduce a hook to allow manipulation of the client area home page's panels. Use WHMCS’ <tt>add_hook()</tt> function to call custom code when WHMCS is ready to render these panels.

* '''ClientAreaHomepagePanels'''
** Called prior to assigning the panel object to the view template.
** Passes the client area home panels' root item to the hook function.

=Examples=

==Add a local temperature panel to the homepage==

[[Image:Local_temperatures_home_page_panel.png|thumb|The WHMCS 6 client area home page with a custom local temperatures panel highlighted.]]

:''Please note that this example makes use of a free third party service unrelated to WHMCS. WHMCS cannot guarantee the state of this service and uses it for example purposes only.''

The powers that be at your hosting company have decided that they want to be their clients' single stop for everything and want to start providing a seamless general portal experience in addition to quality hosting. They feel that showing a simple temperature forecast after the user logs in is a good start to achieving it. Luckily, WHMCS provides a way to easily add this to the interface.

This example uses the '''ClientAreaHomepagePanels''' hook and the menu item's <tt>addChild()</tt> and <tt>moveToFront()</tt> methods. The <tt>WHMCS\User\Client</tt> class contains the information to query for weather data. This calls the United States National Weather Service's [http://graphical.weather.gov/xml/ National Digital Forecast Database web service] and requires [http://php.net/manual/en/book.soap.php SOAP] support in your PHP installation. It also uses the [https://github.com/briannesbitt/Carbon Carbon] library for date manipulation and display. The Carbon library is bundled with WHMCS version 6. To add this panel to the client area home page we must:

# Translate the logged in user's zip code into a latitude/longitude pair.
# Send the user's latitude/longitude pair to the NDFD service to retrieve their local forecast.
# Add a child panel to the home page panels list that has the label "Local Temperatures" and has today's temperatures in the panel's body HTML.
# Add child items to the panel for the next five days of temperatures. WHMCS will display these temperatures in a list inside the panel.
# Move the local temperatures to the beginning so it's displayed first.

Create the <tt>includes/hooks/clientWeatherPanel.php</tt> file in your WHMCS installation and enter the code below. WHMCS will parse the file and hook when the page loads and will run the hook function when the client visits the home page after logging in.

<div style="clear: both"></div>

<syntaxhighlight lang="php">
<?php

use Carbon\Carbon;
use WHMCS\Authentication\CurrentUser;
use WHMCS\View\Menu\Item;

add_hook('ClientAreaHomepagePanels', 1, function (Item $homePagePanels)
{
/** @var \WHMCS\User\Client $currentUser */
$currentUser = CurrentUser::client();
$today = Carbon::now()->startOfDay();

// Connect to the United States' National Weather Service.
// See http://graphical.weather.gov/xml/ for more information.
$soapClient = new SoapClient('http://graphical.weather.gov/xml/DWMLgen/wsdl/ndfdXML.wsdl');

// The weather API takes a latitude/longitude pair as input. Translate the
// current user's zip code into a coordinate pair.
$response = simplexml_load_string($soapClient->LatLonListZipCode($currentUser->postcode));
list ($latitude, $longitude) = explode(',', $response->latLonList);

// Query for the weather forecast and turn it into display data.
$response = simplexml_load_string($soapClient->NDFDGen($latitude, $longitude, 'glance'));
$maximumTemperatures = (array)$response->data->parameters->temperature[0]->value;
$minimumTemperatures = (array)$response->data->parameters->temperature[1]->value;

// Build the new temperature panel by adding a child panel to the panel
// list.
$todaysMaximum = $maximumTemperatures[0];
$todaysMinimum = $minimumTemperatures[0];

$weatherPanel = $homePagePanels->addChild('local temperatures', array(
'label' => 'Local Temperatures',
'icon' => 'fa-cloud',
'extras' => array(
'color' => 'blue',
),
'bodyHtml' => "<p>Today's temperature in {$currentUser->city}: {$todaysMinimum}°F / {$todaysMaximum}°F</p>",
));

// Add the 5-day temperature forecast as child items to the panel so WHMCS
// can present them nicely in a list.
for ($i = 1; $i <= 5; $i++) {
$day = $today->addDays(1);
$minimumTemperature = $minimumTemperatures[$i];
$maximumTemperature = $maximumTemperatures[$i];

$weatherPanel->addChild($day->format('l, F j'), array(
'label' => $day->format('l, F j'),
'icon' => 'fa-angle-double-right',
'badge' => "{$minimumTemperature}°F / {$maximumTemperature}°F",
'order' => $i,
));
}

// Finally, move the panel to the beginning of the panel list so it's
// displayed first.
$weatherPanel->moveToFront();
});
</syntaxhighlight>

==Add a promotional offer panel==

[[Image:Redeem_offer_home_page_panel.png|thumb|The WHMCS 6 client area home page in responsive mode with custom special offer panel highlighted.]] After a lengthy beta period, your company has just released the latest version of its flagship product. The users love it, and the orders are rolling in. The public beta period was so successful that management wants to offer a free month of the service to all existing clients. The promo page is ready to go, so all that's left is to inform the users. The sales team wants it to show up after any unpaid or overdue invoice notices. There's a business to run, after all. Thankfully WHMCS provides an easy way to let the users know about the special offer right after they log in.

Like the previous example, this example uses the '''ClientAreaHomepagePanels''' hook and the menu item's <tt>addChild()</tt> method. Unlike the previous examples though it doesn't need a list of child items, but it will use a panel's body HTML and custom button in the corner. To add this panel to the client area home page we must:

# Add a child panel to the home page panels list that has the the following extras:
#* A '''btn-link''' extra containing a link to the special promo.
#* A '''btn-text''' extra containing the text of the button.
# Define body and footer HTML in the panel to make the promotion conform to WHMCS' look and feel.
# Set the order to 20 to place it after the default unpaid and overdue invoice panels.

Create the <tt>includes/hooks/specialOfferPanel.php</tt> file in your WHMCS installation and enter the code below. As with the previous example, WHMCS will parse the file and hook when the page loads and will run the hook function when the client visits the home page after logging in.

<div style="clear: both"></div>

<syntaxhighlight lang="php">
<?php

use WHMCS\View\Menu\Item;

add_hook('ClientAreaHomepagePanels', 1, function (Item $homePagePanels)
{
$thankYouMessage = <<<EOT
<p>Thanks for beta testing our latest offerings! To show our appreciation we'd
like to provide next month of service <strong>on the house</strong>.</p>
EOT;

// Add a homepage panel with a link to a free month promo and mode it to the
// front of the panel list.
$homePagePanels->addChild('thanks', array(
'label' => 'Thanks for the help!',
'icon' => 'fa-thumbs-up',
'order' => 20,
'extras' => array(
'color' => 'gold',
'btn-link' => 'https://example.org/free-month-promo',
'btn-text' => 'Redeem Your Free Month',
'btn-icon' => 'fa-arrow-right',
),
'bodyHtml' => $thankYouMessage,
'footerHtml' => 'Act fast! This offer expires soon!',
));
});
</syntaxhighlight>

==Modifying an existing panel==

Another common item is to want to change a link button and its text in a home panel panel (for example: if you want to link to a third party ticket system you already have in place.

Create the <tt>includes/hooks/recentTicketsPanel.php</tt> file in your WHMCS installation and enter the code below. As with the previous example, WHMCS will parse the file and hook when the page loads and will run the hook function when the client visits the home page after logging in.

<div style="clear: both"></div>

<syntaxhighlight lang="php">
<?php

// This hook will adjust the button in the home page panels. You have two
// different options of setExtra() or setExtras(). Use of setExtras() requires
// passing all 'extra' related vars through the array.

use WHMCS\View\Menu\Item;

add_hook('ClientAreaHomepagePanels', 1, function (Item $homePagePanels) {
$recentTicketsPanel = $homePagePanels->getChild('Recent Support Tickets');

if (!is_null($recentTicketsPanel)) {
$recentTicketsPanel->setExtras(
[
'color' => 'amethyst',
'btn-text' => 'New Name Here',
'btn-link' => 'http://newlinkgoes.here',
'btn-icon' => 'fa-thumbs-o-down',
]
);
}
});
</syntaxhighlight>

==Rearranging an existing panel==
You may wish to change the order in which a panel appears within the Client Area.

Create the <tt>includes/hooks/rearrangeRegisterDomainPanel.php</tt> file in your WHMCS installation and enter the code below. As with previous examples, WHMCS will parse the file and hook when the page loads and will run the hook function when the client visits the home page after logging in.
<div style="clear: both"></div>
<syntaxhighlight lang="php">
<?php

// This hook will rearrange the Register a New Domain panel
// to be the first panel displayed in the client area

use WHMCS\View\Menu\Item;

add_hook('ClientAreaHomepagePanels', 1, function (Item $homePagePanels) {
if (!is_null($homePagePanels->getChild('Register a New Domain'))) {
$homePagePanels->getChild('Register a New Domain')
->setOrder(0);
}
});
</syntaxhighlight>
==Removing an existing panel==
You may wish to remove a panel from the client area.

Create the <tt>includes/hooks/removeRegisterDomainPanel.php</tt> file in your WHMCS installation and enter the code below. As with previous examples, WHMCS will parse the file and hook when the page loads and will run the hook function when the client visits the home page after logging in.
<div style="clear: both"></div>
<syntaxhighlight lang="php">
<?php

// This hook will remove the Register a New Domain panel from the client area

use WHMCS\View\Menu\Item;

add_hook('ClientAreaHomepagePanels', 1, function (Item $homePagePanels) {
if (!is_null($homePagePanels->getChild('Register a New Domain'))) {
$homePagePanels->removeChild('Register a New Domain');
}
});
</syntaxhighlight>

Ensim

2021-12-01T14:02:12Z

PeterB:

{{Provisioning_Module
| changepw = Yes}}
== '''Important Notes''' ==

<div class="docs-alert-danger">
<span class="title">Module Deprecated</span><br />
Following the closure of the Ensim service, this module was subsequently deprecated. We removed this module in WHMCS 6.0.
</div>

1. This only currently works for ensim servers local to the WHMCS install. A script specifically for remote ensim servers is being developed.

2. Access to the Sudo command is required from PHP for this to work.

3. By default Ensim has a command in the /etc/sudoers file "Defaults requiretty" you will need to commend this out by changing it to "#Defaults requiretty" in order to allow Sudo access to PHP

== '''Overview''' ==

1) [[Ensim#Step_1:_Setup_the_WHMCS_Local_Server|Setup the WHMCS Local Server]]

2) [[Ensim#Step_2:_Symbolic_Links|Setup Symbolic Links on your server]]

3) [[Ensim#Step_3:_Setup_the_Products_with_Ensim_Packages|Setup the Products with Ensim Packages]]

=== '''Step 1: Setup the WHMCS Local Server''' ===

# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers'''.
# Click '''Add New Server'''.
# Configure your server settings. Choose the server type "EnsimX".
# Enter a password for the server. You will need this password later on. A username or server hash is not required.
# Click '''Save'''.

=== '''Step 2: Symbolic Links''' ===

Now you will need to create symbolic links to the VirtDomain scripts on the local Ensim server. You will need to be logged in as the root account in order to complete this step. For our example, we would use the following commands to create the needed links:

'''**** REPLACE PASSWORD IN EACH LINE BELOW WITH YOUR SERVER PASSWORD'''

cd /usr/local/bin
ln -s AddVirtDomain AddVirtDomain-PASSWORD
ln -s DeleteVirtDomain DeleteVirtDomain-PASSWORD
ln -s EnableVirtDomain EnableVirtDomain-PASSWORD
ln -s DisableVirtDomain DisableVirtDomain-PASSWORD
ln -s EditVirtDomain EditVirtDomain-PASSWORD
ln -s AddReseller AddReseller-PASSWORD

Copy the file "ChangeDomainPasswd-PASSWORD" from the zip file here https://www.whmcs.com/members/dl.php?type=d&id=29 to /usr/local/bin .. remember to rename the file with your server password entered above instead of PASSWORD
Edit the file /etc/sudoers. Add the following lines to the end of the file, substituting your link names as needed.

<nowiki>==================================================================</nowiki>

Cmnd_Alias ENSIM = /usr/local/bin/AddVirtDomain-PASSWORD, \
/usr/local/bin/DeleteVirtDomain-PASSWORD, \
/usr/local/bin/EnableVirtDomain-PASSWORD, \
/usr/local/bin/DisableVirtDomain-PASSWORD, \
/usr/local/bin/EditVirtDomain-PASSWORD, \
/usr/local/bin/AddReseller-PASSWORD, \
/usr/local/bin/ChangeDomainPasswd-PASSWORD
apache ALL=(ALL) NOPASSWD: ENSIM

<nowiki>==================================================================</nowiki>

Save and close the file.

=== '''Step 3: Setup the Products with Ensim Packages''' ===

* 1. Setup the Hosting Plans in your Ensim Server Administrator Panel By clicking on SITE MANAGER -> Add Service Plan. Write down the name of the service plan - DO NOT PUT SPACES IN THE NAME - If you want to put a space, put an underscore _

* 2. Login to the WHMCS Control Panel

* 3. Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services'''.

* 4. Create a product and configure as required

* 5. Then click "Module Settings"

* 6. Choose Applies to Server Type "EnsimX"

* 7. Set "Package Name" to the same name as the Service Plan you setup in step 1

* 8. Save changes, and test by placing a new order and setting the cost of the product to $0

Enjoy!

{{modules}}

Version 8.3 Release Notes

2021-10-13T16:26:24Z

PeterB: Redirected page to Version 8.3.0 Release Notes

#REDIRECT [[Version_8.3.0_Release_Notes]]

Version 8.2.0 Release Notes

2021-07-13T13:58:35Z

PeterB: /* Template */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.2<br />
Release Type: Maintenance<br />
Latest Update: 13th July 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.2.0</td><td>Beta 1</td><td>13th May 2021</td></tr>
<tr><td>8.2.0</td><td>Release Candidate 1</td><td>4th June 2021</td></tr>
<tr><td>8.2.0</td><td>General Availability</td><td>21st June 2021</td></tr>
<tr><td>8.2.1</td><td>Maintenance</td><td>13th July 2021</td></tr>
</table>

==Download==

Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==

WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== WordPress Toolkit Automation ===

You can now easily offer WordPress® management tools using our integration with WordPress Toolkit for cPanel and Plesk using [[Product Addons]]. Features include a pre-made landing page, provisioning automation, SSO into the WP Toolkit interface and integrated upsells within the WP Toolkit user experience. Setup is made easier via another new feature, Predefined Addons, which provide one-click setup of WP Toolkit addons within WHMCS.

[[WordPress Toolkit|Learn More...]]

=== Addon Types and Predefined Addons ===

WHMCS now supports a new system of addon types, which includes Independent Products, the new name for the existing type of WHMCS addon, and '''Add-On Features''', which allow you to sell module-specific addons or features and automate provisioning through our existing addon system.

A selection of Predefined Addons is now available when you start the '''Add New Addon''' setup at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Product Addons'''. These Predefined Addons set all of the purpose-specific and common settings, leaving just the pricing for you to configure and save.

[[Product Addons|Learn More...]]

=== Web.com Site Builder ===

MarketConnect now allows you to offer Web.com Site Builder. This unbranded website builder includes several plans, each competitively tailored to give the creative experience your customers need to grow their sites.

[[Web.com_Site_Builder_via_WHMCS_MarketConnect|Learn More...]]

=== User Identity Verification ===

Integrated services from Validation.com give your team additional tools to verify user authenticity. You can initiate the user validation process automatically when orders are flagged for fraud review, manually while reviewing orders, or on demand for specific users. User identity verification can work in tandem with your current fraud protection configuration or as a standalone integration.

You can activate user identity verification at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection'''.

[[User_Identity_Verification|Learn More...]]

=== Product Addons ===

You can now set up [[Prorata_Billing|prorated product addons]], syncing the addon's billing day with the parent product or service. You can now also quickly duplicate existing product addons.

[[Product_Addons#Pricing|Learn More...]]

=== Payment Gateway Balances and Transactions ===

In the Admin Area, the '''Transactions''' list now displays gateway balance information for your activated gateways that use our latest gateway module balance functionality. In WHMCS 8.2, that includes native support for Stripe and PayPal Basic.

Additionally, developers can now retrieve transaction details through gateway modules, with initial support for Stripe. For more information on updating payment gateway modules for this functionality, see our [https://developers.whmcs.com/payment-gateways/displaying-balances/ Developer Documentation].

[[Payment_Gateway_Balances_and_Transactions|Learn More...]]

=== Stripe Balance Widget ===

The Admin Area Dashboard now includes a new Stripe widget displaying your '''Available''' and '''Pending''' Stripe balances. This displays balances for each currency that is both configured in WHMCS and held with the gateway.

[[Stripe_Balance_Widget|Learn More...]]

=== Free Domain Reminders ===

The new '''Free Domain Reminders''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' allows you to send renewal notices for free domains (domains bundled with a paid product or service) using the same configuration as paid domain renewals. In the Client Area, users will see a message instead of the option to renew free domains at '''Domains > Renew Domains'''.

[[Free_Domains|Learn More...]]

== Deprecation and Removal Notices ==

=== Removed UK VAT Validation Settings ===

The HRMC UK VAT system no longer requires API credentials. Because of this, we have simplified VAT setup by removing the '''Client ID''' and '''Client Secret''' settings from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Tax Configuration'''.

=== Discontinued Worldpay Support ===

We have removed support for the Worldpay Invisible and Worldpay Invidible XML gateways.

== New Documentation ==

The following new documentation pages are available:

* [[Prorata Billing]]
* [[Web.com Site Builder via WHMCS MarketConnect]]
* [[Free Domains]]
* [[User Identity Verification]]
* [[UK VAT Validation]]

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the GitHub repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.1.3 and 8.2.1 (Maintenance):

https://github.com/WHMCS/templates-twenty-one/compare/v8.1.3-release.1...v8.2.1-release.1

=== Six Theme ===

The following link provides a comparison of changes between 8.1.3 and 8.2.1 (Maintenance):

https://github.com/WHMCS/templates-six/compare/v8.1.3-release.1...v8.2.1-release.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.1.3 and 8.2.1 (Maintenance):

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.1.3-release.1...v8.2.1-release.1

== Changelog ==
* [[Changelog:WHMCS_V8.2.0_Beta_1|Version 8.2.0 Beta 1]]
* [[Changelog:WHMCS_V8.2.0_RC_1|Version 8.2.0 RC 1]]
* [[Changelog:WHMCS_V8.2.0_GA|Version 8.2.0 GA]]
* [[Changelog:WHMCS_V8.2.1|Version 8.2.1]]

Version 8.2.0 Release Notes

2021-07-13T13:57:14Z

PeterB:

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.2<br />
Release Type: Maintenance<br />
Latest Update: 13th July 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.2.0</td><td>Beta 1</td><td>13th May 2021</td></tr>
<tr><td>8.2.0</td><td>Release Candidate 1</td><td>4th June 2021</td></tr>
<tr><td>8.2.0</td><td>General Availability</td><td>21st June 2021</td></tr>
<tr><td>8.2.1</td><td>Maintenance</td><td>13th July 2021</td></tr>
</table>

==Download==

Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==

WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== WordPress Toolkit Automation ===

You can now easily offer WordPress® management tools using our integration with WordPress Toolkit for cPanel and Plesk using [[Product Addons]]. Features include a pre-made landing page, provisioning automation, SSO into the WP Toolkit interface and integrated upsells within the WP Toolkit user experience. Setup is made easier via another new feature, Predefined Addons, which provide one-click setup of WP Toolkit addons within WHMCS.

[[WordPress Toolkit|Learn More...]]

=== Addon Types and Predefined Addons ===

WHMCS now supports a new system of addon types, which includes Independent Products, the new name for the existing type of WHMCS addon, and '''Add-On Features''', which allow you to sell module-specific addons or features and automate provisioning through our existing addon system.

A selection of Predefined Addons is now available when you start the '''Add New Addon''' setup at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Product Addons'''. These Predefined Addons set all of the purpose-specific and common settings, leaving just the pricing for you to configure and save.

[[Product Addons|Learn More...]]

=== Web.com Site Builder ===

MarketConnect now allows you to offer Web.com Site Builder. This unbranded website builder includes several plans, each competitively tailored to give the creative experience your customers need to grow their sites.

[[Web.com_Site_Builder_via_WHMCS_MarketConnect|Learn More...]]

=== User Identity Verification ===

Integrated services from Validation.com give your team additional tools to verify user authenticity. You can initiate the user validation process automatically when orders are flagged for fraud review, manually while reviewing orders, or on demand for specific users. User identity verification can work in tandem with your current fraud protection configuration or as a standalone integration.

You can activate user identity verification at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection'''.

[[User_Identity_Verification|Learn More...]]

=== Product Addons ===

You can now set up [[Prorata_Billing|prorated product addons]], syncing the addon's billing day with the parent product or service. You can now also quickly duplicate existing product addons.

[[Product_Addons#Pricing|Learn More...]]

=== Payment Gateway Balances and Transactions ===

In the Admin Area, the '''Transactions''' list now displays gateway balance information for your activated gateways that use our latest gateway module balance functionality. In WHMCS 8.2, that includes native support for Stripe and PayPal Basic.

Additionally, developers can now retrieve transaction details through gateway modules, with initial support for Stripe. For more information on updating payment gateway modules for this functionality, see our [https://developers.whmcs.com/payment-gateways/displaying-balances/ Developer Documentation].

[[Payment_Gateway_Balances_and_Transactions|Learn More...]]

=== Stripe Balance Widget ===

The Admin Area Dashboard now includes a new Stripe widget displaying your '''Available''' and '''Pending''' Stripe balances. This displays balances for each currency that is both configured in WHMCS and held with the gateway.

[[Stripe_Balance_Widget|Learn More...]]

=== Free Domain Reminders ===

The new '''Free Domain Reminders''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' allows you to send renewal notices for free domains (domains bundled with a paid product or service) using the same configuration as paid domain renewals. In the Client Area, users will see a message instead of the option to renew free domains at '''Domains > Renew Domains'''.

[[Free_Domains|Learn More...]]

== Deprecation and Removal Notices ==

=== Removed UK VAT Validation Settings ===

The HRMC UK VAT system no longer requires API credentials. Because of this, we have simplified VAT setup by removing the '''Client ID''' and '''Client Secret''' settings from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Tax Configuration'''.

=== Discontinued Worldpay Support ===

We have removed support for the Worldpay Invisible and Worldpay Invidible XML gateways.

== New Documentation ==

The following new documentation pages are available:

* [[Prorata Billing]]
* [[Web.com Site Builder via WHMCS MarketConnect]]
* [[Free Domains]]
* [[User Identity Verification]]
* [[UK VAT Validation]]

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the GitHub repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (GA):

https://github.com/WHMCS/templates-twenty-one/compare/v8.1.3-release.1...v8.2.0-release.1

=== Six Theme ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (GA):

https://github.com/WHMCS/templates-six/compare/v8.1.3-release.1...v8.2.0-release.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (GA):

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.1.3-release.1...v8.2.0-release.1

== Changelog ==
* [[Changelog:WHMCS_V8.2.0_Beta_1|Version 8.2.0 Beta 1]]
* [[Changelog:WHMCS_V8.2.0_RC_1|Version 8.2.0 RC 1]]
* [[Changelog:WHMCS_V8.2.0_GA|Version 8.2.0 GA]]
* [[Changelog:WHMCS_V8.2.1|Version 8.2.1]]

Version 8.2.1 Release Notes

2021-07-13T13:56:26Z

PeterB: Redirected page to Version 8.2.0 Release Notes

#REDIRECT [[Version_8.2.0_Release_Notes]]

Version 8.2.0 Release Notes

2021-06-21T14:09:00Z

PeterB:

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.2<br />
Release Type: General Availability<br />
Latest Update: 21st June 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.2.0</td><td>Beta 1</td><td>13th May 2021</td></tr>
<tr><td>8.2.0</td><td>Release Candidate 1</td><td>4th June 2021</td></tr>
<tr><td>8.2.0</td><td>General Availability</td><td>21st June 2021</td></tr>
</table>

==Download==

Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==

WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== WordPress Toolkit Automation ===

You can now easily offer WordPress® management tools using our integration with WordPress Toolkit for cPanel and Plesk using [[Product Addons]]. Features include a pre-made landing page, provisioning automation, SSO into the WP Toolkit interface and integrated upsells within the WP Toolkit user experience. Setup is made easier via another new feature, Predefined Addons, which provide one-click setup of WP Toolkit addons within WHMCS.

[[WordPress Toolkit|Learn More...]]

=== Addon Types and Predefined Addons ===

WHMCS now supports a new system of addon types, which includes Independent Products, the new name for the existing type of WHMCS addon, and '''Add-On Features''', which allow you to sell module-specific addons or features and automate provisioning through our existing addon system.

A selection of Predefined Addons is now available when you start the '''Add New Addon''' setup at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Product Addons'''. These Predefined Addons set all of the purpose-specific and common settings, leaving just the pricing for you to configure and save.

[[Product Addons|Learn More...]]

=== Web.com Site Builder ===

MarketConnect now allows you to offer Web.com Site Builder. This white-labeled website builder includes several plans, each competitively tailored to give the creative experience your customers need to grow their sites.

[[Web.com_Site_Builder_via_WHMCS_MarketConnect|Learn More...]]

=== User Identity Verification ===

Integrated services from Validation.com give your team additional tools to verify user authenticity. You can initiate the user validation process automatically when orders are flagged for fraud review, manually while reviewing orders, or on demand for specific users. User identity verification can work in tandem with your current fraud protection configuration or as a standalone integration.

You can activate user identity verification at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection'''.

[[User_Identity_Verification|Learn More...]]

=== Product Addons ===

You can now set up [[Prorata_Billing|prorated product addons]], syncing the addon's billing day with the parent product or service. You can now also quickly duplicate existing product addons.

[[Product_Addons#Pricing|Learn More...]]

=== Payment Gateway Balances and Transactions ===

In the Admin Area, the '''Transactions''' list now displays gateway balance information for your activated gateways that use our latest gateway module balance functionality. In WHMCS 8.2, that includes native support for Stripe and PayPal Basic.

Additionally, developers can now retrieve transaction details through gateway modules, with initial support for Stripe. For more information on updating payment gateway modules for this functionality, see our [https://developers.whmcs.com/payment-gateways/displaying-balances/ Developer Documentation].

[[Payment_Gateway_Balances_and_Transactions|Learn More...]]

=== Stripe Balance Widget ===

The Admin Area Dashboard now includes a new Stripe widget displaying your '''Available''' and '''Pending''' Stripe balances. This displays balances for each currency that is both configured in WHMCS and held with the gateway.

[[Stripe_Balance_Widget|Learn More...]]

=== Free Domain Reminders ===

The new '''Free Domain Reminders''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' allows you to send renewal notices for free domains (domains bundled with a paid product or service) using the same configuration as paid domain renewals. In the Client Area, users will see a message instead of the option to renew free domains at '''Domains > Renew Domains'''.

[[Free_Domains|Learn More...]]

== Deprecation and Removal Notices ==

=== Removed UK VAT Validation Settings ===

The HRMC UK VAT system no longer requires API credentials. Because of this, we have simplified VAT setup by removing the '''Client ID''' and '''Client Secret''' settings from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Tax Configuration'''.

=== Discontinued Worldpay Support ===

We have removed support for the Worldpay Invisible and Worldpay Invidible XML gateways.

== New Documentation ==

The following new documentation pages are available:

* [[Prorata Billing]]
* [[Web.com Site Builder via WHMCS MarketConnect]]
* [[Free Domains]]
* [[User Identity Verification]]
* [[UK VAT Validation]]

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the GitHub repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (GA):

https://github.com/WHMCS/templates-twenty-one/compare/v8.1.3-release.1...v8.2.0-release.1

=== Six Theme ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (GA):

https://github.com/WHMCS/templates-six/compare/v8.1.3-release.1...v8.2.0-release.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (GA):

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.1.3-release.1...v8.2.0-release.1

== Changelog ==
* [[Changelog:WHMCS_V8.2.0_Beta_1|Version 8.2.0 Beta 1]]
* [[Changelog:WHMCS_V8.2.0_RC_1|Version 8.2.0 RC 1]]
* [[Changelog:WHMCS_V8.2.0_GA|Version 8.2.0 GA]]

Version 8.2.0 Release Notes

2021-06-21T14:05:51Z

PeterB: /* Standard Cart Order Form */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.2<br />
Release Type: RC<br />
Latest Update: 4th June 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.2.0</td><td>Beta 1</td><td>13th May 2021</td></tr>
<tr><td>8.2.0</td><td>Release Candidate 1</td><td>4th June 2021</td></tr>
<tr><td>8.2.0</td><td>General Availability</td><td>21st June 2021</td></tr>
</table>

==Download==

Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==

WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== WordPress Toolkit Automation ===

You can now easily offer WordPress® management tools using our integration with WordPress Toolkit for cPanel and Plesk using [[Product Addons]]. Features include a pre-made landing page, provisioning automation, SSO into the WP Toolkit interface and integrated upsells within the WP Toolkit user experience. Setup is made easier via another new feature, Predefined Addons, which provide one-click setup of WP Toolkit addons within WHMCS.

[[WordPress Toolkit|Learn More...]]

=== Addon Types and Predefined Addons ===

WHMCS now supports a new system of addon types, which includes Independent Products, the new name for the existing type of WHMCS addon, and '''Add-On Features''', which allow you to sell module-specific addons or features and automate provisioning through our existing addon system.

A selection of Predefined Addons is now available when you start the '''Add New Addon''' setup at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Product Addons'''. These Predefined Addons set all of the purpose-specific and common settings, leaving just the pricing for you to configure and save.

[[Product Addons|Learn More...]]

=== Web.com Site Builder ===

MarketConnect now allows you to offer Web.com Site Builder. This white-labeled website builder includes several plans, each competitively tailored to give the creative experience your customers need to grow their sites.

[[Web.com_Site_Builder_via_WHMCS_MarketConnect|Learn More...]]

=== User Identity Verification ===

Integrated services from Validation.com give your team additional tools to verify user authenticity. You can initiate the user validation process automatically when orders are flagged for fraud review, manually while reviewing orders, or on demand for specific users. User identity verification can work in tandem with your current fraud protection configuration or as a standalone integration.

You can activate user identity verification at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection'''.

[[User_Identity_Verification|Learn More...]]

=== Product Addons ===

You can now set up [[Prorata_Billing|prorated product addons]], syncing the addon's billing day with the parent product or service. You can now also quickly duplicate existing product addons.

[[Product_Addons#Pricing|Learn More...]]

=== Payment Gateway Balances and Transactions ===

In the Admin Area, the '''Transactions''' list now displays gateway balance information for your activated gateways that use our latest gateway module balance functionality. In WHMCS 8.2, that includes native support for Stripe and PayPal Basic.

Additionally, developers can now retrieve transaction details through gateway modules, with initial support for Stripe. For more information on updating payment gateway modules for this functionality, see our [https://developers.whmcs.com/payment-gateways/displaying-balances/ Developer Documentation].

[[Payment_Gateway_Balances_and_Transactions|Learn More...]]

=== Stripe Balance Widget ===

The Admin Area Dashboard now includes a new Stripe widget displaying your '''Available''' and '''Pending''' Stripe balances. This displays balances for each currency that is both configured in WHMCS and held with the gateway.

[[Stripe_Balance_Widget|Learn More...]]

=== Free Domain Reminders ===

The new '''Free Domain Reminders''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' allows you to send renewal notices for free domains (domains bundled with a paid product or service) using the same configuration as paid domain renewals. In the Client Area, users will see a message instead of the option to renew free domains at '''Domains > Renew Domains'''.

[[Free_Domains|Learn More...]]

== Deprecation and Removal Notices ==

=== Removed UK VAT Validation Settings ===

The HRMC UK VAT system no longer requires API credentials. Because of this, we have simplified VAT setup by removing the '''Client ID''' and '''Client Secret''' settings from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Tax Configuration'''.

=== Discontinued Worldpay Support ===

We have removed support for the Worldpay Invisible and Worldpay Invidible XML gateways.

== New Documentation ==

The following new documentation pages are available:

* [[Prorata Billing]]
* [[Web.com Site Builder via WHMCS MarketConnect]]
* [[Free Domains]]
* [[User Identity Verification]]
* [[UK VAT Validation]]

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the GitHub repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (GA):

https://github.com/WHMCS/templates-twenty-one/compare/v8.1.3-release.1...v8.2.0-release.1

=== Six Theme ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (GA):

https://github.com/WHMCS/templates-six/compare/v8.1.3-release.1...v8.2.0-release.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (GA):

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.1.3-release.1...v8.2.0-release.1

== Changelog ==
* [[Changelog:WHMCS_V8.2.0_Beta_1|Version 8.2.0 Beta 1]]
* [[Changelog:WHMCS_V8.2.0_RC_1|Version 8.2.0 RC 1]]
* [[Changelog:WHMCS_V8.2.0_GA|Version 8.2.0 GA]]

Version 8.2.0 Release Notes

2021-06-21T14:05:38Z

PeterB: /* Six Theme */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.2<br />
Release Type: RC<br />
Latest Update: 4th June 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.2.0</td><td>Beta 1</td><td>13th May 2021</td></tr>
<tr><td>8.2.0</td><td>Release Candidate 1</td><td>4th June 2021</td></tr>
<tr><td>8.2.0</td><td>General Availability</td><td>21st June 2021</td></tr>
</table>

==Download==

Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==

WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== WordPress Toolkit Automation ===

You can now easily offer WordPress® management tools using our integration with WordPress Toolkit for cPanel and Plesk using [[Product Addons]]. Features include a pre-made landing page, provisioning automation, SSO into the WP Toolkit interface and integrated upsells within the WP Toolkit user experience. Setup is made easier via another new feature, Predefined Addons, which provide one-click setup of WP Toolkit addons within WHMCS.

[[WordPress Toolkit|Learn More...]]

=== Addon Types and Predefined Addons ===

WHMCS now supports a new system of addon types, which includes Independent Products, the new name for the existing type of WHMCS addon, and '''Add-On Features''', which allow you to sell module-specific addons or features and automate provisioning through our existing addon system.

A selection of Predefined Addons is now available when you start the '''Add New Addon''' setup at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Product Addons'''. These Predefined Addons set all of the purpose-specific and common settings, leaving just the pricing for you to configure and save.

[[Product Addons|Learn More...]]

=== Web.com Site Builder ===

MarketConnect now allows you to offer Web.com Site Builder. This white-labeled website builder includes several plans, each competitively tailored to give the creative experience your customers need to grow their sites.

[[Web.com_Site_Builder_via_WHMCS_MarketConnect|Learn More...]]

=== User Identity Verification ===

Integrated services from Validation.com give your team additional tools to verify user authenticity. You can initiate the user validation process automatically when orders are flagged for fraud review, manually while reviewing orders, or on demand for specific users. User identity verification can work in tandem with your current fraud protection configuration or as a standalone integration.

You can activate user identity verification at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection'''.

[[User_Identity_Verification|Learn More...]]

=== Product Addons ===

You can now set up [[Prorata_Billing|prorated product addons]], syncing the addon's billing day with the parent product or service. You can now also quickly duplicate existing product addons.

[[Product_Addons#Pricing|Learn More...]]

=== Payment Gateway Balances and Transactions ===

In the Admin Area, the '''Transactions''' list now displays gateway balance information for your activated gateways that use our latest gateway module balance functionality. In WHMCS 8.2, that includes native support for Stripe and PayPal Basic.

Additionally, developers can now retrieve transaction details through gateway modules, with initial support for Stripe. For more information on updating payment gateway modules for this functionality, see our [https://developers.whmcs.com/payment-gateways/displaying-balances/ Developer Documentation].

[[Payment_Gateway_Balances_and_Transactions|Learn More...]]

=== Stripe Balance Widget ===

The Admin Area Dashboard now includes a new Stripe widget displaying your '''Available''' and '''Pending''' Stripe balances. This displays balances for each currency that is both configured in WHMCS and held with the gateway.

[[Stripe_Balance_Widget|Learn More...]]

=== Free Domain Reminders ===

The new '''Free Domain Reminders''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' allows you to send renewal notices for free domains (domains bundled with a paid product or service) using the same configuration as paid domain renewals. In the Client Area, users will see a message instead of the option to renew free domains at '''Domains > Renew Domains'''.

[[Free_Domains|Learn More...]]

== Deprecation and Removal Notices ==

=== Removed UK VAT Validation Settings ===

The HRMC UK VAT system no longer requires API credentials. Because of this, we have simplified VAT setup by removing the '''Client ID''' and '''Client Secret''' settings from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Tax Configuration'''.

=== Discontinued Worldpay Support ===

We have removed support for the Worldpay Invisible and Worldpay Invidible XML gateways.

== New Documentation ==

The following new documentation pages are available:

* [[Prorata Billing]]
* [[Web.com Site Builder via WHMCS MarketConnect]]
* [[Free Domains]]
* [[User Identity Verification]]
* [[UK VAT Validation]]

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the GitHub repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (GA):

https://github.com/WHMCS/templates-twenty-one/compare/v8.1.3-release.1...v8.2.0-release.1

=== Six Theme ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (GA):

https://github.com/WHMCS/templates-six/compare/v8.1.3-release.1...v8.2.0-release.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (RC):

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.1.3-release.1...v8.2.0-rc.1

== Changelog ==
* [[Changelog:WHMCS_V8.2.0_Beta_1|Version 8.2.0 Beta 1]]
* [[Changelog:WHMCS_V8.2.0_RC_1|Version 8.2.0 RC 1]]
* [[Changelog:WHMCS_V8.2.0_GA|Version 8.2.0 GA]]

Version 8.2.0 Release Notes

2021-06-21T14:05:26Z

PeterB: /* Twenty-One Theme */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.2<br />
Release Type: RC<br />
Latest Update: 4th June 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.2.0</td><td>Beta 1</td><td>13th May 2021</td></tr>
<tr><td>8.2.0</td><td>Release Candidate 1</td><td>4th June 2021</td></tr>
<tr><td>8.2.0</td><td>General Availability</td><td>21st June 2021</td></tr>
</table>

==Download==

Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==

WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== WordPress Toolkit Automation ===

You can now easily offer WordPress® management tools using our integration with WordPress Toolkit for cPanel and Plesk using [[Product Addons]]. Features include a pre-made landing page, provisioning automation, SSO into the WP Toolkit interface and integrated upsells within the WP Toolkit user experience. Setup is made easier via another new feature, Predefined Addons, which provide one-click setup of WP Toolkit addons within WHMCS.

[[WordPress Toolkit|Learn More...]]

=== Addon Types and Predefined Addons ===

WHMCS now supports a new system of addon types, which includes Independent Products, the new name for the existing type of WHMCS addon, and '''Add-On Features''', which allow you to sell module-specific addons or features and automate provisioning through our existing addon system.

A selection of Predefined Addons is now available when you start the '''Add New Addon''' setup at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Product Addons'''. These Predefined Addons set all of the purpose-specific and common settings, leaving just the pricing for you to configure and save.

[[Product Addons|Learn More...]]

=== Web.com Site Builder ===

MarketConnect now allows you to offer Web.com Site Builder. This white-labeled website builder includes several plans, each competitively tailored to give the creative experience your customers need to grow their sites.

[[Web.com_Site_Builder_via_WHMCS_MarketConnect|Learn More...]]

=== User Identity Verification ===

Integrated services from Validation.com give your team additional tools to verify user authenticity. You can initiate the user validation process automatically when orders are flagged for fraud review, manually while reviewing orders, or on demand for specific users. User identity verification can work in tandem with your current fraud protection configuration or as a standalone integration.

You can activate user identity verification at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection'''.

[[User_Identity_Verification|Learn More...]]

=== Product Addons ===

You can now set up [[Prorata_Billing|prorated product addons]], syncing the addon's billing day with the parent product or service. You can now also quickly duplicate existing product addons.

[[Product_Addons#Pricing|Learn More...]]

=== Payment Gateway Balances and Transactions ===

In the Admin Area, the '''Transactions''' list now displays gateway balance information for your activated gateways that use our latest gateway module balance functionality. In WHMCS 8.2, that includes native support for Stripe and PayPal Basic.

Additionally, developers can now retrieve transaction details through gateway modules, with initial support for Stripe. For more information on updating payment gateway modules for this functionality, see our [https://developers.whmcs.com/payment-gateways/displaying-balances/ Developer Documentation].

[[Payment_Gateway_Balances_and_Transactions|Learn More...]]

=== Stripe Balance Widget ===

The Admin Area Dashboard now includes a new Stripe widget displaying your '''Available''' and '''Pending''' Stripe balances. This displays balances for each currency that is both configured in WHMCS and held with the gateway.

[[Stripe_Balance_Widget|Learn More...]]

=== Free Domain Reminders ===

The new '''Free Domain Reminders''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' allows you to send renewal notices for free domains (domains bundled with a paid product or service) using the same configuration as paid domain renewals. In the Client Area, users will see a message instead of the option to renew free domains at '''Domains > Renew Domains'''.

[[Free_Domains|Learn More...]]

== Deprecation and Removal Notices ==

=== Removed UK VAT Validation Settings ===

The HRMC UK VAT system no longer requires API credentials. Because of this, we have simplified VAT setup by removing the '''Client ID''' and '''Client Secret''' settings from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Tax Configuration'''.

=== Discontinued Worldpay Support ===

We have removed support for the Worldpay Invisible and Worldpay Invidible XML gateways.

== New Documentation ==

The following new documentation pages are available:

* [[Prorata Billing]]
* [[Web.com Site Builder via WHMCS MarketConnect]]
* [[Free Domains]]
* [[User Identity Verification]]
* [[UK VAT Validation]]

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the GitHub repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (GA):

https://github.com/WHMCS/templates-twenty-one/compare/v8.1.3-release.1...v8.2.0-release.1

=== Six Theme ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (RC):

https://github.com/WHMCS/templates-six/compare/v8.1.3-release.1...v8.2.0-rc.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (RC):

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.1.3-release.1...v8.2.0-rc.1

== Changelog ==
* [[Changelog:WHMCS_V8.2.0_Beta_1|Version 8.2.0 Beta 1]]
* [[Changelog:WHMCS_V8.2.0_RC_1|Version 8.2.0 RC 1]]
* [[Changelog:WHMCS_V8.2.0_GA|Version 8.2.0 GA]]

Changelog:WHMCS V8.2

2021-06-21T14:04:36Z

PeterB:

=Version 8.2.0 (Beta 1)=
{{:Changelog:WHMCS_V8.2.0_Beta_1}}

=Version 8.2.0 (Release Candidate 1)=
{{:Changelog:WHMCS_V8.2.0_RC_1}}

=Version 8.2.0 (General Availability)=
{{:Changelog:WHMCS_V8.2.0_GA}}

Version 8.2.0 Release Notes

2021-06-21T14:03:57Z

PeterB: /* Changelog */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.2<br />
Release Type: RC<br />
Latest Update: 4th June 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.2.0</td><td>Beta 1</td><td>13th May 2021</td></tr>
<tr><td>8.2.0</td><td>Release Candidate 1</td><td>4th June 2021</td></tr>
<tr><td>8.2.0</td><td>General Availability</td><td>21st June 2021</td></tr>
</table>

==Download==

Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==

WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== WordPress Toolkit Automation ===

You can now easily offer WordPress® management tools using our integration with WordPress Toolkit for cPanel and Plesk using [[Product Addons]]. Features include a pre-made landing page, provisioning automation, SSO into the WP Toolkit interface and integrated upsells within the WP Toolkit user experience. Setup is made easier via another new feature, Predefined Addons, which provide one-click setup of WP Toolkit addons within WHMCS.

[[WordPress Toolkit|Learn More...]]

=== Addon Types and Predefined Addons ===

WHMCS now supports a new system of addon types, which includes Independent Products, the new name for the existing type of WHMCS addon, and '''Add-On Features''', which allow you to sell module-specific addons or features and automate provisioning through our existing addon system.

A selection of Predefined Addons is now available when you start the '''Add New Addon''' setup at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Product Addons'''. These Predefined Addons set all of the purpose-specific and common settings, leaving just the pricing for you to configure and save.

[[Product Addons|Learn More...]]

=== Web.com Site Builder ===

MarketConnect now allows you to offer Web.com Site Builder. This white-labeled website builder includes several plans, each competitively tailored to give the creative experience your customers need to grow their sites.

[[Web.com_Site_Builder_via_WHMCS_MarketConnect|Learn More...]]

=== User Identity Verification ===

Integrated services from Validation.com give your team additional tools to verify user authenticity. You can initiate the user validation process automatically when orders are flagged for fraud review, manually while reviewing orders, or on demand for specific users. User identity verification can work in tandem with your current fraud protection configuration or as a standalone integration.

You can activate user identity verification at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection'''.

[[User_Identity_Verification|Learn More...]]

=== Product Addons ===

You can now set up [[Prorata_Billing|prorated product addons]], syncing the addon's billing day with the parent product or service. You can now also quickly duplicate existing product addons.

[[Product_Addons#Pricing|Learn More...]]

=== Payment Gateway Balances and Transactions ===

In the Admin Area, the '''Transactions''' list now displays gateway balance information for your activated gateways that use our latest gateway module balance functionality. In WHMCS 8.2, that includes native support for Stripe and PayPal Basic.

Additionally, developers can now retrieve transaction details through gateway modules, with initial support for Stripe. For more information on updating payment gateway modules for this functionality, see our [https://developers.whmcs.com/payment-gateways/displaying-balances/ Developer Documentation].

[[Payment_Gateway_Balances_and_Transactions|Learn More...]]

=== Stripe Balance Widget ===

The Admin Area Dashboard now includes a new Stripe widget displaying your '''Available''' and '''Pending''' Stripe balances. This displays balances for each currency that is both configured in WHMCS and held with the gateway.

[[Stripe_Balance_Widget|Learn More...]]

=== Free Domain Reminders ===

The new '''Free Domain Reminders''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' allows you to send renewal notices for free domains (domains bundled with a paid product or service) using the same configuration as paid domain renewals. In the Client Area, users will see a message instead of the option to renew free domains at '''Domains > Renew Domains'''.

[[Free_Domains|Learn More...]]

== Deprecation and Removal Notices ==

=== Removed UK VAT Validation Settings ===

The HRMC UK VAT system no longer requires API credentials. Because of this, we have simplified VAT setup by removing the '''Client ID''' and '''Client Secret''' settings from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Tax Configuration'''.

=== Discontinued Worldpay Support ===

We have removed support for the Worldpay Invisible and Worldpay Invidible XML gateways.

== New Documentation ==

The following new documentation pages are available:

* [[Prorata Billing]]
* [[Web.com Site Builder via WHMCS MarketConnect]]
* [[Free Domains]]
* [[User Identity Verification]]
* [[UK VAT Validation]]

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the GitHub repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (RC):

https://github.com/WHMCS/templates-twenty-one/compare/v8.1.3-release.1...v8.2.0-rc.1

=== Six Theme ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (RC):

https://github.com/WHMCS/templates-six/compare/v8.1.3-release.1...v8.2.0-rc.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (RC):

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.1.3-release.1...v8.2.0-rc.1

== Changelog ==
* [[Changelog:WHMCS_V8.2.0_Beta_1|Version 8.2.0 Beta 1]]
* [[Changelog:WHMCS_V8.2.0_RC_1|Version 8.2.0 RC 1]]
* [[Changelog:WHMCS_V8.2.0_GA|Version 8.2.0 GA]]

Version 8.2.0 Release Notes

2021-06-21T14:03:34Z

PeterB: /* Version History */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.2<br />
Release Type: RC<br />
Latest Update: 4th June 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.2.0</td><td>Beta 1</td><td>13th May 2021</td></tr>
<tr><td>8.2.0</td><td>Release Candidate 1</td><td>4th June 2021</td></tr>
<tr><td>8.2.0</td><td>General Availability</td><td>21st June 2021</td></tr>
</table>

==Download==

Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==

WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== WordPress Toolkit Automation ===

You can now easily offer WordPress® management tools using our integration with WordPress Toolkit for cPanel and Plesk using [[Product Addons]]. Features include a pre-made landing page, provisioning automation, SSO into the WP Toolkit interface and integrated upsells within the WP Toolkit user experience. Setup is made easier via another new feature, Predefined Addons, which provide one-click setup of WP Toolkit addons within WHMCS.

[[WordPress Toolkit|Learn More...]]

=== Addon Types and Predefined Addons ===

WHMCS now supports a new system of addon types, which includes Independent Products, the new name for the existing type of WHMCS addon, and '''Add-On Features''', which allow you to sell module-specific addons or features and automate provisioning through our existing addon system.

A selection of Predefined Addons is now available when you start the '''Add New Addon''' setup at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Product Addons'''. These Predefined Addons set all of the purpose-specific and common settings, leaving just the pricing for you to configure and save.

[[Product Addons|Learn More...]]

=== Web.com Site Builder ===

MarketConnect now allows you to offer Web.com Site Builder. This white-labeled website builder includes several plans, each competitively tailored to give the creative experience your customers need to grow their sites.

[[Web.com_Site_Builder_via_WHMCS_MarketConnect|Learn More...]]

=== User Identity Verification ===

Integrated services from Validation.com give your team additional tools to verify user authenticity. You can initiate the user validation process automatically when orders are flagged for fraud review, manually while reviewing orders, or on demand for specific users. User identity verification can work in tandem with your current fraud protection configuration or as a standalone integration.

You can activate user identity verification at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection'''.

[[User_Identity_Verification|Learn More...]]

=== Product Addons ===

You can now set up [[Prorata_Billing|prorated product addons]], syncing the addon's billing day with the parent product or service. You can now also quickly duplicate existing product addons.

[[Product_Addons#Pricing|Learn More...]]

=== Payment Gateway Balances and Transactions ===

In the Admin Area, the '''Transactions''' list now displays gateway balance information for your activated gateways that use our latest gateway module balance functionality. In WHMCS 8.2, that includes native support for Stripe and PayPal Basic.

Additionally, developers can now retrieve transaction details through gateway modules, with initial support for Stripe. For more information on updating payment gateway modules for this functionality, see our [https://developers.whmcs.com/payment-gateways/displaying-balances/ Developer Documentation].

[[Payment_Gateway_Balances_and_Transactions|Learn More...]]

=== Stripe Balance Widget ===

The Admin Area Dashboard now includes a new Stripe widget displaying your '''Available''' and '''Pending''' Stripe balances. This displays balances for each currency that is both configured in WHMCS and held with the gateway.

[[Stripe_Balance_Widget|Learn More...]]

=== Free Domain Reminders ===

The new '''Free Domain Reminders''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' allows you to send renewal notices for free domains (domains bundled with a paid product or service) using the same configuration as paid domain renewals. In the Client Area, users will see a message instead of the option to renew free domains at '''Domains > Renew Domains'''.

[[Free_Domains|Learn More...]]

== Deprecation and Removal Notices ==

=== Removed UK VAT Validation Settings ===

The HRMC UK VAT system no longer requires API credentials. Because of this, we have simplified VAT setup by removing the '''Client ID''' and '''Client Secret''' settings from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Tax Configuration'''.

=== Discontinued Worldpay Support ===

We have removed support for the Worldpay Invisible and Worldpay Invidible XML gateways.

== New Documentation ==

The following new documentation pages are available:

* [[Prorata Billing]]
* [[Web.com Site Builder via WHMCS MarketConnect]]
* [[Free Domains]]
* [[User Identity Verification]]
* [[UK VAT Validation]]

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the GitHub repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (RC):

https://github.com/WHMCS/templates-twenty-one/compare/v8.1.3-release.1...v8.2.0-rc.1

=== Six Theme ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (RC):

https://github.com/WHMCS/templates-six/compare/v8.1.3-release.1...v8.2.0-rc.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (RC):

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.1.3-release.1...v8.2.0-rc.1

== Changelog ==
* [[Changelog:WHMCS_V8.2.0_Beta_1|Version 8.2.0 Beta 1]]
* [[Changelog:WHMCS_V8.2.0_RC_1|Version 8.2.0 RC 1]]

CPanel/WHM

2021-06-04T16:17:30Z

PeterB:

{{Provisioning_Module
| changepackage = Yes
| changepw = Yes
| usageupdates = Yes
| clientarealink = Yes
| port = 2086 & 2087}}

== Adding a cPanel & WHM Server ==

The following steps guide you through the process of setting up a cPanel & WHM server in WHMCS for cPanel Hosting Accounts.

# You need to begin by creating a Server for your cPanel products to be assigned to in WHMCS.
# To do this navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers''' and click on '''Add New Server'''
# Enter the server name, IP address, select the server type "cpanel" from the dropdown menu.
# Enter your WHM username into the username field.[[File:Whm_api_setup.png|thumb|WHM API Setup]]
# Log in to WHM and navigate to '''Development >> Manage API Tokens'''.
# Click ''Generate Token''.
# Enter a name for your token, such as "WHMCS".
## For assistance configuring the WHM API token privileges, see our [[#API_Token_Permissions|API Token Permissions]] section below.
# Click Save and copy your API Token.
# Return to the WHMCS server configuration page and paste the newly generated API Token into the corresponding field..
# Ticking the SSL Mode checkbox is also recommended, but all other fields are optional.
# The default port will be displayed. If your server is configured to communicate on a different port, tick the '''Override with Custom Port''' checkbox and enter it into the Port field. For more information refer to [[Server Port Overrides]].
#Click Create Server to complete the process and add your new cPanel Server.
#If this is the only cPanel server listed afterwards, click on the name and ensure it results in an asterisk (*) next to it. This ensures it is the default and used when any other non-specific configuration (server groups) doesn't apply.

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> If 2FA is enabled on your cPanel server, you must disable it for API requests. [[CPanel/WHM#Disable_2FA_for_cPanel_API|Click here for more information]].</div>

== Setting Up a cPanel Package ==
<html><a href="https://www.youtube.com/watch?v=0lqzsTSUGw0&hd=1" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span> <img src="https://assets.whmcs.com/icons/youtube.png"> </span></a></html>

[[File:cpanel2.png|thumb|cPanel Module Settings]][[File:cpanel3.png|thumb|Adding a Package in WHM]]
To setup a cPanel package, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''. From there, you can create the product and configure the general settings and pricing info as normal. When it comes to the Module Settings tab, select "cpanel" in the module dropdown field and then for a shared hosting package:

====Simple Mode====

'''<i class="fa fa-info-circle"></i> This section describes a feature available in version 7.0 and above'''

# A list of the available packages configured in WHM will be populated into the '''WHM Package Name''' field.
# Select the package you wish to be created when this product is ordered
# And then finally as with all products you have the option of choosing the automatic setup option you want for new orders, be it immediately as soon as the order is placed, as soon as the initial payment has been received (recommended) or waiting until an admin manually reviews & accepts the pending orders
# Click Save Changes

====Advanced Mode====
[[File:Cpanel advanced.png|thumb|Advanced Mode]]

There is also the option to define custom packages - you can do that by clicking the '''Switch to Advanced Mode''' link. Advanced mode presents various options to customise the way the hosting account is created on the cPanel server. One of the possible configurations allows for quotas to be specified on a per-account basis rather than at a per-package level (You will need root access for this to work). To achieve this:

# Leave the WHM Package Name field empty
# Enter vales in the Web Space Quota and Bandwidth Limit fields.
# Define the individual limits into the fields the module settings page. If a field is left blank, WHMCS will not send a value to cPanel which will result in a quota being set to unlimited for that item.
# Max Addon Domains is the last field that applies to shared hosting accounts in the list.

===For a reseller package===
[[File:cpanel4.png|thumb|Creating an ACL List]][[File:cpanel5.png|thumb|cPanel Reseller Module Settings]]
#Set the settings for the resellers own hosting account as above with one difference, the '''Product Type''' setting must be Reseller Account.
#The fields from "Limit Reseller by Number" onwards specify reseller settings so from there you can set the resellers limits by number or disk space, these are explained below.
#The Reseller ACL List is required and defines what features inside WHM the reseller is allowed to use. To setup an ACL list, WHM doesn't offer a way without setting up a reseller so inside WHM go to the '''Reseller Center''' and activate a domain as a reseller, then proceed to the '''Edit reseller privileges & nameservers''' page and enter a name to save the feature selections before saving.

*Limit Reseller by Number - Specifies the maximum number of cPanel accounts the reseller can create or...
*Limit Reseller by Usage - Alternately limit the disk space and bandwidth the reseller has to assign to their customers using the following two options
*Reseller Disk Space - The disk space the reseller has to share amongst their accounts
*Reseller Bandwidth - The bandwidth the reseller has to share amongst their accounts
* Allow DS Overselling - Tick to allow resellers to assign more disk space to accounts than they actually have
* Allow BW Overselling - Tick to allow resellers to assign more bandwidth to accounts than they actually have
*Reseller ACL List - See below
*Configure Nameservers - Tick this option to give the reseller their own nameservers based upon their domain name instead of using your nameservers. Ie.
ns1.resellerdomain.com, ns2.resellerdomain.com
instead of
ns1.yourcompany.com. ns2.yourcompany.com

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> Per RFC-2832, custom nameservers must be registered. This is done from your Domain Registrar prior to configuration of the nameservers within cPanel.</div>

*Reseller Ownership - When ticked the reseller will own their own account. A package doesn't necessarily need to be setup, but you would need to define some limits for the client account created, perhaps 1MB disk and bandwidth so the client then changes their account to one of their own packages.

====Per Account Billing====

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This section describes a feature available in version 7.9 and above.</div>

You can bill resellers for the number of cPanel accounts they provision. You can choose whether to include a certain number of cPanel accounts in the price and only charge for exceeding a certain limit, offer tiered pricing, or charge for every cPanel account resellers create.

<div class="docs-alert-info">
We recommend only offering cPanel account usage billing on products with a monthly billing cycle.
</div>

[[File:Cpanel usage billing.png|thumb|Enable Usage Billing]]

To use this feature:
# Toggle the '''Sub-Accounts''' billing metric to '''On'''. (Do not confuse this with cPanel Subaccounts, which cPanel accounts can create within cPanel.)
# Click the '''Configure Pricing''' link to set the pricing for the accounts the reseller consumes.
# Click '''Save'''.

When a client orders this product, WHMCS will track the number of cPanel accounts that the reseller creates.
On the service's '''Next Due Date''', the system records the current number of created cPanel accounts and adds the cost to the service's renewal invoice.

A guide with pricing examples [https://help.whmcs.com/m/setup/l/1185956-billing-resellers-per-domain is available here].

Usage Billing is a powerful feature. For more information on the terms and possible configurations, see [[Usage_Billing|Usage Billing]].

===Other Options===
*Add Prefix to Package - Add the username_ prefix to the package name when the account is created on the server. This is useful when using multiple servers with the same package name, but different username.

==Notes==
===Login to cPanel Link===
The login to cPanel link displayed in the '''client area''' is based upon the server hostname if available, if not, the IP address will be used. The usage of http and https login links depends upon the state of the "Secure" checkbox in the server configuration eg. When ticked, the https link with port 2083 is used.

The login to control panel link displayed in the '''admin area''' is based upon the server hostname if available, if not, the IP address will be used. The usage of http and https login links depends upon the state of the "Secure" checkbox in the server configuration eg. When ticked, the https link with port 2087 is used. It uses the xfercpanel function, so when prompted, enter your WHM login details (not the client's cPanel details) and you will be logged into the client's account with reseller privileges.

===Reseller Usage Calculation===
Reseller usage limits and reporting is based on the behaviour of WHM's design & implementation of a "Reseller" account type. Most notably, resellers owned by root will not have their own usage aggregated into such boundary calculations.

===WHMCS Connect===
WHMCS Connect allows you and your administrators to quickly and easily access the control panels of all the servers configured in your WHMCS installation that support Single Sign-On, enabling you and your staff to administer and make changes without ever needing to re-authenticate.

For information on the benefits of WHMCS Connect and how to configure this functionality [[WHMCS_Connect|refer to this page]].

===API Token Permissions===
With API Tokens for cPanel & WHM, it is possible to restrict what actions an API Token can perform. For WHMCS to be able to perform all the operations it supports, the following permissions must be granted in WHM at '''Development >> Manage API Tokens'''.
<table class="table table-striped">
<tr>
<td>basic-whm-functions</td>
<td>basic-system-info</td>
<td>cpanel-api</td>
</tr>
<tr>
<td>create-acct</td>
<td>create-user-session</td>
<td>suspend-acct</td>
</tr>
<tr>
<td>upgrade-acct</td>
<td>kill-acct</td>
<td>passwd</td>
</tr>
<tr>
<td>acct-summary</td>
<td>list-accts</td>
<td>show-bandwidth</td>
</tr>
<tr>
<td>cpanel-integration</td>
<td>list-pkgs</td>
<td>ns-config</td>
</tr>
<tr>
<td>edit-mx</td>
<td>manage-api-tokens</td>
<td>ssl-gencrt</td>
</tr>
</table>

When using the Configurable Package Addon, the "edit-account" permission will need to be enabled.
<div class="docs-alert-info">
<span class="title">Note for Reseller Accounts</span><br />
For reseller products, the "Everything" permission needs to be enabled as the reseller API functions on a cPanel server require root access to work.
</div>

===Keep DNS Zone on Termination===
When terminating a cPanel & WHM account via the WHMCS admin area, an option is provided to "Keep DNS Zone".

Selecting this option will terminate the account on a cPanel & WHM server while preserving the DNS Zone Record. Use this option where you wish to terminate the account but preserve the DNS records. Common use cases for this include scenarios such as account migration where DNS forwarding is being used.

<div class="docs-alert-warning">'''Please Note:''' You will not be able to re-create a new account on the server using the same domain while a DNS Zone exists for it. Attempting to provision the domain again will result in an error and you must delete the DNS Zone to be able to successfully provision a new account.</div>

===Disable 2FA for cPanel API===
For the cPanel module to function when 2FA is enabled for your account, you must ensure that the 2FA requirement is disabled for API requests.

To facilitate this:

# Log in to WHM as root
# Navigate to '''Security Center > Configure Security Policies'''
# Uncheck ''API requests'' and click '''Save'''

===Add-On Features===

In WHMCS 8.2 and later, in addition to WHMCS's existing product addon functionality (now an '''Independent Product'''), you can create an '''Add-On Feature'''. These addons let you sell module-specific features like WordPress® Toolkit offerings available through both cPanel and Plesk.

For more information and steps to create an addon, see [[Product Addons]].

==Common Problems==

===Access Denied===
An Access Denied error indicates that the cPanel server denied WHMCS access to perform the requested action (eg. create or modify the account). To investigate and resolve, ensure that:

#The server settings configured in WHMCS are valid
#The API credentials have the required permissions to perform the desired action
#The ''Username'' and ''Server'' assignment under the client's Products/Services tab in WHMCS match exactly with the account records in cPanel
#The user specified on the server settings page is has sufficient permissions to manage the cPanel hosting account in question

To check points 1 and 2, begin by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers'''.
Edit the server in question, and ensure the Username and API Token are valid and match those currently configured in WHM.
Refer to [[#Adding_a_cPanel_.26_WHM_Server]] above for more detailed instructions

Ensure all the required permissions have been granted to the cPanel API token, these are itemised in the [[#API_Token_Permissions]] section above

<div class="docs-alert-success">
<span class="title">Tip</span><br />
Use the ''Test Connection'' button to confirm access granted.
</div>

===You do not have permission to use Selected Package===
If you receive this error when trying to create an account then you need to correct the Packages Name setting. To do this, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Edit > Module Settings''' on the package where you are receiving the error. Where it asks for the WHM Package Name, you must enter this exactly as it appears in WHM - which should be in the format username_packagename.

===Package Not Allowed or Exceeded Resource/Account Allocation===
This error most likely means you only have reseller access to your server and are trying to create an account without a valid package name. You need to make sure the WHM Package Name in the product configuration of WHMCS matches exactly what is setup in your WHM Package Editor.

===Resellers are not permitted to create subdomains of the server's main domain===
This means no domain has been selected and is missing. Ensure the product has a domain name entered. You may need to enable Require Domain in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Product/Services'''.

===Unable to validate setting for language: english===
cPanel & WHM have made a number of changes to their API in the latest versions that are not backwards compatible. Therefore it is no longer possible to use an old version of WHMCS with the latest version of cPanel. You will need to upgrade your WHMCS install to version 4.2.1 or above.

===Sorry, that username is reserved===
cPanel & WHM does not allow usernames to contain the phrase "test" amongst others, so when this error occurs, simply change the username under the client's products/services tab and run the Create Module Command again.

===Sorry, a group for that username already exists===
An account with this username already exists on the server. This error can occur on shared servers even when you do not have an account with this username under your reseller account another reseller on the same server may be using it already.

To resolve, navigate to the client's Products/Services tab, change the Username, click Save Changes and finally click the "Create" Module Command button.

===Login Failed===
There are two possible causes for this error:

# The login details under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers > Edit''' are incorrect. Please ensure you are using either the username and API Key or the username and password combination and that the login details are correct.
# The Brute Force Protection settings are preventing WHMCS from creating/suspending/terminating accounts via the cPanel API. Please adjust the BFP settings in WHM.

===No user name supplied: "username" is a required argument===
This means the username under the client's Products/Services tab is empty.

You should enter a username, save changes and try module creation again. Also ensure that '''Require Domains''' is checked in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.

===Action Failed Unable to auto-login. Please contact support===
This error also means the username under the client's Products/Services tab is empty.

You should enter a username, save changes and try module creation again. Also ensure that '''Require Domains''' is checked in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.

=== WHM Username is missing for the selected server===
Seeing this error when attempting to provision a hosting account is caused by a server balancing misconfiguration. Ie. no server is selected upon which the account should be created. For troubleshooting steps for this particular issue, [[Provisioning_Issues#Server_Command_Error_-_Curl_Error_-_Couldn.27t_resolve_host_.286.29|please refer to this article]]

===An Unknown Error Occurred after updating to cPanel 74===
After updating to cPanel 74, every module command performed results in a "An unknown error occurred" message. Inspecting the [[Troubleshooting_Module_Problems|Module Debug Log]] reveals that a WHM 404 error page is being returned by the server.

This is caused by the [https://blog.cpanel.com/march-2017-development-update deprecation of the cPanel XML API] in version 74. To use the newer cPanel JSON API, it is necessary to [[Updating|update]] to WHMCS 7.3 or above.

===WHM Package not shown in Module dropdown list when editing product===

The cPanel API only returns packages available to provision under the reseller's WHM account. This often means packages may not show in this list if it would exceed the reseller's allowances on their WHM account.

Confirm this diagnosis by following these steps:
# [[File:Whm_packages_list_limits.png|thumb|cPanel Package Limits]]Login to WHM and navigate to '''Account Functions » Create a New Account'''
# Select the desired package from the ''Choose a Package'' dropdown
# Observe the package name is suffixed by the note "Cannot use due to limits"

There are two ways to resolve this issue:
# Ensure the WHM account has sufficient allowances to provision desired WHM package when configuring in WHMCS
# Enable overselling on the reseller account (requires WHM root access) - You can learn more about overselling in WHM in the [https://docs.cpanel.net/knowledge-base/cpanel-product/overselling/| cPanel docs here]

===Product attribute Package Name "Package Name" not found on server===
There are two possible causes of this error:
* [[#Package Not Allowed or Exceeded Resource/Account Allocation|Package name must be entered exactly as defined in WHM]]
* [[#WHM Package not shown in Module dropdown list when editing product|Insufficient resources to create the package]]

{{modules}}

Version 8.2.0 Release Notes

2021-06-04T15:59:07Z

PeterB:

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.2<br />
Release Type: RC<br />
Latest Update: 4th June 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.2.0</td><td>Beta 1</td><td>13th May 2021</td></tr>
<tr><td>8.2.0</td><td>Release Candidate 1</td><td>4th June 2021</td></tr>
</table>

==Download==

Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==

WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== WordPress Toolkit Integration ===

You can now easily offer premiere WordPress® management tools using our integration with WordPress Toolkit for cPanel and Plesk using [[Product Addons]]. Begin offering this with just a few clicks, growing your revenue potential from new and existing clients.

[[WordPress Toolkit|Learn More...]]

=== Addon Types and Predefined Addons ===

WHMCS now supports a new system of addon types, which includes Independent Products, the new name for the existing type of WHMCS addon, and '''Add-On Features''', which allow you to sell module-specific addons or features and automate provisioning through our existing addon system.

A selection of Predefined Addons is now available when you start the '''Add New Addon''' setup at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Product Addons'''. These Predefined Addons set all of the purpose-specific and common settings, leaving just the pricing for you to configure and save.

[[Product Addons|Learn More...]]

=== Web.com Site Builder ===

MarketConnect now allows you to offer Web.com Site Builder. This white-labeled website builder includes several plans, each competitively tailored to give the creative experience your customers need to grow their sites.

[[Web.com_Site_Builder_via_WHMCS_MarketConnect|Learn More...]]

=== User Identity Verification ===

Integrated services from Validation.com give your team additional tools to verify user authenticity. You can initiate the user validation process automatically when orders are flagged for fraud review, manually while reviewing orders, or on demand for specific users. User identity verification can work in tandem with your current fraud protection configuration or as a standalone integration.

You can activate user identity verification at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection'''.

[[User_Identity_Verification|Learn More...]]

=== Product Addons ===

You can now set up [[Prorata_Billing|prorated product addons]], syncing the addon's billing day with the parent product or service. You can now also quickly duplicate existing product addons.

[[Product_Addons#Pricing|Learn More...]]

=== Payment Gateway Balances and Transactions ===

In the Admin Area, the '''Transactions''' list now displays gateway balance information for your activated gateways that use our latest gateway module balance functionality. In WHMCS 8.2, that includes native support for Stripe and PayPal Basic.

Additionally, developers can now retrieve transaction details through gateway modules, with initial support for Stripe. For more information on updating payment gateway modules for this functionality, see our [https://developers.whmcs.com/payment-gateways/displaying-balances/ Developer Documentation].

[[Payment_Gateway_Balances_and_Transactions|Learn More...]]

=== Stripe Balance Widget ===

The Admin Area Dashboard now includes a new Stripe widget displaying your '''Available''' and '''Pending''' Stripe balances. This displays balances for each currency that is both configured in WHMCS and held with the gateway.

[[Stripe_Balance_Widget|Learn More...]]

=== Free Domain Reminders ===

The new '''Free Domain Reminders''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' allows you to send renewal notices for free domains (domains bundled with a paid product or service) using the same configuration as paid domain renewals. In the Client Area, users will see a message instead of the option to renew free domains at '''Domains > Renew Domains'''.

[[Free_Domains|Learn More...]]

== Deprecation and Removal Notices ==

=== Removed UK VAT Validation Settings ===

The HRMC UK VAT system no longer requires API credentials. Because of this, we have simplified VAT setup by removing the '''Client ID''' and '''Client Secret''' settings from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Tax Configuration'''.

=== Discontinued Worldpay Support ===

We have removed support for the Worldpay Invisible and Worldpay Invidible XML gateways.

== New Documentation ==

The following new documentation pages are available:

* [[Prorata Billing]]
* [[Web.com Site Builder via WHMCS MarketConnect]]
* [[Free Domains]]
* [[User Identity Verification]]
* [[UK VAT Validation]]

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the GitHub repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (RC):

https://github.com/WHMCS/templates-twenty-one/compare/v8.1.3-release.1...v8.2.0-rc.1

=== Six Theme ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (RC):

https://github.com/WHMCS/templates-six/compare/v8.1.3-release.1...v8.2.0-rc.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (RC):

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.1.3-release.1...v8.2.0-rc.1

== Changelog ==
* [[Changelog:WHMCS_V8.2.0_Beta_1|Version 8.2.0 Beta 1]]
* [[Changelog:WHMCS_V8.2.0_RC_1|Version 8.2.0 RC 1]]

System Health Status

2021-06-04T15:51:34Z

PeterB: /* The Checks */

The '''System Health Status''' page provides an overview of the WHMCS installation and system environment status. This can be found under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Health'''

It will highlight any potential configuration or security related issues that may need your attention.

It also allows you to check if any updates are available for your currently installed WHMCS version, as well as providing quick and easy access to the Changelog and Release Notes for it.

==The Checks==

[[File:SystemHealthStatusPage.png|thumb|System Health Status Page]]An overview of the checks performed and the purpose of each is provided below.

'''System Cron Tasks'''

Checks that the system cron has run to completion within the last 24 hours. If this reports a failure, it indicates that either the cron is not running (invalid cron command, file permissions, cron folder path, etc.) or that the cron is failing to complete successfully.

If this check reports a problem, you should begin by checking your cron command configuration and the activity log within WHMCS. Further helpful documentation regarding this check can be found [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#system_cron_tasks here]

For further assistance, please contact our support team.

'''Cron PHP Version Mismatch'''

Many server configurations utilize a separate php.ini file in the command line or cron engine than the web server uses. This can sometimes cause issues when different configurations are used in two places.

This warning identifies if automation tasks are being executed under different PHP versions to that being used to visit the admin area via a browser.

Please [https://help.whmcs.com/m/automation/l/969680-identifying-the-php-ini-used-for-in-command-line-cron-engine review this guide] for step-by-step instructions to resolve this situation on a stock cPanel server.

Otherwise contact your server admin/hosting provider for assistance.

<div class="docs-alert-info">
The result of this check are cached so the warning may not disappear immediately after making the necessary changes to resolve the issue and will only update after the Daily Cron tasks have been executed.
</div>

'''Insecure Permissions Check'''

Ensures that key files and directories have appropriate permissions. Will alert you to ownership mismatches and/or permission levels that are higher than required for day-to-day operation of the system.

Please see this [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#permissions_check help guide] for more information.

'''Required PHP Extensions'''

Checks for any PHP extensions required by WHMCS to operate and will alert you to any that are missing. Should any be reported as missing, you should recompile PHP with the missing extensions included, as detailed [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#required_php_extensions here]

'''Recommended PHP Extensions'''

Checks for the presence of recommended PHP extensions. While not strictly required, this will alert you to any extensions which are not available in your environment that are either required by certain addons/modules or that can help provide improved performance. Detailed in our help guide [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#recommended_php_extensions here] we recommend recompiling PHP with the missing extensions listed.

'''Required PHP Functions'''

Checks for any PHP functions that are required for WHMCS to operate and will alert you to any that are disabled. If you see any functions reported here, you should check for the presence of them in the ''php.ini'' configuration file '''disable_functions''' setting and remove them.

'''PHP Memory Limit'''

Checks the memory limit setting in your PHP environment and will alert you when it is too low. Will alert you by way of a failure level alert when below the minimum required value and a warning level alert when above the minimum but below the recommended value. For more details on the required memory limit, please refer to the [[System Requirements]] page.

'''Error Reporting'''

Alerts you if error reporting is enabled in your environment. While useful for development and debugging situations, in production, we strongly recommend having error reporting disabled for security reasons.

'''PHP Error Levels'''

Alerts you if the error reporting level is set to a very high level. We recommend only logging certain error types, as detailed [https://help.whmcs.com/m/troubleshooting/l/757222-resolving-attention-items-on-the-system-health-status-page#display_errors here]

'''PHP Version'''

Checks your PHP Version. Will alert you if your current PHP version has reached End of Life and is no longer supported by the PHP Group.

'''Customising Default Paths'''

Checks for the existance of custom directory paths. You can customise some of the default directory paths in WHMCS to make it more difficult for malicious users to find them. This check will alert you if any directories that support customisation have not been customised. Please see [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#custom_templates this] helpful documentation about this.

'''Using Default Templates'''

Alerts you if any template settings are set to a template of a default name which could be an indication of customisations having been made to a default template. This can result in customisations being lost at the time of the next upgrade. Please see [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#custom_templates this] helpful documentation about this.

'''Installed cURL Version'''

Checks the installed curl version and alerts you if your version is known to have any vulnerabilities. More information available [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#curl_tls_openssl_version_warnings here]

'''SSL Support in cURL'''

Checks to ensure that the curl library present in the PHP environment has SSL support which is required for normal WHMCS operation and many of the modules which come with WHMCS.

'''PHP Session Support'''

Alerts you to any issues with the PHP Session configuration in your PHP environment, please see both [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#the_php_session_save_path_is_not_writeable this] documentation and [https://help.whmcs.com/m/troubleshooting/l/690502-resolving-warnings-on-the-system-health-status-page#the_php_session_save_path_is_not_writeable this] for more information.

'''Secure TLS Support in cURL'''

Checks to ensure that the curl library present in the PHP environment supports secure TLS versions (TLS v1.1 and v1.2). With many payment vendors phasing out legacy SSL/TLS protocols in accordance with PCI DSS recommendations, this check will help to stay up to date with newer standards.

'''CloudLinux™ MySQL Extension Check'''

<div class="docs-alert-info">
We added this check in WHMCS 8.2.
</div>

The CloudLinux-provided <tt>pdo_mysql</tt> PHP extension can cause problems with data display in the WHMCS interface. Instead, CloudLinux users should use the <tt>nd_pdo_mysql</tt> extension.

This check only applies to CloudLinux users.

For help to resolve this problem, see CloudLinux's [https://docs.cloudlinux.com/lve_manager/#php-selector-client-plugin PHP Selector documentation] or contact your server administrator.

Version 8.2.0 Release Notes

2021-06-04T15:10:19Z

PeterB: /* Version History */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.2<br />
Release Type: Beta<br />
Latest Update: 13th May 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.2.0</td><td>Beta 1</td><td>13th May 2021</td></tr>
<tr><td>8.2.0</td><td>Release Candidate 1</td><td>4th June 2021</td></tr>
</table>

==Download==

Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==

WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== Web.com Site Builder ===

MarketConnect now allows you to offer Web.com Site Builder. This white-labeled website builder includes several plans, each competitively tailored to give the creative experience your customers need to grow their sites.

[[Web.com_Site_Builder_via_WHMCS_MarketConnect|Learn More...]]

=== User Identity Verification ===

Integrated services from Validation.com give your team additional tools to verify user authenticity. You can initiate the user validation process automatically when orders are flagged for fraud review, manually while reviewing orders, or on demand for specific users. User identity verification can work in tandem with your current fraud protection configuration or as a standalone integration.

You can activate user identity verification at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection'''.

[[User_Identity_Verification|Learn More...]]

=== Product Addons ===

You can now set up [[Prorata_Billing|prorated product addons]], syncing the addon's billing day with the parent product or service. You can now also quickly duplicate existing product addons.

[[Product_Addons#Pricing|Learn More...]]

=== Payment Gateway Balances and Transactions ===

In the Admin Area, the '''Transactions''' list now displays gateway balance information for your activated gateways that use our latest gateway module balance functionality. In WHMCS 8.2, that includes native support for Stripe and PayPal Basic.

Additionally, developers can now retrieve transaction details through gateway modules, with initial support for Stripe. For more information on updating payment gateway modules for this functionality, see our [https://developers.whmcs.com/payment-gateways/displaying-balances/ Developer Documentation].

[[Payment_Gateway_Balances_and_Transactions|Learn More...]]

=== Stripe Balance Widget ===

The Admin Area Dashboard now includes a new Stripe widget displaying your '''Available''' and '''Pending''' Stripe balances. This displays balances for each currency that is both configured in WHMCS and held with the gateway.

[[Stripe_Balance_Widget|Learn More...]]

=== Free Domain Reminders ===

The new '''Free Domain Reminders''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' allows you to send renewal notices for free domains (domains bundled with a paid product or service) using the same configuration as paid domain renewals. In the Client Area, users will see a message instead of the option to renew free domains at '''Domains > Renew Domains'''.

[[Free_Domains|Learn More...]]

== Deprecation and Removal Notices ==

=== Removed UK VAT Validation Settings ===

The HRMC UK VAT system no longer requires API credentials. Because of this, we have simplified VAT setup by removing the '''Client ID''' and '''Client Secret''' settings from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Tax Configuration'''.

=== Discontinued Worldpay Support ===

We have removed support for the Worldpay Invisible and Worldpay Invidible XML gateways.

== New Documentation ==

The following new documentation pages are available:

* [[Prorata Billing]]
* [[Web.com Site Builder via WHMCS MarketConnect]]
* [[Free Domains]]
* [[User Identity Verification]]
* [[UK VAT Validation]]

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the GitHub repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (Beta):

https://github.com/WHMCS/templates-twenty-one/compare/v8.1.3-release.1...v8.2.0-beta.1

=== Six Theme ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (Beta):

https://github.com/WHMCS/templates-six/compare/v8.1.3-release.1...v8.2.0-beta.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (Beta):

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.1.3-release.1...v8.2.0-beta.1

== Changelog ==
* [[Changelog:WHMCS_V8.2.0_Beta_1|Version 8.2.0 Beta 1]]
* [[Changelog:WHMCS_V8.2.0_RC_1|Version 8.2.0 RC 1]]

Version 8.2.0 Release Notes

2021-06-04T15:09:46Z

PeterB: /* Changelog */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.2<br />
Release Type: Beta<br />
Latest Update: 13th May 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.2.0</td><td>Beta 1</td><td>13th May 2021</td></tr>
</table>

==Download==

Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==

WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== Web.com Site Builder ===

MarketConnect now allows you to offer Web.com Site Builder. This white-labeled website builder includes several plans, each competitively tailored to give the creative experience your customers need to grow their sites.

[[Web.com_Site_Builder_via_WHMCS_MarketConnect|Learn More...]]

=== User Identity Verification ===

Integrated services from Validation.com give your team additional tools to verify user authenticity. You can initiate the user validation process automatically when orders are flagged for fraud review, manually while reviewing orders, or on demand for specific users. User identity verification can work in tandem with your current fraud protection configuration or as a standalone integration.

You can activate user identity verification at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection'''.

[[User_Identity_Verification|Learn More...]]

=== Product Addons ===

You can now set up [[Prorata_Billing|prorated product addons]], syncing the addon's billing day with the parent product or service. You can now also quickly duplicate existing product addons.

[[Product_Addons#Pricing|Learn More...]]

=== Payment Gateway Balances and Transactions ===

In the Admin Area, the '''Transactions''' list now displays gateway balance information for your activated gateways that use our latest gateway module balance functionality. In WHMCS 8.2, that includes native support for Stripe and PayPal Basic.

Additionally, developers can now retrieve transaction details through gateway modules, with initial support for Stripe. For more information on updating payment gateway modules for this functionality, see our [https://developers.whmcs.com/payment-gateways/displaying-balances/ Developer Documentation].

[[Payment_Gateway_Balances_and_Transactions|Learn More...]]

=== Stripe Balance Widget ===

The Admin Area Dashboard now includes a new Stripe widget displaying your '''Available''' and '''Pending''' Stripe balances. This displays balances for each currency that is both configured in WHMCS and held with the gateway.

[[Stripe_Balance_Widget|Learn More...]]

=== Free Domain Reminders ===

The new '''Free Domain Reminders''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' allows you to send renewal notices for free domains (domains bundled with a paid product or service) using the same configuration as paid domain renewals. In the Client Area, users will see a message instead of the option to renew free domains at '''Domains > Renew Domains'''.

[[Free_Domains|Learn More...]]

== Deprecation and Removal Notices ==

=== Removed UK VAT Validation Settings ===

The HRMC UK VAT system no longer requires API credentials. Because of this, we have simplified VAT setup by removing the '''Client ID''' and '''Client Secret''' settings from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Tax Configuration'''.

=== Discontinued Worldpay Support ===

We have removed support for the Worldpay Invisible and Worldpay Invidible XML gateways.

== New Documentation ==

The following new documentation pages are available:

* [[Prorata Billing]]
* [[Web.com Site Builder via WHMCS MarketConnect]]
* [[Free Domains]]
* [[User Identity Verification]]
* [[UK VAT Validation]]

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the GitHub repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (Beta):

https://github.com/WHMCS/templates-twenty-one/compare/v8.1.3-release.1...v8.2.0-beta.1

=== Six Theme ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (Beta):

https://github.com/WHMCS/templates-six/compare/v8.1.3-release.1...v8.2.0-beta.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (Beta):

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.1.3-release.1...v8.2.0-beta.1

== Changelog ==
* [[Changelog:WHMCS_V8.2.0_Beta_1|Version 8.2.0 Beta 1]]
* [[Changelog:WHMCS_V8.2.0_RC_1|Version 8.2.0 RC 1]]

Changelog:WHMCS V8.2

2021-06-04T15:09:37Z

PeterB:

=Version 8.2.0 (Beta 1)=
{{:Changelog:WHMCS_V8.2.0_Beta_1}}

=Version 8.2.0 (Release Candidate 1)=
{{:Changelog:WHMCS_V8.2.0_RC_1}}

Changelog:WHMCS V8.2.0 RC 1

2021-06-04T15:09:26Z

PeterB: Created page with "<noinclude>Version 8.2.0 Release Notes</noinclude> == Implemented == FEATURE-2475 - Introduce Product Addon Types<br /> FEATURE-2559 - Provide Predefined Add-On Feature..."

<noinclude>[[Version 8.2.0 Release Notes]]</noinclude>

== Implemented ==
FEATURE-2475 - Introduce Product Addon Types<br />
FEATURE-2559 - Provide Predefined Add-On Feature for WordPress Toolkit with cPanel and Plesk<br />

== Maintenance ==
CORE-15803 - Correct sort order functionality for payment gateways<br />
CORE-15993 - Mark MZN as a fractional currency<br />
CORE-16126 - Correct overly restrictive access to System Settings<br />
CORE-16275 - Ensure UserEdit hook executes during email change<br />
CORE-16295 - Ensure legacy_modern functions with friendly URLs<br />
CORE-16301 - Add health check to warn when using flawed database driver <br />
CORE-16328 - Update EU TLD country of citizenship additional field<br />
CORE-16355 - Correct distinction between service and service addons within Email Campaigns<br />
CORE-16364 - Correct merge field aggregation for tickets created via API<br />
CORE-16368 - Prevent error from invalid characters provided during credit removal<br />
CORE-16436 - Improve character encoding of recipient name for emails<br />
CORE-16447 - Honour system language on Order Confirmation email<br />
CORE-16503 - Allow importation of emails without subject headers<br />
CORE-16524 - Correct display of enabled status for Daily Email Backups<br />
CORE-16527 - Improve inspection of email sender for piped tickets<br />
CORE-16561 - Ensure proper calculation of PayPal Checkout fees<br />
CORE-16586 - Correct display of no results for intellisearch<br /> Also known as: CORE-16514, CORE-16634<br />
CORE-16593 - Correct admin url path for Apps & Integration links<br />
CORE-16617 - Correct template variable case for $loggedinuser<br />
CORE-16625 - Improve Ioncube analyser for 7.2 encodings<br />
CORE-16639 - Correct order id for order deletion request<br /> Also known as: CORE-16679<br />
CORE-16673 - Ensure ticket created via Email by External User is labeled as Registered User<br />
CORE-16705 - Prevent duplicate Slack notification for ticket close event<br />
CORE-16751 - Prevent perpetual error message for contact modification<br />

== Modules ==
MODULE-7156 - Sync Plesk Subscriptions assigned to Custom Service Plan<br />
MODULE-7623 - Ensure correct rate is set when adding a transaction for PayPal Checkout overpayments<br />

== Project Management Addon ==
PMA-191 - Associate Invoice searches by Invoice ID only<br />

Version 8.2.0 Release Notes

2021-05-18T15:41:40Z

PeterB: /* SitePlus Site Builder */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.2<br />
Release Type: Beta<br />
Latest Update: 13th May 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.2.0</td><td>Beta 1</td><td>13th May 2021</td></tr>
</table>

==Download==

Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==

WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== Web.com Site Builder ===

MarketConnect now allows you to offer Web.com Site Builder. This white-labeled website builder includes several plans, each competitively tailored to give the creative experience your customers need to grow their sites.

[[Web.com_Site_Builder_via_WHMCS_MarketConnect|Learn More...]]

=== User Identity Verification ===

Integrated services from Validation.com give your team additional tools to verify user authenticity. You can initiate the user validation process automatically when orders are flagged for fraud review, manually while reviewing orders, or on demand for specific users. User identity verification can work in tandem with your current fraud protection configuration or as a standalone integration.

You can activate user identity verification at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection'''.

[[User_Identity_Verification|Learn More...]]

=== Product Addons ===

You can now set up prorated product addons, syncing the addon's billing day with the parent product or service. You can now also quickly duplicate existing product addons.

[[Product_Addons#Pricing|Learn More...]]

=== Payment Gateway Balances and Transactions ===

In the Admin Area, the '''Transactions''' list now displays gateway balance information for your activated gateways that use our latest gateway module balance functionality. In WHMCS 8.2, that includes native support for Stripe and PayPal Basic.

Additionally, developers can now retrieve transaction details through gateway modules, with initial support for Stripe. For more information on updating payment gateway modules for this functionality, see our [https://developers.whmcs.com/payment-gateways/displaying-balances/ Developer Documentation].

[[Payment_Gateway_Balances_and_Transactions|Learn More...]]

=== Stripe Balance Widget ===

The Admin Area Dashboard now includes a new Stripe widget displaying your '''Available''' and '''Pending''' Stripe balances. This displays balances for each currency that is both configured in WHMCS and held with the gateway.

[[Stripe_Balance_Widget|Learn More...]]

=== Free Domain Reminders ===

The new '''Free Domain Reminders''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' allows you to send renewal notices for free domains (domains bundled with a paid product or service) using the same configuration as paid domain renewals. In the Client Area, users will see a message instead of the option to renew free domains at '''Domains > Renew Domains'''.

[[Free_Domains|Learn More...]]

== Deprecation and Removal Notices ==

=== Removed UK VAT Validation Settings ===

The HRMC UK VAT system no longer requires API credentials. Because of this, we have simplified VAT setup by removing the '''Client ID''' and '''Client Secret''' settings from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Tax Configuration'''.

=== Discontinued Worldpay Support ===

We have removed support for the Worldpay Invisible and Worldpay Invidible XML gateways.

== New Documentation ==

The following new documentation pages are available:

* [[Siteplus Site Builder via WHMCS MarketConnect]]
* [[Free Domains]]
* [[User Identity Verification]]
* [[UK VAT Validation]]

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the GitHub repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (Beta):

https://github.com/WHMCS/templates-twenty-one/compare/v8.1.3-release.1...v8.2.0-beta.1

=== Six Theme ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (Beta):

https://github.com/WHMCS/templates-six/compare/v8.1.3-release.1...v8.2.0-beta.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.1.3 and 8.2.0 (Beta):

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.1.3-release.1...v8.2.0-beta.1

== Changelog ==
* [[Changelog:WHMCS_V8.2.0_Beta_1|Version 8.2.0 Beta 1]]

Siteplus Site Builder via WHMCS MarketConnect

2021-05-18T15:40:18Z

PeterB: Redirected page to Web.com Site Builder via WHMCS MarketConnect

#REDIRECT [[Web.com_Site_Builder_via_WHMCS_MarketConnect]]

Siteplus Site Builder via WHMCS MarketConnect

2021-05-18T15:39:51Z

PeterB: Replaced content with "#REDIRECT Web.com_Site_Builder_via_WHMCS_MarketConnect"

[[#REDIRECT Web.com_Site_Builder_via_WHMCS_MarketConnect]]

Web.com Site Builder via WHMCS MarketConnect

2021-05-18T15:39:24Z

PeterB: Created page with "WHMCS MarketConnect allows you to resell Siteplus Site Builder, a white-labeled high-quality website builder. When you offer this, your customers will not see the Siteplus bra..."

WHMCS MarketConnect allows you to resell Siteplus Site Builder, a white-labeled high-quality website builder. When you offer this, your customers will not see the Siteplus brand or WHMCS, making it appear to be a bespoke offering from your company. The websites your customers create will publish to and be hosted on your own servers.

==Supported Actions==

* Automated Provisioning of new Siteplus Site Builder services.
* Single Sign-On from the Client and Admin Areas.
* Promotions within the Client Area.
* Automated cancellation.

==Setup and Configuration==

To activate and begin reselling Web.com Site Builder via WHMCS MarketConnect, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[MarketConnect]]''' or, prior to WHMCS 8.0, '''Setup > MarketConnect''' within your WHMCS admin area. Locate Site Builder, click '''Start Selling''', and then click '''Activate'''.

==Site Builder Automation==

When ordering Web.com Site Builder as an addon to a hosting plan, WHMCS and MarketConnect fully automate the Web.com Site Builder account setup process. This includes, for applicable actions, automation for FTP accounts, publishing, and upgrades.

For website publishing automation, the following details apply:

===cPanel===

WHMCS will create a dedicated FTP account within cPanel for use by Web.com Site Builder and will provision the site builder account with these FTP credentials.

When a user publishes their Site Builder website, it will connect to and publish the website using these FTP credentials.

===Plesk===

The FTP credentials will default to the domain, username, and password from the parent Plesk product with a publishing path in the <tt>httpdocs</tt> directory.

===DirectAdmin===

The FTP credentials will default to the domain, username, and password from the parent DirectAdmin product with a publishing path in the <tt>public_html</tt> directory.

===Other Control Panels===

The FTP credentials will default to the domain, username, and password of the parent product to which the Site Builder service is attached. If different, the FTP details must be updated manually (see below).

==Updating FTP Publishing Credentials==

FTP publishing credentials reside in custom fields that you can view and update when managing the site builder within the Admin Area.

To update the FTP publishing credentials in the Admin Area, follow the steps below:

# Modify the values in '''FTP Host''', '''FTP Username''', '''FTP Password''' and '''FTP Path'''.
# Click '''Save Changes'''.
# Click '''Update FTP Publishing Credentials''' to push the new details to Site Builder.

==Admin Management Actions==

For any site builder order, an admin is able to perform the following actions in the Admin Area:

* '''Manage Order''' — Click to perform single sign-on into Site Builder for the given website.
* '''Update FTP Publishing Credentials''' — Click to update the client FTP details. Update the custom field information and click '''Save Changes'''. Then, you can click '''Update FTP Publishing Credentials''' again to update the FTP information.

From '''Configuration > System Settings > MarketConnect''', admins can also perform single sign-on into Site Builder, allowing them to manage all websites under their control.

==Client Management Actions==

When logged in, if a customer has an active site builder service, a link to manage their websites will display on the Client Area home page and in the '''Product Details''' page for the addon. It will perform single sign-on and go directly to the Site Builder control panel to create and manage the website.

You can also manage FTP details for Web.com Site Builder in the '''Product Details''' page in the Client Area.

==Client Area Promotions==

MarketConnect supports displaying Web.com Site Builder promotions in the client area homepage, the shopping cart, and when managing a hosting product that does not have a Web.com Site Builder website attached to it.

Version 8.2 Release Notes

2021-05-13T17:09:18Z

PeterB: Redirected page to Version 8.2.0 Release Notes

#REDIRECT [[Version_8.2.0_Release_Notes]]

Changelogs

2021-05-13T16:31:26Z

PeterB: /* WHMCS */

Our changelogs provide details about additions, updates and fixes in each version of our software.

==WHMCS==

<table style="width:100%"><tr><td width="50%" valign="top">

*[[Changelog:WHMCS_V8.2|Version 8.2]]
*[[Changelog:WHMCS_V8.1|Version 8.1]]
*[[Changelog:WHMCS V8.0|Version 8.0]]
*[[Changelog:WHMCS V7.10|Version 7.10]]
*[[Changelog:WHMCS V7.9|Version 7.9]]
*[[Changelog:WHMCS V7.8|Version 7.8]]
*[[Changelog:WHMCS V7.7|Version 7.7]]
*[[Changelog:WHMCS V7.6|Version 7.6]]
*[[Changelog:WHMCS V7.5|Version 7.5]]
*[[Changelog:WHMCS V7.4|Version 7.4]]
*[[Changelog:WHMCS V7.3|Version 7.3]]

</td><td width="50%" valign="top">

*[[Changelog:WHMCS V7.2|Version 7.2]]
*[[Changelog:WHMCS V7.1|Version 7.1]]
*[[Changelog:WHMCS V7.0|Version 7.0]]
*[[Changelog:WHMCS V6.3|Version 6.3]]
*[[Changelog:WHMCS V6.2|Version 6.2]]
*[[Changelog:WHMCS V6.1|Version 6.1]]
*[[Changelog:WHMCS V6.0|Version 6.0]]
*[[Changelog:WHMCS V5.3|Version 5.3]]
*[[Changelog:WHMCS V5.2|Version 5.2]]
*[[Changelog:WHMCS V5.1|Version 5.1]]
*[[Changelog:WHMCS V5.0|Version 5.0]]

</td></tr></table>

==Addons==

<table style="width:100%"><tr><td width="50%" valign="top">

===Project Management===
*[[Changelog:Project Management V2.2|Version 2.2]]
*[[Changelog:Project Management V2.1|Version 2.1]]
*[[Changelog:Project Management V2.0|Version 2.0]]
*[[Changelog:Project Management V1.1|Version 1.1]]
*[[Changelog:Project Management V1.0|Version 1.0]]

===Licensing Addon===

*[[Changelog:Licensing Addon V3.0|Version 3.0]]

===Live Chat & Visitor Tracking Addon===

*[[Changelog:Live Chat V4.1|Version 4.1]]
*[[Changelog:Live Chat V4.0|Version 4.0]]

</td><td width="50%" valign="top">

===iWHMCS iPhone App===

*[[Changelog:iWHMCS V2.2|Version 2.2]]
*[[Changelog:iWHMCS V2.1|Version 2.1]]
*[[Changelog:iWHMCS V2.0|Version 2.0]]

===aWHMCS Android App===

*[[Changelog:aWHMCS V2.8|Version 2.8]]
*[[Changelog:aWHMCS V2.6|Version 2.6]]
*[[Changelog:aWHMCS V2.5|Version 2.5]]

</td></tr></table>

__NOTOC__

Changelog:WHMCS V8.2

2021-05-13T16:30:55Z

PeterB: Created page with "=Version 8.2.0 (Beta 1)= {{:Changelog:WHMCS_V8.2.0_Beta_1}}"

=Version 8.2.0 (Beta 1)=
{{:Changelog:WHMCS_V8.2.0_Beta_1}}

Release Notes

2021-05-13T16:30:02Z

PeterB:

<table class="table table-striped">
<tr><td>'''Version Number'''</td><td>'''First Release Date'''</td><td>'''Release Notes'''</td></tr>
<tr><td>Version 8.2</td><td>13th May 2021</td><td>[[Version_8.2.0_Release_Notes|View Release Notes]]</td>
<tr><td>Version 8.1</td><td>20th November 2020</td><td>[[Version 8.1.0 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 8.0</td><td>4th August 2020</td><td>[[Version 8.0.0 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 7.10</td><td>12th March 2020</td><td>[[Version 7.10 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 7.9</td><td>8th January 2020</td><td>[[Version 7.9 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 7.8</td><td>28th August 2019</td><td>[[Version 7.8 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 7.7</td><td>21st January 2019</td><td>[[Version 7.7 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 7.6</td><td>31st July 2018</td><td>[[Version 7.6 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 7.5</td><td>2nd April 2018</td><td>[[Version 7.5 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 7.4</td><td>25th October 2017</td><td>[[Version 7.4 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 7.3</td><td>26th August 2017</td><td>[[Version 7.3 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 7.2</td><td>16th May 2017</td><td>[[Version 7.2 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 7.1</td><td>16th November 2016</td><td>[[Version 7.1 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 7.0</td><td>22nd July 2016</td><td>[[Version 7.0 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 6.3</td><td>29th March 2016</td><td>[[Version 6.3 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 6.2</td><td>25th November 2015</td><td>[[Version 6.2 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 6.1</td><td>10th September 2015</td><td>[[Version 6.1 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 6.0</td><td>15th April 2015</td><td>[[Version 6.0 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 5.3</td><td>27th September 2013</td><td>[[Version 5.3 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 5.2</td><td>1st February 2013</td><td>[[Version 5.2 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 5.1</td><td>11th May 2012</td><td>[[Version 5.1 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 5.0</td><td>7th October 2011</td><td>[[Version 5.0 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 4.5</td><td>19th April 2011</td><td>[[Version 4.5 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 4.4</td><td>1st December 2010</td><td>[[Version 4.4 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 4.3</td><td>20th July 2010</td><td>[[Version 4.3 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 4.2</td><td>5th February 2010</td><td>[[Version 4.2 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 4.1</td><td>26th August 2009</td><td>[[Version 4.1 Release Notes|View Release Notes]]</td></tr>
<tr><td>Version 4.0</td><td>6th May 2009</td><td>[[Version 4.0 Release Notes|View Release Notes]]</td></tr>
</table>

<div class="docs-related-pages">[[Security Levels]] | [http://blog.whmcs.com/?t=106987 About Release Numbering]</div>

CPanel/WHM

2021-03-12T14:10:29Z

PeterB: /* For a reseller package */

{{Provisioning_Module
| changepackage = Yes
| changepw = Yes
| usageupdates = Yes
| clientarealink = Yes
| port = 2086 & 2087}}

== Adding a cPanel/WHM Server ==

The following steps guide you through the process of setting up a cPanel/WHM server in WHMCS for cPanel Hosting Accounts.

# You need to begin by creating a Server for your cPanel products to be assigned to in WHMCS.
# To do this navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers''' and click on '''Add New Server'''
# Enter the server name, IP address, select the server type "cpanel" from the dropdown menu.
# Enter your WHM username into the username field.[[File:Whm_api_setup.png|thumb|WHM API Setup]]
# Log in to WHM and navigate to '''Development >> Manage API Tokens'''.
# Click ''Generate Token''.
# Enter a name for your token, such as "WHMCS".
## For assistance configuring the WHM API token privileges, see our [[#API_Token_Permissions|API Token Permissions]] section below.
# Click Save and copy your API Token.
# Return to the WHMCS server configuration page and paste the newly generated API Token into the corresponding field..
# Ticking the SSL Mode checkbox is also recommended, but all other fields are optional.
# The default port will be displayed. If your server is configured to communicate on a different port, tick the '''Override with Custom Port''' checkbox and enter it into the Port field. For more information refer to [[Server Port Overrides]].
#Click Create Server to complete the process and add your new cPanel Server.
#If this is the only cPanel server listed afterwards, click on the name and ensure it results in an asterisk (*) next to it. This ensures it is the default and used when any other non-specific configuration (server groups) doesn't apply.

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> If 2FA is enabled on your cPanel server, you must disable it for API requests. [[CPanel/WHM#Disable_2FA_for_cPanel_API|Click here for more information]].</div>

== Setting Up a cPanel Package ==
<html><a href="https://www.youtube.com/watch?v=0lqzsTSUGw0&hd=1" class="docs-video-tutorial"><em>Watch the video tutorial for this feature</em><span> <img src="https://assets.whmcs.com/icons/youtube.png"> </span></a></html>

[[File:cpanel2.png|thumb|cPanel Module Settings]][[File:cpanel3.png|thumb|Adding a Package in WHM]]
To setup a cPanel package, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''. From there, you can create the product and configure the general settings and pricing info as normal. When it comes to the Module Settings tab, select "cpanel" in the module dropdown field and then for a shared hosting package:

====Simple Mode====

'''<i class="fa fa-info-circle"></i> This section describes a feature available in version 7.0 and above'''

# A list of the available packages configured in WHM will be populated into the '''WHM Package Name''' field.
# Select the package you wish to be created when this product is ordered
# And then finally as with all products you have the option of choosing the automatic setup option you want for new orders, be it immediately as soon as the order is placed, as soon as the initial payment has been received (recommended) or waiting until an admin manually reviews & accepts the pending orders
# Click Save Changes

====Advanced Mode====
[[File:Cpanel advanced.png|thumb|Advanced Mode]]

There is also the option to define custom packages - you can do that by clicking the '''Switch to Advanced Mode''' link. Advanced mode presents various options to customise the way the hosting account is created on the cPanel server. One of the possible configurations allows for quotas to be specified on a per-account basis rather than at a per-package level (You will need root access for this to work). To achieve this:

# Leave the WHM Package Name field empty
# Enter vales in the Web Space Quota and Bandwidth Limit fields.
# Define the individual limits into the fields the module settings page. If a field is left blank, WHMCS will not send a value to cPanel which will result in a quota being set to unlimited for that item.
# Max Addon Domains is the last field that applies to shared hosting accounts in the list.

===For a reseller package===
[[File:cpanel4.png|thumb|Creating an ACL List]][[File:cpanel5.png|thumb|cPanel Reseller Module Settings]]
#Set the settings for the resellers own hosting account as above with one difference, the '''Product Type''' setting must be Reseller Account.
#The fields from "Limit Reseller by Number" onwards specify reseller settings so from there you can set the resellers limits by number or disk space, these are explained below.
#The Reseller ACL List is required and defines what features inside WHM the reseller is allowed to use. To setup an ACL list, WHM doesn't offer a way without setting up a reseller so inside WHM go to the '''Reseller Center''' and activate a domain as a reseller, then proceed to the '''Edit reseller privileges & nameservers''' page and enter a name to save the feature selections before saving.

*Limit Reseller by Number - Specifies the maximum number of cPanel accounts the reseller can create or...
*Limit Reseller by Usage - Alternately limit the disk space and bandwidth the reseller has to assign to their customers using the following two options
*Reseller Disk Space - The disk space the reseller has to share amongst their accounts
*Reseller Bandwidth - The bandwidth the reseller has to share amongst their accounts
* Allow DS Overselling - Tick to allow resellers to assign more disk space to accounts than they actually have
* Allow BW Overselling - Tick to allow resellers to assign more bandwidth to accounts than they actually have
*Reseller ACL List - See below
*Configure Nameservers - Tick this option to give the reseller their own nameservers based upon their domain name instead of using your nameservers. Ie.
ns1.resellerdomain.com, ns2.resellerdomain.com
instead of
ns1.yourcompany.com. ns2.yourcompany.com

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> Per RFC-2832, custom nameservers must be registered. This is done from your Domain Registrar prior to configuration of the nameservers within cPanel.</div>

*Reseller Ownership - When ticked the reseller will own their own account. A package doesn't necessarily need to be setup, but you would need to define some limits for the client account created, perhaps 1MB disk and bandwidth so the client then changes their account to one of their own packages.

====Per Account Billing====

<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This section describes a feature available in version 7.9 and above.</div>

You can bill resellers for the number of cPanel accounts they provision. You can choose whether to include a certain number of cPanel accounts in the price and only charge for exceeding a certain limit, offer tiered pricing, or charge for every cPanel account resellers create.

<div class="docs-alert-info">
We recommend only offering cPanel account usage billing on products with a monthly billing cycle.
</div>

[[File:Cpanel usage billing.png|thumb|Enable Usage Billing]]

To use this feature:
# Toggle the '''Sub-Accounts''' billing metric to '''On'''. (Do not confuse this with cPanel Subaccounts, which cPanel accounts can create within cPanel.)
# Click the '''Configure Pricing''' link to set the pricing for the accounts the reseller consumes.
# Click '''Save'''.

When a client orders this product, WHMCS will track the number of cPanel accounts that the reseller creates.
On the service's '''Next Due Date''', the system records the current number of created cPanel accounts and adds the cost to the service's renewal invoice.

A guide with pricing examples [https://help.whmcs.com/m/setup/l/1185956-billing-resellers-per-domain is available here].

Usage Billing is a powerful feature. For more information on the terms and possible configurations, see [[Usage_Billing|Usage Billing]].

===Other Options===
*Add Prefix to Package - Add the username_ prefix to the package name when the account is created on the server. This is useful when using multiple servers with the same package name, but different username.

==Notes==
===Login to cPanel Link===
The login to cPanel link displayed in the '''client area''' is based upon the server hostname if available, if not, the IP address will be used. The usage of http and https login links depends upon the state of the "Secure" checkbox in the server configuration eg. When ticked, the https link with port 2083 is used.

The login to control panel link displayed in the '''admin area''' is based upon the server hostname if available, if not, the IP address will be used. The usage of http and https login links depends upon the state of the "Secure" checkbox in the server configuration eg. When ticked, the https link with port 2087 is used. It uses the xfercpanel function, so when prompted, enter your WHM login details (not the client's cPanel details) and you will be logged into the client's account with reseller privileges.

===Reseller Usage Calculation===
Reseller usage limits and reporting is based on the behaviour of WHM's design & implementation of a "Reseller" account type. Most notably, resellers owned by root will not have their own usage aggregated into such boundary calculations.

===WHMCS Connect===
WHMCS Connect allows you and your administrators to quickly and easily access the control panels of all the servers configured in your WHMCS installation that support Single Sign-On, enabling you and your staff to administer and make changes without ever needing to re-authenticate.

For information on the benefits of WHMCS Connect and how to configure this functionality [[WHMCS_Connect|refer to this page]].

===API Token Permissions===
With API Tokens for cPanel/WHM, it is possible to restrict what actions an API Token can perform. For WHMCS to be able to perform all the operations it supports, the following permissions must be granted in WHM at '''Development >> Manage API Tokens'''.
<table class="table table-striped">
<tr>
<td>basic-whm-functions</td>
<td>basic-system-info</td>
<td>cpanel-api</td>
</tr>
<tr>
<td>create-acct</td>
<td>create-user-session</td>
<td>suspend-acct</td>
</tr>
<tr>
<td>upgrade-acct</td>
<td>kill-acct</td>
<td>passwd</td>
</tr>
<tr>
<td>acct-summary</td>
<td>list-accts</td>
<td>show-bandwidth</td>
</tr>
<tr>
<td>cpanel-integration</td>
<td>list-pkgs</td>
<td>ns-config</td>
</tr>
<tr>
<td>edit-mx</td>
<td>manage-api-tokens</td>
<td>ssl-gencrt</td>
</tr>
</table>

When using the Configurable Package Addon, the "edit-account" permission will need to be enabled.
<div class="docs-alert-info">
<span class="title">Note for Reseller Accounts</span><br />
For reseller products, the "Everything" permission needs to be enabled as the reseller API functions on a cPanel server require root access to work.
</div>

===Keep DNS Zone on Termination===
When terminating a cPanel/WHM account via the WHMCS admin area, an option is provided to "Keep DNS Zone".

Selecting this option will terminate the account on a cPanel/WHM server while preserving the DNS Zone Record. Use this option where you wish to terminate the account but preserve the DNS records. Common use cases for this include scenarios such as account migration where DNS forwarding is being used.

<div class="docs-alert-warning">'''Please Note:''' You will not be able to re-create a new account on the server using the same domain while a DNS Zone exists for it. Attempting to provision the domain again will result in an error and you must delete the DNS Zone to be able to successfully provision a new account.</div>

===Disable 2FA for cPanel API===
For the cPanel module to function when 2FA is enabled for your account, you must ensure that the 2FA requirement is disabled for API requests.

To facilitate this:

# Log in to WHM as root
# Navigate to '''Security Center > Configure Security Policies'''
# Uncheck ''API requests'' and click '''Save'''

==Common Problems==

===You do not have permission to use Selected Package===
If you receive this error when trying to create an account then you need to correct the Packages Name setting. To do this, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Edit > Module Settings''' on the package where you are receiving the error. Where it asks for the WHM Package Name, you must enter this exactly as it appears in WHM - which should be in the format username_packagename.

===Package Not Allowed or Exceeded Resource/Account Allocation===
This error most likely means you only have reseller access to your server and are trying to create an account without a valid package name. You need to make sure the WHM Package Name in the product configuration of WHMCS matches exactly what is setup in your WHM Package Editor.

===Resellers are not permitted to create subdomains of the server's main domain===
This means no domain has been selected and is missing. Ensure the product has a domain name entered. You may need to enable Require Domain in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Product/Services'''.

===Unable to validate setting for language: english===
cPanel/WHM have made a number of changes to their API in the latest versions that are not backwards compatible. Therefore it is no longer possible to use an old version of WHMCS with the latest version of cPanel. You will need to upgrade your WHMCS install to version 4.2.1 or above.

===Sorry, that username is reserved===
cPanel/WHM does not allow usernames to contain the phrase "test" amongst others, so when this error occurs, simply change the username under the client's products/services tab and run the Create Module Command again.

===Sorry, a group for that username already exists===
An account with this username already exists on the server. This error can occur on shared servers even when you do not have an account with this username under your reseller account another reseller on the same server may be using it already.

To resolve, navigate to the client's Products/Services tab, change the Username, click Save Changes and finally click the "Create" Module Command button.

===Login Failed===
There are two possible causes for this error:

# The login details under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers > Edit''' are incorrect. Please ensure you are using either the username and API Key or the username and password combination and that the login details are correct.
# The Brute Force Protection settings are preventing WHMCS from creating/suspending/terminating accounts via the cPanel API. Please adjust the BFP settings in WHM.

===No user name supplied: "username" is a required argument===
This means the username under the client's Products/Services tab is empty.

You should enter a username, save changes and try module creation again. Also ensure that '''Require Domains''' is checked in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.

===Action Failed Unable to auto-login. Please contact support===
This error also means the username under the client's Products/Services tab is empty.

You should enter a username, save changes and try module creation again. Also ensure that '''Require Domains''' is checked in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.

=== WHM Username is missing for the selected server===
Seeing this error when attempting to provision a hosting account is caused by a server balancing misconfiguration. Ie. no server is selected upon which the account should be created. For troubleshooting steps for this particular issue, [[Provisioning_Issues#Server_Command_Error_-_Curl_Error_-_Couldn.27t_resolve_host_.286.29|please refer to this article]]

===An Unknown Error Occurred after updating to cPanel 74===
After updating to cPanel 74, every module command performed results in a "An unknown error occurred" message. Inspecting the [[Troubleshooting_Module_Problems|Module Debug Log]] reveals that a WHM 404 error page is being returned by the server.

This is caused by the [https://blog.cpanel.com/march-2017-development-update deprecation of the cPanel XML API] in version 74. To use the newer cPanel JSON API, it is necessary to [[Updating|update]] to WHMCS 7.3 or above.

===WHM Package not shown in Module dropdown list when editing product===

The cPanel API only returns packages available to provision under the reseller's WHM account. This often means packages may not show in this list if it would exceed the reseller's allowances on their WHM account.

Confirm this diagnosis by following these steps:
# [[File:Whm_packages_list_limits.png|thumb|cPanel Package Limits]]Login to WHM and navigate to '''Account Functions » Create a New Account'''
# Select the desired package from the ''Choose a Package'' dropdown
# Observe the package name is suffixed by the note "Cannot use due to limits"

There are two ways to resolve this issue:
# Ensure the WHM account has sufficient allowances to provision desired WHM package when configuring in WHMCS
# Enable overselling on the reseller account (requires WHM root access) - You can learn more about overselling in WHM in the [https://docs.cpanel.net/knowledge-base/cpanel-product/overselling/| cPanel docs here]

===Product attribute Package Name "Package Name" not found on server===
There are two possible causes of this error:
* [[#Package Not Allowed or Exceeded Resource/Account Allocation|Package name must be entered exactly as defined in WHM]]
* [[#WHM Package not shown in Module dropdown list when editing product|Insufficient resources to create the package]]

{{modules}}

Changelog:WHMCS V8.1

2021-02-26T15:14:34Z

PeterB:

=Version 8.1.0 (Beta 1)=
{{:Changelog:WHMCS_V8.1.0_Beta_1}}

=Version 8.1.0 (Release Candidate 1)=
{{:Changelog:WHMCS_V8.1.0_RC_1}}

=Version 8.1.0 (General Availability)=
{{:Changelog:WHMCS_V8.1.0_GA}}

=Version 8.1.1 (Maintenance)=
{{:Changelog:WHMCS_V8.1.1}}

=Version 8.1.2 (Maintenance)=
{{:Changelog:WHMCS_V8.1.2}}

=Version 8.1.3 (Security)=
{{:Changelog:WHMCS_V8.1.3}}

Changelog:WHMCS V8.0

2021-02-26T15:13:38Z

PeterB:

=Version 8.0.0 Beta 1=
{{:Changelog:WHMCS_V8.0.0_Beta_1}}

=Version 8.0.0 Beta 3=
{{:Changelog:WHMCS_V8.0.0_Beta_3}}

=Version 8.0.0 RC 1=
{{:Changelog:WHMCS_V8.0.0_RC_1}}

=Version 8.0.0 RC 2=
{{:Changelog:WHMCS_V8.0.0_RC_2}}

=Version 8.0.0 RC 3=
{{:Changelog:WHMCS_V8.0.0_RC_3}}

=Version 8.0.0 Release 1 (GA)=
{{:Changelog:WHMCS_V8.0.0_GA}}

=Version 8.0.1 Release 1 (Maintenance)=
{{:Changelog:WHMCS_V8.0.1}}

=Version 8.0.2 Release 1 (Maintenance)=
{{:Changelog:WHMCS_V8.0.2}}

=Version 8.0.3 Release 1 (Maintenance)=
{{:Changelog:WHMCS_V8.0.3}}

=Version 8.0.4 Release 1 (Maintenance)=
{{:Changelog:WHMCS_V8.0.4}}

=Version 8.0.5 Release 1 (Security)=
{{:Changelog:WHMCS_V8.0.5}}

Changelog:WHMCS V7.10

2021-02-26T15:13:09Z

PeterB:

=Version 7.10.0 Beta 1=
{{:Changelog:WHMCS_V7.10.0_Beta_1}}
=Version 7.10.0 RC 1=
{{:Changelog:WHMCS_V7.10.0_RC_1}}
=Version 7.10.0 RC 2=
{{:Changelog:WHMCS_V7.10.0_RC_2}}
=Version 7.10.0 General Availability=
{{:Changelog:WHMCS_V7.10.0_GA}}
=Version 7.10.1 Maintenance=
{{:Changelog:WHMCS_V7.10.1}}
=Version 7.10.2 Maintenance=
{{:Changelog:WHMCS_V7.10.2}}
=Version 7.10.3 Maintenance=
{{:Changelog:WHMCS_V7.10.3}}

Changelog:WHMCS V7.10.3

2021-02-26T15:10:37Z

PeterB: Created page with "<noinclude>Version 7.10.3 Release Notes</noinclude> == Security == CORE-16334 - REDACTED<br />"

<noinclude>[[Version 7.10.3 Release Notes]]</noinclude>

== Security ==
CORE-16334 - REDACTED<br />

Changelog:WHMCS V8.0.5

2021-02-26T15:10:34Z

PeterB: Created page with "<noinclude>Version 8.0.5 Release Notes</noinclude> == Security == CORE-16334 - REDACTED<br />"

<noinclude>[[Version 8.0.5 Release Notes]]</noinclude>

== Security ==
CORE-16334 - REDACTED<br />

Changelog:WHMCS V8.1.3

2021-02-26T15:10:33Z

PeterB: Created page with "<noinclude>Version 8.1.3 Release Notes</noinclude> == Security == CORE-16334 - REDACTED<br />"

<noinclude>[[Version 8.1.3 Release Notes]]</noinclude>

== Security ==
CORE-16334 - REDACTED<br />

Changelog:WHMCS V8.1

2021-02-23T18:46:50Z

PeterB:

=Version 8.1.0 Beta 1=
{{:Changelog:WHMCS_V8.1.0_Beta_1}}

=Version 8.1.0 Release Candidate 1=
{{:Changelog:WHMCS_V8.1.0_RC_1}}

=Version 8.1.0 General Availability=
{{:Changelog:WHMCS_V8.1.0_GA}}

=Version 8.1.1 Maintenance=
{{:Changelog:WHMCS_V8.1.1}}

=Version 8.1.2 Maintenance=
{{:Changelog:WHMCS_V8.1.2}}

Version 8.1.0 Release Notes

2021-02-23T18:46:48Z

PeterB:

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.1.2<br />
Release Type: Maintenance<br />
Release Date: 23rd Feb 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.1.0</td><td>Beta 1</td><td>20th Nov 2020</td></tr>
<tr><td>8.1.0</td><td>Release Candidate 1</td><td>8th Dec 2020</td></tr>
<tr><td>8.1.0</td><td>General Availability</td><td>29th Dec 2020</td></tr>
<tr><td>8.1.1</td><td>Maintenance</td><td>10th Feb 2021</td></tr>
<tr><td>8.1.2</td><td>Maintenance</td><td>23rd Feb 2021</td></tr>
</table>

==Download==
Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==
WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===
If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, please refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== New Twenty-One Client Area Theme ===
Just in time for the new year, the Twenty-One system theme gives the WHMCS Client Area a new look and feel. It includes Bootstrap 4, refined responsive behaviors, and many other distinct design elements.

[[New_Twenty-One_Client_Area_Theme|Learn more...]]

=== Updated Templating System ===
The Client Area is now even more customizable with an extensible, flexible templating system featuring inheritance through parent-child relationships and compatibility checking within the WHMCS interface.

System theme developers will be able to save time and effort both during initial development and when maintaining system themes. For more information on these changes, coming soon to [https://developers.whmcs.com/themes/ Developer Documentation].

=== OAuth2 for Email Importing ===
WHMCS now supports OAuth2 via Gmail for importing support department emails. OAuth2 provides more security than password-based authentication. You can configure this at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support Departments'''.

[[OAuth2_for_Email_Importing|Learn more...]]

=== Automated User Deletion ===
Retaining users is important for business, but there are times when deletion is required. New interface options you to take a safe and informed approach to manual and automated user deletion.

[[Users_and_Accounts|Learn more...]]

=== Disable Outgoing Mail ===
You can now pause outgoing client and system communications with a single setting in WHMCS. A reminder banner will appear in the Admin Area until you reenable email sending.

[[Disabling_Outgoing_Mail|Learn more...]]

== Deprecation and Removal Notices ==

=== AutoAuth Removed ===
[[AutoAuth]] was deprecated in WHMCS 7.10 and has been removed in WHMCS 8.1. We recommend that you use the [https://developers.whmcs.com/api-reference/createssotoken/ CreateSsoToken API] to direct users from an authenticated system to a mapped WHMCS client account.

=== Realtime Register ===
The [[Realtime Register]] module has been removed. You can find supported registrar modules [https://marketplace.whmcs.com/product/2598-domains-module-realtime-register in the WHMCS Marketplace].

== New Documentation ==
The following new documentation pages are available:
* [[New Twenty-One Client Area Theme]]
* [[Disabling Outgoing Mail]]
* [[Email Importing]]
* [[OAuth2 for Email Importing]]
* [[Social Networking]] (Updated)
* [[Data Retention Policy Automation]] (Updated)
* [[Clients:Users_Tab|Clients Users Tab]] (Updated)
* [[Users and Accounts]] (Updated)
* [[General Tab]] (Updated)
* [[Standard Order Form Templates]] (Updated)

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the Github repo's below.

===Twenty-One Theme===
The following link provides a comparison of changes between 8.1.0 (Beta) and 8.1.2 (Maintenance):
https://github.com/WHMCS/templates-twenty-one/compare/v8.1.0-beta.1...v8.1.2-release.1

=== Six Theme ===

The following link provides a comparison of changes between 8.0.4 and 8.1.2:
https://github.com/WHMCS/templates-six/compare/v8.0.4-release.1...v8.1.2-release.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.0.4 and 8.1.2:
https://github.com/WHMCS/orderforms-standard_cart/compare/v8.0.4-release.1...v8.1.2-release.1

== Changelog ==
* [[Changelog:WHMCS_V8.1.0_Beta_1|Version 8.1.0 Beta 1]]
* [[Changelog:WHMCS_V8.1.0_RC_1|Version 8.1.0 RC 1]]
* [[Changelog:WHMCS_V8.1.0_GA|Version 8.1.0 GA]]
* [[Changelog:WHMCS_V8.1.1|Version 8.1.1 Maintenance]]
* [[Changelog:WHMCS_V8.1.2|Version 8.1.2 Maintenance]]

Version 8.1.0 Release Notes

2021-02-10T18:12:40Z

PeterB: /* Changelog */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.1.1<br />
Release Type: Maintenance<br />
Release Date: 10th Feb 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.1.0</td><td>Beta 1</td><td>20th Nov 2020</td></tr>
<tr><td>8.1.0</td><td>Release Candidate 1</td><td>8th Dec 2020</td></tr>
<tr><td>8.1.0</td><td>General Availability</td><td>29th Dec 2020</td></tr>
<tr><td>8.1.1</td><td>Maintenance</td><td>10th Feb 2021</td></tr>
</table>

==Download==
Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==
WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===
If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, please refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== New Twenty-One Client Area Theme ===
Just in time for the new year, the Twenty-One system theme gives the WHMCS Client Area a new look and feel. It includes Bootstrap 4, refined responsive behaviors, and many other distinct design elements.

[[New_Twenty-One_Client_Area_Theme|Learn more...]]

=== Updated Templating System ===
The Client Area is now even more customizable with an extensible, flexible templating system featuring inheritance through parent-child relationships and compatibility checking within the WHMCS interface.

System theme developers will be able to save time and effort both during initial development and when maintaining system themes. For more information on these changes, coming soon to [https://developers.whmcs.com/themes/ Developer Documentation].

=== OAuth2 for Email Importing ===
WHMCS now supports OAuth2 via Gmail for importing support department emails. OAuth2 provides more security than password-based authentication. You can configure this at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support Departments'''.

[[OAuth2_for_Email_Importing|Learn more...]]

=== Automated User Deletion ===
Retaining users is important for business, but there are times when deletion is required. New interface options you to take a safe and informed approach to manual and automated user deletion.

[[Users_and_Accounts|Learn more...]]

=== Disable Outgoing Mail ===
You can now pause outgoing client and system communications with a single setting in WHMCS. A reminder banner will appear in the Admin Area until you reenable email sending.

[[Disabling_Outgoing_Mail|Learn more...]]

== Deprecation and Removal Notices ==

=== AutoAuth Removed ===
[[AutoAuth]] was deprecated in WHMCS 7.10 and has been removed in WHMCS 8.1. We recommend that you use the [https://developers.whmcs.com/api-reference/createssotoken/ CreateSsoToken API] to direct users from an authenticated system to a mapped WHMCS client account.

=== Realtime Register ===
The [[Realtime Register]] module has been removed. You can find supported registrar modules [https://marketplace.whmcs.com/product/2598-domains-module-realtime-register in the WHMCS Marketplace].

== New Documentation ==
The following new documentation pages are available:
* [[New Twenty-One Client Area Theme]]
* [[Disabling Outgoing Mail]]
* [[Email Importing]]
* [[OAuth2 for Email Importing]]
* [[Social Networking]] (Updated)
* [[Data Retention Policy Automation]] (Updated)
* [[Clients:Users_Tab|Clients Users Tab]] (Updated)
* [[Users and Accounts]] (Updated)
* [[General Tab]] (Updated)
* [[Standard Order Form Templates]] (Updated)

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the Github repo's below.

===Twenty-One Theme===
The following link provides a comparison of changes between 8.1.0 (Beta) and 8.1.1 (Maintenance):
https://github.com/WHMCS/templates-twenty-one/compare/v8.1.0-beta.1...v8.1.1-release.1

=== Six Theme ===

The following link provides a comparison of changes between 8.0.4 and 8.1.1:
https://github.com/WHMCS/templates-six/compare/v8.0.4-release.1...v8.1.1-release.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.0.4 and 8.1.1:
https://github.com/WHMCS/orderforms-standard_cart/compare/v8.0.4-release.1...v8.1.1-release.1

== Changelog ==
* [[Changelog:WHMCS_V8.1.0_Beta_1|Version 8.1.0 Beta 1]]
* [[Changelog:WHMCS_V8.1.0_RC_1|Version 8.1.0 RC 1]]
* [[Changelog:WHMCS_V8.1.0_GA|Version 8.1.0 GA]]
* [[Changelog:WHMCS_V8.1.1|Version 8.1.1 Maintenance]]

Version 8.1.0 Release Notes

2021-02-10T18:12:25Z

PeterB:

Changelog:WHMCS V8.1

2021-02-10T18:04:11Z

PeterB:

General Tab

2021-01-05T17:29:32Z

PeterB: /* Maintenance Mode */

<br/><br/>{{General Settings}}

===Company Name===
Enter your company name as you wish it to appear throughout the WHMCS Admin and Client Areas.

===Email Address===
This is the default email address that will appear as the sender on all of the email that WHMCS sends to you and your customers.

===Domain===
The URL for the domain that hosts your WHMCS installation.

===Logo URL===
The URL for the logo image that will appear in email messages, on invoices, and in the WHMCS Client Area.

===Pay To Text===
The text to display on invoices as the ''Pay To'' details.

===WHMCS System URL===
This setting defines the URL to use to access your WHMCS installation. This is based on the location of the files on your server. If possible, WHMCS attempts to set this value automatically during installation. If you use the command line for installation, WHMCS will prompt you for this value. For example, <tt>http://www.example.com/members/</tt>.

We recommend installing an SSL certificate. This will let you enter the SSL URL to enable encrypted connections between WHMCS and your customers and between your staff and the Admin Area. For example, <tt>https://www.example.com/members/</tt>.

===System Theme===
The system theme that you want to use for WHMCS's Client Area. We ship two by default:

* ''Twenty-One'' was introduced in WHMCS 8.1. We recommend that you use this system theme. For more information, see [[New Twenty-One Client Area Theme]].
* ''Six'' was introduced in WHMCS 6.0. We plan to remove this system theme in a future WHMCS version.

In WHMCS 8.1 and higher, when you select a '''System Theme''', WHMCS will validate it for compatibility with the order form templates you use.

For information on developing your own custom system theme, see [https://developers.whmcs.com/themes/ Themes] in our [https://developers.whmcs.com/ Developer Documentation].

===Limit Activity Log===
The maximum number of system-related entries to store in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' or, prior to WHMCS 8.0, '''Utilities > [[Activity_Logs|Activity Log]]'''. System-related entries display the '''System''' user and '''UserID 0'''.

<div class="docs-alert-info">
<span class="title">Other Entries</span><br />
Entries for specific clients are stored indefinitely for auditing purposes. You can prune client-specific log entries at '''Utilities > System > [[System_Utilities#System_Cleanup|System Cleanup]]'''.
</div>

===Records to Display per Page===
The number of records to display in the '''Clients''' list, lists of invoices, and other lists in WHMCS.

===Maintenance Mode===
Enabling this option will prevent your customers from accessing the Client Area and display the '''Maintenance Mode Message''' (or redirect to another URL, if you enter a '''Maintenance Mode Redirect URL'''.

<div class="docs-alert-warning">
<span class="title">Note:</span><br />
Admins will still be able to see the client area. Both the API and hooks will continue to function unobstructed while '''Maintenance Mode''' is enabled.
</div>

===Maintenance Mode Message===
If you enable '''Maintenance Mode''', your customers will see the message you enter here in the Client Area.

===Maintenance Mode Redirect URL===
When you enter a URL here, clients will be redirected there when '''Maintenance Mode''' is enabled instead of seeing the maintenance message.

===Friendly URLs===
When you use Search Engine [[Friendly_URLs|Friendly URLs]], for example, a URL that looks like this:

<div class="source-cli">/knowledgebase.php?action=view&id=1</div>

becomes

<div class="source-cli">/knowledgebase/1/How_do_I_access_my_control_panel.html</div>

You can enable these for the MarketConnect landing pages, announcements, downloads, and knowledgebase sections of the WHMCS Client Area.

WHMCS will automatically detect the best option based upon your server environment and highlight it with a green background. If you select a different option, the status indicator will switch to ''Manual Override'':

* '''Fully Friendly Rewrite''' — For example, <tt>http://awesome.host/store/ssl-certificates/dv</tt>
* '''Friendly index.php''' — For example, <tt>http://awesome.host/index.php/store/ssl-certificates/dv</tt>
* '''Basic URLs''' — For example, <tt>http://awesome.host/index.php?rp=/store/ssl-certificates/dv</tt>

For a description of the system requirements of the different options, see [[Friendly_URLs#URI_Path_Mode|Friendly URLs]].

To re-check your environment and reset to the recommended system detected setting, click the refresh button.

An '''Advanced Settings''' option is also available to further customise how this feature behaves. For more information, see [[Friendly_URLs#Advanced_Settings|Friendly URLs]]. We only recommend changing the advanced settings if you are confident maintaining your own <tt>mod_rewrite</tt> rules.

SolusVM

2021-01-04T19:00:41Z

PeterB: /* Overview */

[http://www.solusvm.com SolusVM] is a virtual server control panel from SolusLabs Ltd. [http://www.solusvm.com SolusVM] supports OpenVZ virtualization (linux), Xen virtualization (Linux, Windows, BSD) and KVM virtualization (Linux, Windows, BSD).

== Virtual Server Provisioning Module (Admin/Reseller)==
=== Overview ===
This module allows you to create, destroy, suspend, unsuspend, upgrade, downgrade, reboot, boot and shutdown virtual servers, plus functions to provision virtual servers in different locations, all directly from within WHMCS.

The client also has an array of functions and statistics from within the client area, including, reboot, boot, shutdown, change passwords, change hostname, view resource usage and graphs, plus the added bonus of a serial console or VNC.

The module also has an option that allows your clients to order custom virtual servers.

<div class="docs-alert-info">
<span class="title">Download</span><br />
[https://docs.solusvm.com/display/BET/SolusVM+WHMCS+billing+module Click here] to download and view installation instructions.
</div>

== Reseller Product Provisioning Module ==
=== Overview ===
This module allows you to create a range of reseller resource products allowing orders to be auto-provisoned instantly on payment.

<div class="docs-alert-info">
<span class="title">Download</span><br />
[https://docs.solusvm.com/display/BET/SolusVM+WHMCS+billing+module Click here] to download and view installation instructions.
</div>

{{modules}}

SolusVM

2021-01-04T19:00:32Z

PeterB: /* Virtual Server Provisioning Module (Admin/Reseller) */

[http://www.solusvm.com SolusVM] is a virtual server control panel from SolusLabs Ltd. [http://www.solusvm.com SolusVM] supports OpenVZ virtualization (linux), Xen virtualization (Linux, Windows, BSD) and KVM virtualization (Linux, Windows, BSD).

== Virtual Server Provisioning Module (Admin/Reseller)==
=== Overview ===
This module allows you to create, destroy, suspend, unsuspend, upgrade, downgrade, reboot, boot and shutdown virtual servers, plus functions to provision virtual servers in different locations, all directly from within WHMCS.

The client also has an array of functions and statistics from within the client area, including, reboot, boot, shutdown, change passwords, change hostname, view resource usage and graphs, plus the added bonus of a serial console or VNC.

The module also has an option that allows your clients to order custom virtual servers.

<div class="docs-alert-info">
<span class="title">Download</span><br />
[https://docs.solusvm.com/display/BET/SolusVM+WHMCS+billing+module Click here] to download and view installation instructions.
</div>

== Reseller Product Provisioning Module ==
=== Overview ===
This module allows you to create a range of reseller resource products allowing orders to be auto-provisoned instantly on payment.

<div class="docs-alert-info">
<span class="title">Download</span><br />
[https://documentation.solusvm.com/display/DOCS/WHMCS Click here] to download and view installation instructions.
</div>

{{modules}}

Version 8.1.0 Release Notes

2020-12-29T15:31:59Z

PeterB: /* Twenty-One Theme */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.1<br />
Release Type: General Availability<br />
Release Date: 29th Dec 2020<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.1.0</td><td>Beta 1</td><td>20th Nov 2020</td></tr>
<tr><td>8.1.0</td><td>Release Candidate 1</td><td>8th Dec 2020</td></tr>
<tr><td>8.1.0</td><td>General Availability</td><td>29th Dec 2020</td></tr>
</table>

==Download==
Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==
WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===
If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, please refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== New Twenty-One Client Area Theme ===
Just in time for the new year, the Twenty-One system theme gives the WHMCS Client Area a new look and feel. It includes Bootstrap 4, refined responsive behaviors, and many other distinct design elements.

[[New_Twenty-One_Client_Area_Theme|Learn more...]]

=== Updated Templating System ===
The Client Area is now even more customizable with an extensible, flexible templating system featuring inheritance through parent-child relationships and compatibility checking within the WHMCS interface.

System theme developers will be able to save time and effort both during initial development and when maintaining system themes. For more information on these changes, coming soon to [https://developers.whmcs.com/themes/ Developer Documentation].

=== OAuth2 for Email Importing ===
WHMCS now supports OAuth2 via Gmail for importing support department emails. OAuth2 provides more security than password-based authentication. You can configure this at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support Departments'''.

[[OAuth2_for_Email_Importing|Learn more...]]

=== Automated User Deletion ===
Retaining users is important for business, but there are times when deletion is required. New interface options you to take a safe and informed approach to manual and automated user deletion.

[[Users_and_Accounts|Learn more...]]

=== Disable Outgoing Mail ===
You can now pause outgoing client and system communications with a single setting in WHMCS. A reminder banner will appear in the Admin Area until you reenable email sending.

[[Disabling_Outgoing_Mail|Learn more...]]

== Deprecation and Removal Notices ==

=== AutoAuth Removed ===
[[AutoAuth]] was deprecated in WHMCS 7.10 and has been removed in WHMCS 8.1. We recommend that you use the [https://developers.whmcs.com/api-reference/createssotoken/ CreateSsoToken API] to direct users from an authenticated system to a mapped WHMCS client account.

=== Realtime Register ===
The [[Realtime Register]] module has been removed. You can find supported registrar modules [https://marketplace.whmcs.com/product/2598-domains-module-realtime-register in the WHMCS Marketplace].

== New Documentation ==
The following new documentation pages are available:
* [[New Twenty-One Client Area Theme]]
* [[Disabling Outgoing Mail]]
* [[Email Importing]]
* [[OAuth2 for Email Importing]]
* [[Social Networking]] (Updated)
* [[Data Retention Policy Automation]] (Updated)
* [[Clients:Users_Tab|Clients Users Tab]] (Updated)
* [[Users and Accounts]] (Updated)
* [[General Tab]] (Updated)
* [[Standard Order Form Templates]] (Updated)

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the Github repo's below.

===Twenty-One Theme===
The following link provides a comparison of changes between 8.1.0 (Beta) and 8.1.0 (Release Candidate 1):
https://github.com/WHMCS/templates-twenty-one/compare/v8.1.0-beta.1...v8.1.0-release.1

=== Six Theme ===

The following link provides a comparison of changes between 8.0.4 and 8.1.0:
https://github.com/WHMCS/templates-six/compare/v8.0.4-release.1...v8.1.0-release.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.0.4 and 8.1:
https://github.com/WHMCS/orderforms-standard_cart/compare/v8.0.4-release.1...v8.1.0-release.1

== Changelog ==
* [[Changelog:WHMCS_V8.1.0_Beta_1|Version 8.1.0 Beta 1]]
* [[Changelog:WHMCS_V8.1.0_RC_1|Version 8.1.0 RC 1]]
* [[Changelog:WHMCS_V8.1.0_GA|Version 8.1.0 GA]]

Version 8.1.0 Release Notes

2020-12-29T15:31:18Z

PeterB:

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.1<br />
Release Type: General Availability<br />
Release Date: 29th Dec 2020<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==

<table class="table table-striped">
<tr><td>8.1.0</td><td>Beta 1</td><td>20th Nov 2020</td></tr>
<tr><td>8.1.0</td><td>Release Candidate 1</td><td>8th Dec 2020</td></tr>
<tr><td>8.1.0</td><td>General Availability</td><td>29th Dec 2020</td></tr>
</table>

==Download==
Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==
WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===
If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

Go to '''Utilities > Update WHMCS''' to begin the process.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i> If the update was released recently, you may need to click '''Check for Updates''' before the update will be available.
</div>

For more information about updating, please refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== New Twenty-One Client Area Theme ===
Just in time for the new year, the Twenty-One system theme gives the WHMCS Client Area a new look and feel. It includes Bootstrap 4, refined responsive behaviors, and many other distinct design elements.

[[New_Twenty-One_Client_Area_Theme|Learn more...]]

=== Updated Templating System ===
The Client Area is now even more customizable with an extensible, flexible templating system featuring inheritance through parent-child relationships and compatibility checking within the WHMCS interface.

System theme developers will be able to save time and effort both during initial development and when maintaining system themes. For more information on these changes, coming soon to [https://developers.whmcs.com/themes/ Developer Documentation].

=== OAuth2 for Email Importing ===
WHMCS now supports OAuth2 via Gmail for importing support department emails. OAuth2 provides more security than password-based authentication. You can configure this at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Support Departments'''.

[[OAuth2_for_Email_Importing|Learn more...]]

=== Automated User Deletion ===
Retaining users is important for business, but there are times when deletion is required. New interface options you to take a safe and informed approach to manual and automated user deletion.

[[Users_and_Accounts|Learn more...]]

=== Disable Outgoing Mail ===
You can now pause outgoing client and system communications with a single setting in WHMCS. A reminder banner will appear in the Admin Area until you reenable email sending.

[[Disabling_Outgoing_Mail|Learn more...]]

== Deprecation and Removal Notices ==

=== AutoAuth Removed ===
[[AutoAuth]] was deprecated in WHMCS 7.10 and has been removed in WHMCS 8.1. We recommend that you use the [https://developers.whmcs.com/api-reference/createssotoken/ CreateSsoToken API] to direct users from an authenticated system to a mapped WHMCS client account.

=== Realtime Register ===
The [[Realtime Register]] module has been removed. You can find supported registrar modules [https://marketplace.whmcs.com/product/2598-domains-module-realtime-register in the WHMCS Marketplace].

== New Documentation ==
The following new documentation pages are available:
* [[New Twenty-One Client Area Theme]]
* [[Disabling Outgoing Mail]]
* [[Email Importing]]
* [[OAuth2 for Email Importing]]
* [[Social Networking]] (Updated)
* [[Data Retention Policy Automation]] (Updated)
* [[Clients:Users_Tab|Clients Users Tab]] (Updated)
* [[Users and Accounts]] (Updated)
* [[General Tab]] (Updated)
* [[Standard Order Form Templates]] (Updated)

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the Github repo's below.

===Twenty-One Theme===
The following link provides a comparison of changes between 8.1.0 (Beta) and 8.1.0 (Release Candidate 1):
https://github.com/WHMCS/templates-twenty-one/compare/v8.1.0-beta.1...v8.1.0-rc.1

=== Six Theme ===

The following link provides a comparison of changes between 8.0.4 and 8.1.0:
https://github.com/WHMCS/templates-six/compare/v8.0.4-release.1...v8.1.0-release.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.0.4 and 8.1:
https://github.com/WHMCS/orderforms-standard_cart/compare/v8.0.4-release.1...v8.1.0-release.1

== Changelog ==
* [[Changelog:WHMCS_V8.1.0_Beta_1|Version 8.1.0 Beta 1]]
* [[Changelog:WHMCS_V8.1.0_RC_1|Version 8.1.0 RC 1]]
* [[Changelog:WHMCS_V8.1.0_GA|Version 8.1.0 GA]]