Personal tools


Multibrand For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


About Multibrand For WHMCS

Multibrand For WHMCS will allow you to manage multiple brands on multiple websites while using just one WHMCS license.

The module will allow you to easily personalize each brand by adjusting its client area template, logo, language and many other elements.
You will be able to assign clients to brands and migrate them, as well as assign products and ticket departments to every brand.
Moreover, you will be able to configure payments gateways, customize invoices, add relations to knowledgebase articles, downloads and more - each action can be taken per brand.

  • Addon Features:
✔ User-Friendly Management Of Multiple Brands
✔ Easy Modification Of Existing Brands
✔ Assign Ticket Departments To Brands
✔ Assign Ticket Piping Email Addresses To Brands
✔ Configure Payment Gateways For Each Brand
✔ Configure Email Templates For Each Brand
✔ Configure SMTP Mailboxes For Each Brand
✔ Set Up Pricing Of Products, Addons, And Domains For Each Brand
✔ Define Product Bundles For Each Brand
✔ Define Promotions For Each Brand
✔ Display And Migrate Clients Between Brands
✔ Display And Manage Relations:
✔ Announcements
✔ Billable Items
✔ Downloads
✔ Emails
✔ Invoices
✔ Knowledgebase
✔ Quotes
✔ Services
✔ Tickets
✔ Toggle Brand Switcher
✔ Toggle Invoice Branding
✔ Toggle Brand Status
✔ Toggle Auto Client Assignment
✔ Toggle Pricing Branding
✔ Toggle SMTP Settings Branding
✔ View Monthly And Total Sales Per Brand
✔ View Dynamic Statistics On Each Brand
✔ View Logs
  • Admin Area Features:
✔ Order Branded Products
✔ Create Branded Clients
✔ Create Branded Invoices
✔ Create Branded Billable Items
✔ Create Branded Quotes
✔ Open Branded Tickets
✔ Create Branded Announcements
✔ Add Branded Knowledgebase Articles
✔ Add Branded Downloads
✔ Send Branded Email Message To Single Or Multiple Clients
✔ Send Branded Password Reset Emails
✔ Display Brand Labels On The Lists:
✔ Announcements
✔ Cancellation Requests
✔ Clients
✔ Domain Registrations
✔ Downloads
✔ Invoices
✔ Knowledgebase Articles
✔ Orders
✔ Service Addons
✔ Tickets
✔ Display Branded Invoice Number
✔ Invoice Selected Items On Client Summary
✔ Log In As Client To Chosen Brand
  • Client Area Features:
✔ Display Client Area Template And Default Language Depending On Brand
✔ Access Services, Invoices, Downloads, Ticket Departments, And Payment Gateways Assigned To Brand
✔ View Knowledgebase Articles And Announcements Assigned To Brand
✔ Receive Branded Emails And Invoices
✔ Assign Clients Automatically Upon Registration To Brand
✔ Toggle Auto Assignment Of Clients When Logging In To Different Brand
✔ Allow Clients To Switch Between Brands Using Dedicated Menu
  • Brand Configuration:
✔ Set Up Brand Name
✔ Brand Company Name
✔ Brand Domain Address
✔ Brand System URL
✔ Brand Logo
✔ Brand Default Language
✔ Brand Template
✔ Brand Order Template
✔ Brand Address
✔ Brand Signature
✔ Brand Email Address
✔ Brand Ticket Departments
✔ Brand Graph Color
✔ Brand Terms Of Service URL
✔ Brand Invoice Sequential Number, Format And Pay To Text
✔ Toggle Proforma Invoicing
✔ Toggle Zero Invoices Number Branding
✔ Choose Default And Available Currencies Per Brand
✔ Set Up Branded Or Normal Payment Gateways
✔ Brand Email CSS Styling And Content
✔ Brand Email Templates In Various Languages
✔ Brand Affiliate URLs
  • Branded Payment Gateways:
✔ 2Checkout
✔ Authorize.Net
✔ Bank Transfer
✔ Payflow Pro
✔ PayPal Checkout
✔ PayPal REST
✔ Stripe
✔ WePay
  • General Info:
