WHMCS – Configuration Questions

Integrating WHMCS 8 with your 20i Reseller Account

1. Overview

How do I import StackCP Users from a CSV file?

20i Resellers can import StackCP Users from a CSV through the My20i control panel.

To do so, head to StackCP Users > Import Users from CSV. The CSV must have the following headings, and each cell must be wrapped in quotation marks, with empty cells filled with two quotation marks (i.e., "").

CSV Headings from left to right.

Name
Email
Company Name
Company Number
Trading Name
Address
City
County
Postcode
Country Code
Phone Number

Note: If you're using a program such as Excel, your CSV may be formatted to not show the quotation marks. You can try opening the CSV in a program such as Notepad to check the formatting.

Reseller Hosting

WHMCS

WHMCS – Configuration

Austin B.

Can I use WHMCS with my Reseller Hosting Package?

Yes - you can absolutely use WHMCS with our platform. We offer a WHMCS module that integrates perfectly with our platform.

Reseller Hosting

Reseller Hosting – Reseller Account

WHMCS

WHMCS – Configuration

Austin B.

How do I change the license key WHMCS uses?

As a 20i reseller, you can buy a discounted WHMCS license. If you have a pre-existing WHMCS license, you'll then need to change the license key in your WHMCS system.

To do this, log in to the admin area and go to Help > Change License Key.

You can then enter your new license key, along with your admin login details to verify the change.

If you are getting a 'license invalid error' - so that you are unable to login - there is a link to the Change License page from that error page.

Further instructions can be found at: WHMCS Support - Licensing.

If you don't want to worry about licenses at all, you can use 20i's free alternative to WHMCS, HostShop!

Reseller Hosting

WHMCS

WHMCS – Configuration

Austin B.

Integrating WHMCS with your Reseller Account

1. Overview

Reseller Hosting

Reseller Hosting – Reseller Account

WHMCS

WHMCS – Configuration

Austin B.

How do I link services and users to WHMCS?

Linking Services

Under some circumstances, you may want to set up a service as if it had been purchased via 20i on your WHMCS install. This may include cases where you've migrated your Reseller Hosting from another WHMCS provider and want to continue to provide the same services to your existing customer. Linking the existing service that you have set up in WHMCS with 20i means that your customers can log in and manage the hosting through their own WHMCS login.

Manual method:

Log in to My20i.
Go to Manage Hosting
Click Options -> Edit on the package you're looking for
Copy the ID number from the header
Go to the Product/Service in WHMCS Admin
Paste the ID number into the "packageId" field near the bottom

Autodetect method:

Go to the Product/Service in WHMCS Admin
In the "packageId" field near the bottom, type an asterisk ' * '

Autodetect only works when you have a package with a name which exactly matches the domain name in WHMCS. The behaviour is undefined if you delete and recreate a package, or move a domain name between packages.

Linking Stack Users

If you've set up Stack Users, you may want to link them to an existing client set up on WHMCS so that your customer can access all their services from within WHMCS without having to go back to your StackCP site. This is only applicable to existing unlinked Stack Users, as new Stack Users are set up automatically whenever a new order is placed in WHMCS.

Note: Imported users will not have their access changed, so you may also want to review which services they have access to.

Manual method:

Log in to My20i.
Go to StackCP Users
Click Options -> Edit on the User you're looking for
Copy the User reference from the header (something like "stack-user:42")
Go to the appropriate Client in WHMCS admin
Select Profile
Paste the user reference into your Stack User field near the bottom

Autodetect method:

Go to the appropriate Client in WHMCS admin
Select Profile
In your Stack User field (towards the bottom of the page), type an asterisk "*"

If you use autodetect, you should be aware that this may connect a Stack user which you didn't intend to allow access to. Autodetect only works when the WHMCS user email address exactly matches one of your stack user email addresses.

Note: WHMCS is still a very much liked billing and automation option for resellers. But there are more options on the market. You should read about WHMCS alternatives.

Reseller Hosting

WHMCS

WHMCS – Configuration

Austin B.

How do I enable the System Module Debug Log within WHMCS?

Enabling the System Module Debug Log within WHMCS can be useful if you're attempting to provision products and services via WHMCS, using our API module, but are unable to do so.

To enable the System Module Debug Log, you will first need to log in to WHMCS.

After logging in, browse to Utilities > System Logs

Select the Module Log under the Logs section on the left-hand side corner.

Then select Enable Debug Logging

Going forward, WHMCS will log and display responses produced by our platform/API.

WHMCS

WHMCS – Configuration

WHMCS – Common WHMCS Errors

Andrew Porter

Selling 20i Addons Through WHMCS

We've developed a bespoke provisioning and addon module for WHMCS that allows 20i Resellers to sell 20i addons directly through WHMCS. This now includes support for SSL certificates, Premium Mail, Mailbox Quota Addons, and Website Turbo.

SSL Certificate Product Configuration

There are three different SSL certificate products you can sell from 20i via the WHMCS module. These are:

GeoTrust Simple SSL Certificate
GeoTrust Rapid SSL Wildcard Certificate
GeoTrust Extended SSL Certificate

To sell these certificates, you will first need to create a new product group for SSL Certificate products; this group can be named as you choose. After that, click "Create a New Product." Set the group to the one you just created, with the type set to 'Other' and the name to one of the product names from above that you wish to sell.

Note: The product name must be typed exactly to match the checks made against the product name in the code.

Select 20i for the product module and create the product. Please ensure that your pricing options only offer annual pricing, as this is how SSL Certificate products are billed in 20i. Also, ensure that the 'allow multiple quantities' option is left unchecked. Furthermore, ensure the module settings are correct, then finally you'll need to add the following custom fields for the product (ensure each field is named correctly, as these fields are checked against in the code):

+--------------------+------------+------------+----------------+--------------------+-----------------+
| Field Name         | Field Type | Admin Only | Required Field | Show on Order Form | Show on Invoice |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| Domain             | Text Box   |            | X              | X                  | X               |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| subdomain          | Text Box   | X          |                |                    | X               |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| contact_type       | Text Box   | X          |                |                    |                 |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| contact_first_name | Text Box   | X          |                |                    |                 |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| contact_last_name  | Text Box   | X          |                |                    |                 |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| contact_company    | Text Box   | X          |                |                    |                 |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| contact_email      | Text Box   | X          |                |                    |                 |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| contact_phone      | Text Box   | X          |                |                    |                 |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| contact_address1   | Text Box   | X          |                |                    |                 |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| contact_address2   | Text Box   | X          |                |                    |                 |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| contact_city       | Text Box   | X          |                |                    |                 |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| contact_state      | Text Box   | X          |                |                    |                 |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| contact_postal     | Text Box   | X          |                |                    |                 |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| contact_country    | Text Box   | X          |                |                    |                 |
+--------------------+------------+------------+----------------+--------------------+-----------------+
| tlsCertificateId   | Text Box   | X          |                |                    |                 |
+--------------------+------------+------------+----------------+--------------------+-----------------+

Website Turbo

To add Website Turbo as an addon product for hosting packages, please first create a Website Turbo product in Setup > Product Addons. Select 'Independent Product' as the product type, and give the product a name of your choice. Then, choose the 20i module for automation and leave 'Auto-assign to products' turned off. Now you can enter your pricing options on the next screen. We strongly recommend that you configure pricing similar to how you have configured your hosting products, to which you wish to assign Website Turbo, and check the prorata billing checkbox.

Next, please ensure that the module settings appear as shown above and create a text box in the custom field tab with the name 'websiteTurboId', setting it to admin-only.

Finally, under Applicable Products, select the product group to assign this to, which will be the product group that contains your 20i hosting products.

Premium Mailboxes

If you haven't already, create a new product group for Premium Mailbox/Mailbox Quota Addon products, naming it as you choose. After that, click to create a new product. Set the Product Type as Other and set the Product Group as the group you just created; the Product Name must be set as 'Premium Mailbox'.

Note: The product name must be typed to match exactly as checks are made against the product name in the code.

Select 20i for the product module and create the product.

Please ensure that your pricing options offer annual pricing only, as this is how Premium Mailbox addons are billed in 20i.

Ensure 'Allow Multiple Quantities' is left unchecked. Ensure the module settings are correct. Then, you'll need to add two custom fields: a text box called 'Mailbox', which is a required field and can be displayed on the order form (not just in the admin area). This is the field that will store the selected mailbox. After that, you will need a custom field, which is admin-only and is called 'premiumMailboxId', which is a text box.

Mailbox Quota Addons

To add a Mailbox Quota Addon, create a new product group for Premium Mailbox/Mailbox Quota Addon products. You can name this to your preference. After that, click to create a new product. Set the Product Type as Other and set the Product Group as the group you just created, the Product Name name must be set as 'Mailbox Quota Addon (10GB)'.

Note: The product name must be typed exactly as it appears in the code, as checks are made against the product name.

Select 20i for the product module and create the product.

Please ensure that your pricing options only offer annual pricing, as this is how Mailbox Quota Addons are billed in 20i.

Ensure that 'Allow Multiple Quantities' is left unchecked. Ensure the module settings are correct. Then, you'll need to add two custom fields: a text box called 'Mailbox', which is a required field and can be displayed on the order form (not admin-only). This is the field that will store the selected mailbox. After that, we need a custom field, which is admin-only, called 'mailboxQuotaAddonId', that is also a text box.

Note: Whilst the Mailbox Quota Addon is an addon product, due to limitations in WHMCS, it must be created as an actual product. The module handles hiding this from unauthenticated users (as we have no knowledge of which packages and mailboxes they have), and the option to select a package and mailbox is handled during the order process.

WHMCS – Configuration

WHMCS

Jordan Graves

Selling Domain Names Through WHMCS