✔ Integrated With MetricsCube - Business Intelligence Platform For WHMCS
✔ Integrated With SMS Center For WHMCS - Send Personalized SMS Messages Based On Clients Brands
✔ Multi-Currency Support
✔ Multi-Language Support
✔ Supports PHP 8.1 Back To PHP 7.4
✔ Supports WHMCS Themes "Six", "Twenty-One" And "Lagom WHMCS Client Theme"
✔ Supports WHMCS V8.10 Back To WHMCS V8.6
✔ Requires ionCube Loader V12 Or Later
✔ Easy Module Upgrade To Open Source Version


This tutorial will show you how to successfully install and configure Multibrand For WHMCS.

We will guide you step by step through the whole installation and configuration process.

Note: If you still use any of Multibrand For WHMCS previous versions prior to v2.x, read about it here.


1. Log in to our client area and download the module.
MB2 1.png
2. In the downloaded file you might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.2 and later.

PHP72 74.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

The first one that supports PHP 5.6 up to PHP 7.1, and the second one addressed to PHP 7.2 up to PHP 7.4.
Note: Keep in mind that PHP versions 5.6 up to 7.1 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

PHP56 74.png
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload should look like this.

MB2 2 2.png
4. When you install Multibrand For WHMCS for the first time, you have to rename the 'license_RENAME.php' file.

The file is located in 'modules/addons/Multibrand/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

MB2 3.png
5. In order to configure your license key, you have to edit the previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

MB2 4.png

Activating Addon Module

6. Now, you have to activate the module in your WHMCS system.

Log in to your WHMCS admin area. Go to 'Setup' 'Addon Modules'. Afterward, find 'Multibrand' and press the 'Activate' button.

MB2 5.png
7. In the next step, you need to enable the hooks and grant access to this module.

To do so, click on the 'Configure' button, go to the 'Access Control' area and check the required group of administrators. Press 'Save Changes'.
If you want users to keep their access to the addon's features throughout various WHMCS sections (e.g. support tickets), but limit access to the module addon
make sure to uncheck 'Admin Area Addon View' and check the 'Access Control' field at the same time.
'Available Brand Login' - if selected, a client who uses the URL to a brand they do not belong to, they will be automatically logged into the first brand to which they are assigned

Note: When it comes to the 'Admin Addon View', despite having this box unchecked for the administrator, all the hooks will still work as intended.
Same scenario does not apply to the 'Access Control' field which is strictly related to the hooks functionality.

MB2 6.png

Additional Settings

8. Now, set up the 'storage' folder with its subfolders as recursively writable.

This folder is available at 'your_whmcs/modules/addons/Multibrand/' .

MB2 7.png
9. You will also need to set up 'gateways' and 'callback' folders as writable.

The 'gateways' folder is located in 'your_whmcs/modules/' and the 'callback' folder in 'your_whmcs/modules/gateways' (do NOT mistake the folders with those located in the Multibrand addon)

MB2 7 0.png
10. The next step is replacing the 'invoicepdf.tpl' file with 'invoicepdf_rename.tpl' for each of the templates used.

The 'invoicepdf_rename.tpl' file is located in the 'your_whmcs/templates/six/' folder.
Just rename the default 'invoicepdf.tpl' file to 'invoicepdf.tpl_old' and rename the 'invoicepdf_rename.tpl' file to 'invoicepdf.tpl' in the same folder.
Proceed with 'quotepdf.tpl' file in the very same way as with 'invoicepdf.tpl' files.

MB2 7 1.png

Integration Code

11. You can now access your Multibrand For WHMCS module.

Simply go to 'Addons' 'Multibrand'. But, before you can start using the module, you still need to set up the 'Integration Code'. It is required for the correct logo branding and it should be done for all brand templates that you want to use.
The integration mechanism is very easy. Go to 'Utilities' 'Integration Code' section of the module and follow the instructions given there, depending on the version of your WHMCS and the templates you use.
Note: Integration code may differ according to the module version you are using and be different for previous versions of WHMCS. Underneath, you can see the latest integration code.

MB2 8.png
12. And that is all, you have completed the installation of the module.

Configuration and Management

In this section we will show you how to properly set up and use Multibrand For WHMCS.


In the 'Brands' tab you can create and manage your brands using a single instance of the WHMCS platform.

Note: If you have not used any of previous Multibrand versions before, after the module's activation, the first brand will be created automatically by default based on the main settings of your WHMCS.

New Brand

Let us start by creating a new brand. For that purpose, go to the 'Brands' tab and press 'Add a new brand' MB2 Plus.png button.
MB2 10.png
Fill out the brands's 'Name' and 'Domain' with desired values and press the 'Save' button.
MB2 11.png
Your first brand is ready. Remember that you can duplicate your brands at any time.
Next, click the 'Edit' ' MB2 Edit.png action button.
MB2 11 1.png
You will be moved to the brand configuration area, where you can manage your brand's information and settings.
MB2 11 2.png

Note: Once the configuration of your brand is complete, you will need to set up a CNAME DNS record before the brand is published (status - enabled).
This record will point the branded domain towards your main domain used by WHMCS. To learn more about setting up the CNAME records, proceed to this section.
Do not forget to publish the brand as soon as the CNAME record is spread worldwide.

Brand Information

In the 'Brand Information' window, you can edit the brand name, domain name and custom logo.

In addition, you can see the current month's revenue, total sales and the last update.

MB2 9.png


In this window you will be able to configure the most important settings of your brand, including billing, payment gateways, SMTP and email templates configuration.


In the general settings, you will configure the main options of a brand.

First, fill out the brand's 'Email Address', 'Company Name' and 'TOS URL' . Next, choose the brand's 'Color', 'Ticket Departments' , 'Default Language', 'Template' and 'Order Template' .
Optionally, you can provide a branded 'System URL' if your WHMCS installation shall be accessed based upon the location of the files on your webserver and not from your branded domain.
Also, make sure that the chosen template is integrated with Multibrand correctly (see the Integration Code section).
Finally, you can toggle 'Products/Services Branding', 'Price Override' and 'Auto Client Assignment' if you wish to.
Allow clients to freely switch between brands they are assigned to, by enabling the 'Brand Switcher' - a new option i the navigation menu in the client area will appear.
You can also manage the current status of your brand here, but you should change it to 'Enabled' only after you have configured the rest of the settings.
Do not forget to press 'Save Changes' .

Important: Every brand must have its dedicated ticket department assigned. Please create in your WHMCS support ticket departments with branded email addresses, that is associated with the brand domain.
Note: If you want to add a new user through API you have to use the 'brands' parameter. This parameter must be an array, for example: 'brands' => array(5)

MB2 11 3.png


In the 'Billing' settings, you can configure the design of your invoices.
  • Invoice Pay To Text - the address displayed on the invoice as the 'Pay To' details.
  • Proforma Invoice - in enabled, only paid invoices will be marked with a sequential number.
  • Invoice Number Branding - if enabled, the invoices will be branded with the number and basic information.
  • Zero Invoices Number Branding - If enabled, invoices with total 0 will receive another brand number.
  • Sequential Invoice Number Format - if invoice branding is enabled, the provided sequential invoice number format will be used.
  • Next Sequential Number - change this option only if you want to reset the automatic sequential numbering. Otherwise, leave empty.
  • Brand Currencies - you may choose the currencies that will be supported by the brand.
  • Default Currency - set the default currency that will be displayed for clients that are not logged in.

Note: Remember to complete the 'Additional Settings' step during the module's installation to render the PDF invoices branded as well.

MB2 12.png

Payment Gateways

This tab allows you to configure a payment gateway for the brand operating independently of the one configured in WHMCS.

You can check the list of the currently available gateways in the Feature List.
If you are interested in using a payment gateway that is not yet available, please contact our Support Team and we will try our best to implement it in the future releases.

To add a new payment gateway configuration, press the 'Add' MB2 Plus.png button.

MB2 13.png
Next, choose the desired gateway from the list and click on the 'Confirm' button.
MB2 14.png
Finally, fill out the payment gateway settings according to the details received from the provider.

Save the configuration and activate the gateway.

MB2 15.png
Note: Multibrand For WHMCS can work with any gateway available within your WHMCS system. These gates will have a (WHMCS) label.

The only limitation is that these payment gateways use the same settings for all brands.

MB2 15 2.png


If you would like your brand to use an outgoing email configuration which is different from the one in the main WHMCS settings, you can do it here.

In addition, you can set your custom CSS email styling as well as the header and footer content.