We've developed a bespoke provisioning and addon module for WHMCS that allows 20i Resellers to sell domain names directly through WHMCS. This includes support for all the different TLDs 20i offers.

Pre-Requisites

You must have a 20i Reseller account
You need a WHMCS installation (either existing or new)
If selling in multiple currencies, ensure each currency is enabled in WHMCS

Setting up 20i as the Domain Registrar

To get started, log in to your WHMCS admin panel and navigate to System Settings > Domain Registrars. You should then be presented with a list of available modules to activate from a variety of domain registrars/web hosts. You should see the 20i module towards the top of the list. Select the green Activate button for the 20i module and then click the Configure button.

From here, you will need to enter your combined API key into the Password field. You can leave the WHMCS Admin User blank, which will default to the Primary User and ensure that the StackCP User Custom Field is set to StackCP.

Now press Save Changes.

Note: If your WHMCS installation is hosted elsewhere, you'll need to ensure outgoing port 3000 is open to ensure our API can connect.

Use 20i for Domain Lookups

You can use 20i for the domain lookup service within WHMCS. To set this, navigate to System Settings > Domain Pricing. Towards the top right corner, under Lookup Provider, you can click Change and then select 20i as the domain registrar. You can also select Configure this to further configure the lookup provider.

WHMCS

WHMCS – Configuration

Jordan Graves

Selling Shared Hosting Through WHMCS

We've developed a bespoke provisioning and addon module for WHMCS that allows 20i Resellers to sell Shared Hosting packages directly through WHMCS. This includes support for all configuration types of operating systems and hardware configurations.

Pre-Requisites

You must have a 20i Reseller account
You need a WHMCS installation (either existing or new)
If selling in multiple currencies, ensure each currency is enabled in WHMCS.
You must first create your preset hosting package types.

Hosting Package Types

You must set up your hosting package types before creating a product that will use this hosting package type. When creating your product range within WHMCS, you must assign a package type to this product. This package type assigns the parameters of the hosting package that is provisioned. To learn more about hosting package types, please click here.

Configuring & Selling Shared Hosting via WHMCS

Once you have configured and created your hosting package types within My20i, you will need to create the products within WHMCS. To do this, head to System Settings > Product/Services.

Creating a new Product Group

Before you can create any products, you must first create a product group. This helps better assign products to the relevant category. To do this:

Select the Create a New Group button.
Fill in the required fields, such as Product Group Name, as well as any headline and taglines you may decide to add.
Select Save Changes once you are happy with the configuration.

Creating a new Product

To create a product, both an applicable package type and product group must be created. To create a new product:

Select the Create a New Product button.
Select Shared Hosting as the product type.
Select the product group you created previously.
Set a Product Name for your product.
Select 20i for the module.
And finally, click Continue.

Once created, select the Module Settings sub-section and select the Type Code dropdown menu. From here, please select the relevant hosting package type you created earlier. The 20i WHMCS module pulls this from your 20i account. Finally, set the StackCP User custom field to the StackCP User option. You can leave the WHMCS Admin User as the Primary User.

Next, go to the Custom Fields section and then create a new custom field. Enter "PackageId" for the field name, and select Admin Only. One done, select Save Changes.

Note: For each product/service you configure, you'll need to add a new custom field.

WHMCS

WHMCS – Configuration

Jordan Graves

How to update the 20i WHMCS module

Our WHMCS module integrates 20i services with the WHMCS Web Hosting Automation platform. It enables you to register domains, set up hosting accounts and sell Cloud Servers automatically through the WHMCS software. The module is updated frequently, releasing new features and bug updates, so it is important to remain updated with the latest version.

Note: Only 20i Resellers can access and use our WHMCS module.

To update the 20i WHMCS module, you essentially reinstall the latest module files over the existing ones. There is no automatic upgrade button, and so we will have to take the following steps.

Step 1: Download the latest module

Get the current release of the module from here.

Step 2: Backup your current module folders (recommended)

Within your current WHMCS installation, take a copy of these directories:

/20i

/modules

It may also be recommended to back up the entire WHMCS installation in case of misuse of commands. If you are a Timeline Backups customer, you can roll back to the last automatic snapshot, or create an on-demand snapshot.

Step 3: Replace the files with the new version

Extract the download, then upload/copy the new module directory into your webspace, just outside of your WHMCS installation directory. This directory will contain the important directories we will require. We'll now begin by replacing the old directories:

Replace /20i

Replace /modules

You can do this by following these commands.

mv public_html/20i public_html/20i~

cp -r module/20i public_html

cp -rf module/modules public_html

rm -rI public_html/20i~

Note: In this example, the WHMCS installation is located within /public_html, and the latest module directory is outside of this directory.

Step 4: Validate in WHMCS

After the file replacement, check in WHMCS admin that the 20i server/registrar modules still appear as available and operate normally (no further changes are usually required unless the release notes mention new settings).

WHMCS – Configuration

WHMCS

Reseller Hosting

Jordan Graves