MB2 16.png
Note: Please remember that the following merge fields can be used for 'Email Header Content' as well as 'Email Footer Content' .
Company Name {$company_name}
Domain {$company_domain}
Logo URL {$company_logo_url}
WHMCS URL {$whmcs_url}
WHMCS Link {$whmcs_link}
Marketing Unsubscribe URL {$unsubscribe_url}
Marketing Optout URL {$email_marketing_optout_url}
Marketing Optin URL {$email_marketing_optin_url}
Signature {$signature}
Full Sending Date {$date}
Full Sending Time {$time}

Email Templates

In this window you can set up each branded email template in five available categories.
  • If enabled, the template configured here will be sent to the clients using the branded SMTP settings instead of the ones configured in the main WHMCS template and configuration.
  • If enabled, but not configured yet, the main WHMCS template will be sent with branding applied to it.
  • If disabled, the main WHMCS template will be sent using the main WHMCS SMTP configuration without any branding applied.

To start editing a branded template, simply press the 'Edit' MB2 Edit.png button.

MB2 17.png
Next, type in the email addresses to send the copy and, if needed, the blind copy to, enter the desired subject and message content. You can also create more versions, in different languages.

Additionally, along with editing the source code of a template you can use the available merge fields tags just like in the standard email templates.
Save the changes once you have finished.

MB2 18.png
Finally, enable the edited template and save the configuration. You will see the 'Branded' label next to the edited template.

If you would like to restore the default template, simply return to its edition and click the 'Delete Template' button.

MB2 19.png

Services Pricing

In this section you can configure separate prices for products, addons, domains and bundles .

Note: Remember that the 'Price Override' option has to be enabled. Otherwise, the service prices will still be taken from the main WHMCS settings.
To start, select the product, addon or domain tab and click the 'Add' MB2 Plus.png button. In the following example you will see how to add branding for product pricing.

MB2 20.png
Select the product for which you want to set branded prices and click 'Save' .
MB2 21.png
Or you can add all your products at once thanks to 'Bulk Action' , just press the button marked with the red arrow.
MB2 212.png
Next, open the pricing editor of the chosen product.
MB2 22.png
Here you can configure the desired prices in selected billing cycles and currencies.

You can also automatically fill out the amounts from the main product and update them, refreshing the currencies rate.

Note: Availability of billing cycles, prices and currencies to be edited depends on their main configuration in WHMCS.
If one of them is not available for branding, it means that there is no corresponding configuration in the main WHMCS.

MB2 23.png
From now on, the pricing for this product will be branded. You can also configure pricing for addons and domains in the same way.


In this section you can see which Clients, Services, Invoices, Quotes, Tickets, Knowledgebase, Downloads, Announcements, Promotions, Billable Items and Emails are assigned to this brand.

In addition, you can manually manage, assign and unassign selected items to the brand.
Do not forget to check the 'Branded Admin Area Functionalities' section, where you will find more brand relation management functionality outside the Multibrand addon.

Note: Currently there is no option of mass management, assigning and unassigning selected items to the brand. This functionality is planned to be implemented in future releases.

Additionally, if you would like to change any relation between brands, remember that first you have to unassign (delete) that relation from the previous brand, and only then can you add that relation to the second brand.
Otherwise, the changed item might not appear in the search box of the added relation.


In the 'Clients' tab you can see customers who are assigned to the brand and the date on which they were assigned.

Assignment takes place at the moment of client's registration for the branded domain. You can also manually assign the already existing customers to the brand or migrate them to another.

Note: If the 'Auto Client Assign' option is enabled, then the customers who are already registered in one of the brands and try to log in to another brand will also be automatically assigned to it.
Therefore, one customer can be assigned to several brands at the same time.

MB2 24.png
To assign an existing client to the brand, press the 'Add' MB2 Plus.png button.
  • Type - decide if you want to assign a single client, groups of clients or all of your clients. Choose the preferred option from the dropwdown menu.
  • Add All Items - enable if you want to assign services, invoices, quotes, tickets etc. along with your client or groups of clients.

Do not forget to click 'Save' .

MB2 25.png
You can also migrate the customers from this brand to another one.

Click on the 'Migrate' MB2 Migrate.png button next to the client and then select the brand to which you want to assign this client.

MB2 26.png
And finally, if you want to delete a customer's relationship with this brand, click the 'Delete' MB2 Delete.png button or choose several items to be removed at once MB2 Mass Delete.png and confirm the action.


In the 'Services' tab you can see which Services & Products, Addons and Domains have a relation with this brand.

These are automatically added to the brand while ordering from the branded domain.

MB2 27.png
You can also manually add a relation for a service that is not branded yet.

Press the 'Add' MB2 Plus.png button and then select a type and service you want to assign to the brand.

MB2 28.png
Again, if you want to delete a service relation with the brand, press 'Delete' MB2 Delete.png button or choose several items to be removed at once MB2 Mass Delete.png and confirm the action.


In this tab you can see which invoices have a relation with your brand.

These invoices are automatically added to the brand after an order has been created from the branded domain.

MB2 29.png
You can also manually add a relation for the invoice that is not branded yet.

Press 'Add' MB2 Plus.png and select an invoice you want to assign to the brand.

MB2 30.png
If you want to delete an invoice relation with the brand, press the 'Delete' MB2 Delete.png button or choose several items to be removed at once MB2 Mass Delete.png and confirm the action.


In this tab you can see which quotes have a relation with your brand.

These are automatically added to the brand after an order has been created from the branded domain.

MB2 q29.png
You can also manually add a relation for the quote that is not branded yet.

Press 'Add' MB2 Plus.png and select a quote you want to assign to the brand.

MB2 q30.png
If you want to delete a quote relation with the brand, press the 'Delete' MB2 Delete.png button or choose several items to be removed at once MB2 Mass Delete.png and confirm the action.


In this tab you can see which tickets have a relation with the brand.

These tickets are automatically branded after a ticket has been opened in one of the earlier branded departments.

MB2 31.png
You can also manually add a relation for the ticket that is not branded yet.

Click on 'Add' MB2 Plus.png and select the ticket you want to assign to the brand.

MB2 32.png
If you want to delete a ticket relation with the brand, press the 'Delete' MB2 Delete.png button or choose several items to be removed at once MB2 Mass Delete.png and confirm the action.


In this tab you can see which of your knowledgebase articles have a relation with the brand.

In addition, here you can find various statistics of views, useful points, number of votes and the date of assignment to the brand.

MB2 33.png
To add a relation for the knowledgebase articles, press 'Add' MB2 Plus.png button and select the article you want to assign to the brand.
MB2 34.png
If you want to delete a knowledgebase article relation with the brand, press the 'Delete' MB2 Delete.png button or choose several items to be removed at once MB2 Mass Delete.png and confirm the action.


In this tab you can see which of your files available for download have a relation with the brand.

In addition, here you can find a download category, type, number of downloads and the date of assignment to the brand.

MB2 35.png
To add a relation for the download, press the 'Add' MB2 Plus.png button and select the file you want to assign to the brand.
MB2 36.png
If you want to delete a download relation with the brand, press 'Delete' MB2 Delete.png button or choose several items to be removed at once MB2 Mass Delete.png and confirm the action.


In this tab you can see which of your announcements have a relation with the brand.

In addition, here you can find the date of announcement creation, assignment to the brand and the published status.

MB2 37.png
To add a relation for the announcement, press the 'Add' MB2 Plus.png button and select the article you want to assign to the brand.
MB2 38.png
If you want to delete an announcement relation with the brand, click on the 'Delete' MB2 Delete.png button or choose several items to be removed at once MB2 Mass Delete.png and confirm the action.


In 'Promotions' you can assign promotions to specific brands.
MB2 37 1.png
To add a promotion, press the 'Add' MB2 Plus.png button and select the one you wish to assign to the brand.
MB2 38 1.png
If you want to delete a promotion relation with the brand, click on the 'Delete' MB2 Delete.png button or choose several items to be removed at once MB2 Mass Delete.png and confirm the action.

Billable Items

Under this tab you can see the list of created relations with billable items containing the client name, hours, and invoice details.
MB2 37 3.png
To add a billable, press the 'Add' MB2 Plus.png button and select the one you wish to assign to the brand.
MB2 37 4.png
If you want to delete the relation between the billable item and the brand, click on the 'Delete' MB2 Delete.png button or choose several items to be removed at once MB2 Mass Delete.png and confirm the action.


The last tab contains the list of all branded email messages that have been sent to your clients.
MB2 37 5.png
To add an email message to a chosen brand manually, press the 'Add' MB2 Plus.png button and search the email you wish to assign.
MB2 37 6.png
If you want to delete the relation between the email message and the brand, click on the 'Delete' MB2 Delete.png button or choose several items to be removed at once MB2 Mass Delete.png and confirm the action.


In the 'Statistics' section you will find sales charts of selected brands.

You can filter them by the date period and selected brands as well as choose whether to display statistics based on the paid invoices only or all invoices altogether (the unpaid ones included).

MB2 39.png


'Logs' section allows you to view warnings and errors related to your brands.

Owing to the automation settings you can remove all logs or automatically delete them at a chosen time.

MB2 40.png
The 'Auto Clear' option enables you to clear logs on the daily cron run.
You can also enter a fixed number of days so when that time passes, the logs are automatically removed.
MB2 409.png

Tickets Mail Import

The following section enables you to automatically define a brand email relation in order to automatically import messages sent to an email address into the support ticket system.
Accordingly, clients will be able to open and reply to tickets outside the client area.
MB2 TP40.png

Branded Admin Area Functionalities

The module allows you to display information about the brand on the list of:
  • clients
  • services
  • invoices
  • quotes
  • tickets
  • knowledgebase articles
  • downloads
  • announcements
  • promotions

You can also directly select the brand when adding a new:

  • client
  • order
  • quote
  • ticket
  • knowledgebase article
  • announcement
  • download
  • sending a new message to a client

In the following sections you can find examples of such integration.


Multibrand For WHMCS makes the management of WHMCS easier through the introduction of the 'Brand Details' column.

This column informs you about the membership of clients and invoices to a certain brand (more details will be added soon).
Let us see how it looks in the 'Client List'.

MB2 48.png
It looks similar in the 'Invoice List'.
MB2 49.png

Client Profile

In the client's 'Profile' tab you also have the possibility to choose customer brand assignment.
MB2 49 2.png
Select branding email messages when resetting their password. Find this option in 'Users' tab in the 'Manage User' dropdown menu:
MB2 49 3.png
MB2 49 4.png

Order Creation

If the administrator wants to manually create an order for a client, he/she can directly create a relation with the selected brand (provided that the client belongs to it).
Additionally, they can also assign a payment gateway available in the given brand.
MB2 42.png


If the administrator creates a new invoice for a customer, he/she has the possibility to select a direct relationship with the given brand.
MB2 43.png
Additionally, there is also a possibility to change the brand relation directly for the previously created invoices.
MB2 44.png
In other categories, the integration with brands is applied similarly.

Branded Client Area

Multibrand For WHMCS offers multiple client areas in one solution and allows you to have your clients assigned to them.

For example, each brand domain can have a separate template, logo, language, services and invoices.
You can find more information about what other functionalities can be branded in the Features list.

MB2 45.png
On the following screen you can see invoices generated for a brand.
MB2 46.png

Branded Emails

Brand configuration applies also to emails sent to clients.

If you have enabled branding of a given template, the email sent to the client will be sent using the mailbox specified in the SMTP settings of the given brand.
Additionally, the subject, logo, content and signature will be branded accordingly too. Here you can see an example of an order email.

MB2 47.png
You will find more information in the branded Email Templates configuration.

Branded Domains & Aliases Configuration

In this section you will find guides on how to create branded domains and aliases in popular control panels.
Please keep in mind that there are multiple combinations, that may occur. Take a closer look to find a perfect solution for your case.

Apache2 / NGINX

If there is no cPanel/DirectAdmin/Plesk panel on your server, then all you need to do is modify the current configuration:
  • for NGINX - add the additional domain name in the server_name line (read more)
  • for Apache - add the additional domain name into the ServerAlias line (read more)

cPanel / DirectAdmin / Plesk Servers

Same Server + One Account/Subscription

This configuration of Same server + One Account/Subscription assumes that all domains are added within one account/subscription on a given server.
In this case, simply add an additional domain so that it points to the same directory as the WHMCS main domain points to. If a given panel has 'Aliases' option in its offer, you can also use it.

Same Server + Multiple Accounts/Subscriptions

Such scenario (Same Server + Multiple Accounts/Subscriptions) is not feasible.
This is due to the way web panels work (separation of users), not the module limitations.

Separate Server

A separate server - in this situation the branded domain is added to other DNS server. It might be added to, for example cloudflare, or it is added and used on another server, for example cPanel or DirectAdmin.

Take a look at the exemplary situation. Let's say there are two domains:

  • domain on server 'X'
  • domain on server 'Z' ('Z' can be a 'cPanel' server or a 'DNS' service)

In order to process it correctly, follow the below steps:

  • add an addon domain or an alias with the domain to server 'X', so that it points to the main domain, that is in our case
  • add a DNS record to the server 'Z' (note it can be e.g. cPanel or DNS service)
    • add a record 'A' pointing to the server 'X' IP address
    • or add a CNAME record pointing to the main domain, that is' in our case

SSL Certificate

In this section you will find all information about the SSL certificate in WHMCS required to use Multibrand For WHMCS properly.

If either your branded domains or WHMCS domain use the SSL connection, they should also support one of the below certificates.
The supported types of certificates:

  • Dedicated SSL Certificate - handled separately for each domain.
  • Wildcard - if all brands and main WHMCS use the same domain.
  • SAN - if your brands and main WHMCS use different domains.

This is the way WHMCS works. It cannot be considered the limitation of our module which uses the 'WHMCS System URL' scheme.


Installing the SSL certificate for domains managed from cPanel consists of the following steps:
1. Log in to your cPanel and press 'SSL/TSLS Manager' under the 'Security' section.
2. Click on 'Manage SSL sites' under 'Install and Manage SSL for your site (HTTPS)'.
3. (installing the certificate) Select the domain, paste the certificate along with the private key, and save the settings.
4. (using the already installed certificate) Select the certificate from 'Browse Certificates' , and save the settings.
Alternatively, you can enable the AutoSSL solution that will automatically install domain-validated SSL certificates. Go here for more information.

Note: AutoSSL function is unlikely to work for the CNAME entries, and therefore you should use virtual hosts (vhosts) instead.

Branding Limitations

Version 2.4.0

With the aim of better stability and support for future improvements, Multibrand For WHMCS has been completely rewritten in the 2.0 version.

For this reason, some of the functionalities are not yet available or are operating in a limited way.
These features will be successively restored in the future versions. Below you can find the features that are still not yet supported:

  • Brand Reports - the current statistics are limited.
  • Brand Previews - the preview of the brand in the client area is not yet implemented.


In this section we will list those elements of WHMCS that cannot be branded or may be working in an improper way.
  • Bridges - Multibrand For WHMCS does not support any kind of bridges (WordPress, Joomla, WHMCS Bridge Pro, etc.).
  • Link replacement - currently, links are replaced with their branded counterparts with a visible delay.
    This is the only feasible way to proceed for the time being.
  • Configurable Options Pricing - currently, there is no possibility to set a different pricing per brand for configurable options.
  • Emails - not branded due to the lack of possibility to determine the brand that the email should be sent from:
    • Affiliate Monthly Referrals Report
    • Clients Only Bounce Message
  • WHMCS V6 - Multibrand For WHMCS 2.X will no longer support WHMCS V6 and template five. Use Multibrand For WHMCS 1.X instead.

WHMCS Modules and Others

In this section we will list the WHMCS modules and other services which do not support multibranding or do not cooperate with Multibrand For WHMCS at all.

  • Others
    • Cloudflare - it is a service that will mask your server IP address.
      This is because they use their own DNS to resolve to one of their many reverse proxy servers and will cause the incompatibility with Multibrand module.
      You may disallow the CloudFlare network to assume NS authority and not become the intermediary between the user and your server, but then your Cloudflare service may become unproductive.

Integration with MetricsCube

MetricsCube is a platform that will empower you to gain insight into your business almost effortlessly.
All you need to do is sign up and integrate with your WHMCS application to get real-time access to over 70 detailed reports with powerful filtering and comparing tools.

Multibrand For WHMCS module can be very easily integrated with this external platform.
There are no additional steps you need to take to enjoy the integration. Simply synchronize MetricsCube platform with your WHMCS installation with Multibrand module active.
It will be automatically detected by the platform and additional filtering tools will become available.
From now on, whenever you access most of the MetricsCube reports, they will include the brand filter, showing the data per specific WHMCS company.

MB2 50.png


1. The logo image is usually hard coded into the WHMCS template files.

In order to use the logo file provided in the 'Multibrand For WHMCS' module, find the proper line in the template file and replace it with '{$logo}' variable.
The line responsible for the displayed logo is placed in the 'header.tpl' file located in the currently used template.

2. If you want Captcha security option to be displayed in your client area for all branded domains, you need to configure each of those domains in your Google Account as well.
MB2 41.png
3. Note that it is not possible to merge tickets from different brands.
4. Performing the 'Send Message' action on a clients list will result in sending branded emails only to the clients who are assigned to an individual brand.
5. If you would like to use Google reCAPTCHA for brand storefronts, you need to add domain addresses of those brands to the reCAPTCHA configuration. To do so, please proceed here.
MB2 41 1.png
6. Please remember that if you upload a brand logo that is too big, too small, or has unusual proportions, it may result in its incorrect scaling in templates, emails, or on invoices.
To avoid that, please make sure that you are familiar with WHMCS logo requirements that can be found here.

Update Instructions

An essential guidance through the process of updating the module is offered here.

In order to migrate the data from the 1.8.X version, simply activate the new module addon.
The data from the previous version will be automatically transferred to the new one. Make sure that all necessary data have been migrated correctly.
Afterwards, you can deactivate the currently used Multibrand version and start using the new one.

Uninstallation Process

If you no longer wish to use Multibrand For WHMCS, you may safely uninstall the module. Steps to follow to successfully and safely remove the module from your system:

1. Remove the integration code.
2. Remove the following files:

  • /includes/hooks/multibrand/
  • /includes/api/mbaddbillableitem.php
  • /includes/api/mbsendemail.php
  • /templates/six/invoicepdf_rename.tpl
  • /templates/six/quotepdf_rename.tpl
  • /modules/addons/Multibrand/

3. Remove all tables that begin with Multibrand_ from the database.

That is all, the module is completely uninstalled now.

Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Multibrand For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. If your CNAME record is not working, remember that the first domain name in the CNAME record should be a branded domain.

The second one is the domain on which you have your WHMCS. The redirection goes from the first domain to the second.
Full stops after domains are also important.
Please note that there could be a delay with propagation of changes for DNS servers while using A type CNAME records.

3. Please remember that Multibrand For WHMCS is guaranteed to work smoothly with 'Six', 'Twenty-One' And 'Lagom' templates.

If you are using some custom template, please be mindful that the module may not combine well with it out of the box, which may result in unexpected errors.
In this case, you can take advantage of our Template Integration service and have all interface elements carefully harmonized by our team.
You can order Template Integration together with the module as well as, at any time later on, in the client area - in the "Services" section of your product's page.

4. Since Multibrand For WHMCS and Resellers Center For WHMCS both come with separate pricing configuration, we do not recommend using them in one WHMCS installation.

Due to possible malfunctions in branding, we also advise against using Multibrand For WHMCS with the following modules:

Integration between these modules is hampered because of the specific functions that each of them offers as well as their individual workflow.
This includes but is not limited to separate email templates used or common hooks that override one another.
We are continually working on overcoming these limitations wherever possible.

5. If you intend to use Hosting Renewals For WHMCS, please take note of the following issue concerning the module's discounts calculation.

In order for the discounts to be based on the prices settled in Multibrand For WHMCS, you must set the Hosting Renewals 'Apply Recurring Amount From Service Settings' option to 'Enabled'.
Otherwise, the price cuts will be estimated according to the main prices of the WHMCS products, not the branded ones.

6. Integration between Domain Orders Extended For WHMCS and Multibrand For WHMCS module is slightly limited.
Please be aware that only the main brand works flawlessly with the mentioned module, branding is not supported for Domain Orders Extended yet.
7. If you are using HTTPS, remember to implement a redirect from HTTP to HTTPS on the branded domain.

Otherwise, WHMCS will route visitors to the main WHMCS and not the brand. Keep in mind that when WHMCS creates the redirection, the domain is changed as well.

WHMCS Modules
WHMCS Widgets
cPanel Modules
Multibrand For WHMCS