WHMCS Documentation - User contributions [en]

Importing Data

2019-08-13T22:38:32Z

ChrisD: /* Manual Domain Only Entry */ corrected been to be in step 10

We understand that the majority of companies already have a billing system in place to manage their hosting clients and are worried by the difficulties of switching to a new billing system. With that in mind, we provide the following guides and automation scripts in order to make importing easy.

==ImportAssist==

When performing a migration from another billing system or WHMCS installation, please note that the previous import scripts have been deprecated as of WHMCS 6.0 and are now replaced with our new ImportAssist addon that supports multiple billing systems to import from. It supports Blesta 2/3, ClientExec, HostBill and merging other WHMCS installations. For detailed information on obtaining and using ImportAssist, please refer to [[ImportAssist]].

==Server Sync Tool==

<div class="docs-alert-info">This section refers to a new feature in WHMCS 7.8. To import services from a cPanel server when using WHMCS 7.7 and older, please refer to the cPanel/WHM Import section below.</div>

In WHMCS 7.8, we've introduced a new Server Sync Tool that can compare and sync details from cPanel, Plesk and DirectAdmin servers. This can be used to identify and import missing domains, sync usernames & package info and terminate inactive domains.

Detailed information on how it works and how to use it can be found at the [[Server_Sync_Tool|Server Sync Tool page]].

==WHM/cPanel Import Script==
When using WHMCS 7.7 or older, the WHM Import Tool can be accessed using the Utilities menu. This will allow you to import all the domains from your existing cPanel/WHM servers. Instructions for use can be found on the separate [[CPanel/WHM_Import|CPanel/WHM Import page]].

==Manual Client Entry==

To manually import your clients and their hosting accounts, you should use the following steps.

#Go to Clients > Add New Client
#Fill out the clients details - the minimum required fields are First & Last Name, Email Address & Password
#Click Add Client

Once the client has been added, you can proceed to add their hosting accounts. You do this as follows:

#On the client summary page, click the "Add New Order" link in the Actions panel
#The client will be preselected, so you should fill out the rest of the form - begin by choosing the payment gateway you want the client to pay with
#Next, choose the product/service and billing cycle the client pays by
#If the package comes with a domain, enter the users domain in the box provided. And if the domain is registered with you, you should select the "Register" option and choose any addons the user has for their domain.
#Ensure both tick boxes for sending an order confirmation and generating an invoice are unchecked so the user is not emailed about the order you are adding
#Finally, set the Order Status dropdown to Active and then click the submit button to add the order to WHMCS
#You will now be shown the order screen summarising the details of the order you just added
#Now as the final step, you must go into the products and/or domains page and set the correct next due date. To do this, from the order screen, click on the link in the Item column of the items ordered - this will take you straight to the details screen. From there, you can edit the next due payment date (and for hosting accounts select the correct server and enter the username for the account to allow suspensions & terminations to be performed by WHMCS)

==Manual Domain Only Entry==
To add a domain on it's own without a product, follow the steps below:

# If you haven't already, create the client by navigating to Go to Clients > Add New Client.
#On the client summary page, click the "Add New Order" link in the Actions panel
#The client will be preselected, so you should fill out the rest of the form - begin by choosing the payment gateway you want the client to pay with
#Leave the Product/Service dropdown menu set at None
# Leave the Billing Cycle dropdown menu set at Monthly
#Enter the domain in the Domain text field and select Register as the Domain Registration Option (even though you aren't intending to register it today)
#Choose the number of years you next want the client to be invoiced for at the time of renewal and tick any addons the user has for their domain
#Ensure both tick boxes for sending an order confirmation and generating an invoice are unchecked so the user is not emailed about the order you are adding
#Finally, set the Order Status dropdown to Active and then click the submit button to add the order to WHMCS
#You will now be shown the order screen summarising the details of the order you just added
#Now as the final step, you must go to the domain's information page to enter the correct next due and expiry dates aswell as selecting the registrar the domain is registered with if using one of the built in registrars. To do this, from the order screen, click on the link in the Item column of the items ordered - this will take you straight to the details screen.

You have now finished adding your client. By following the steps above, your client will have not been notified that you've added them and will now be invoiced by WHMCS prior to the next due date for the items you have added to their account.

License Troubleshooting

2018-05-25T09:48:05Z

ChrisD: Added "WHMCS-" to the list of license key prefixes

If you are encountering a licensing error when accessing your WHMCS installation's administration area, this could indicate that your server is unable to communicate with our license server. This page details the most common errors and provides some suggested resolutions.

==License Invalid==
A Licence Invalid error on the admin login page can be caused by one of the following changes:
*The license key has been entered incorrectly<br/>
Please ensure the full key is entered, this includes the prefix eg. "Leased-", "Owned-", "WebHost-", "WHMCS-" and "Dev-".
*The domain being used to access your install has changed
*The IP address your install is located on has changed
*The directory you are using has changed<br />
Following any changes to the location of your WHMCS installation, the licence must be updated accordingly. Please refer to [[Licensing#Moving_WHMCS|Moving WHMCS]] for instructions on doing so.

==Specific Errors==
===Required function base64_decode is not available===
This error indicates that your server has the required ''base64_decode'' function disabled in your PHP configuration. Please adjust your website's PHP configuration so as to enable the ''base64_decode'' function.

It may be necessary for the function to be added at the server level. The following links might be helpful in accomplishing this on your server:
* https://documentation.cpanel.net/display/EA4/EasyApache+4+Home
* https://docs.plesk.com/en-US/onyx/administrator-guide/web-hosting/php-management.70668/

If you need further assistance, you may need to reach out to your web host or systems administrator to resolve this.

===Required function is not available===
This error will appear when a necessary CURL function has not been installed on your server or is disabled in the configuration. The error message will specify the required function which has been disabled, eg:
*curl_init
*curl_setopt
*curl_exec
*curl_getinfo
*curl_error
*curl_close

All of these functions must be installed and enabled on your server in order to properly validate your license. You can check to see if these functions are available on your server by:
# Creating a PHP Info page, as described in the [http://php.net/manual/en/function.phpinfo.php#refsect1-function.phpinfo-examples PHP Documentation]
# Visiting the PHPInfo page in your browser
# Referring to the "disable_functions" section
# If the functions in the above listed are present under disable_functions, the functions are disabled on your server. It will be necessary to enable them to resolve the licence error.

The following links might be helpful in accomplishing this on your server:
* https://documentation.cpanel.net/display/EA4/EasyApache+4+Home
* https://docs.plesk.com/en-US/onyx/administrator-guide/web-hosting/php-management.70668/
* https://curl.haxx.se/docs/install.html

If you need further assistance, you may need to reach out to your web host or systems administrator to resolve this.

===Curl Error: Couldn't resolve host (6)===
A CURL code 6 error indicates an inability for your DNS to resolve the WHMCS licensing server. This could indicate a temporary issue with your DNS provider, or a larger misconfiguration.

If these points have been eliminated, check your Zone files for the presence of an entry for whmcs.com and remove it if found.

===Curl Error: Couldn't connect to host (7)===
A CURL code 7 error indicates an inability to connect to the WHMCS licensing server. This is typically caused by a firewall configuration. CURL uses port 443 for secure connections, so ensure that connections are permitted on this port.

===Curl Error: Problem with the SSL CA cert (path? access rights?) - 77===
See [[License Troubleshooting#Outdated Root CA Bundles|Outdated Root CA Bundles]]

===Curl Error: error setting certificate verify locations===
See [[License Troubleshooting#Outdated Root CA Bundles|Outdated Root CA Bundles]]

===Outdated Root CA Bundles===
The license validation is performed via an SSL connection. This helps to ensure the security and integrity of license checks.

Errors can occur when placing the CURL call using the "curlopt_ssl_verifypeer" function if your server does not have the appropriate root certificate authority (CA) bundles to validate the SSL connection to our licensing server. This can be caused by the CA bundle files being missing or outdated.

Note: This error does '''not''' relate to the validity or existence of an SSL certificate on your own website. The CA bundles referred to here are located on the server side at root level.

Frequently updated CA Root Certificates are available from your Operating System's repository or the cURL website at https://curl.haxx.se/docs/caextract.html

If you are unsure how to check for these certificates or update them, we recommend that you contact your web host or systems administrator for assistance.

===Other Curl Error Codes===
Other CURL error codes are detailed in the official documentation at https://curl.haxx.se/libcurl/c/libcurl-errors.html

Enom

2017-08-21T22:30:50Z

ChrisD: Corrected link to IP Registration under the section User not permitted from this IP address

{{registrar
| register = yes
| transfer = yes
| renew = yes
| lock = yes
| dns = yes
| whois = yes
| getepp = yes
| regns = yes
| dnsmanagement = yes
| emailforwarding = yes
| domainsync = yes
}}

==Configuration==

<div class="docs-alert-success">
<span class="title">Don't have an eNom account?</span><br />
If you don't yet have an account with Enom, you can register for one here: http://www.whmcs.com/partners/enom/
</div>

#Begin by going to '''Setup > Products/Services > Domain Registrars'''
#Locate eNom in the list of registrars and click the Activate button
#The eNom configuration screen will then be displayed
#Enter your eNom username and [https://www.enom.com/apitokens API Token]
#Click Save

[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=0Sz9mkBzLN0&hd=1|Watch Video Tutorial]]

<div class="docs-alert-warning">
<span class="title">Register your IP with eNom</span><br />
Access to eNom's API is restricted by IP address so you will need to register the IP address from which you will be connecting to your account with them. See the '''IP Registration''' section below for details of how to do this.
</div>

==IP Registration (User not permitted from this IP address)==

In order to use the Enom API, you must first contact them and let them know the server IP address where you will be connecting from (the server IP address where you have WHMCS installed). This is part of Enom's security measures to prevent unauthorised users being able to submit registration requests to your account.
*Login to your account on the [https://www.enom.com/resellers/reseller-account.aspx Enom website],
*Navigate to '''Resellers > Manage > API'''
* Enter your server's IP address into the "New" field,
* Click "add".

==Test Mode==
To use the Enom test mode, it's not as simple as ticking the test mode option in the configuration area. You must setup an account separately on the dedicated demo system they offer. In your Enom account navigate to Resellers > API > Test Account and click all three links under "Test Interface Options": http://www.enom.com/resellers/ResellerTestAccount.asp

With the Test Mode checkbox ticked you can now place domain registration orders in WHMCS, the domains will appear on your demo Enom account @ http://resellertest.enom.com but no domain will actually be registered and you will not be charged.

==Expiry Date Syncronisation==

WHMCS can sync the expiry dates of domains you have registered with Enom. This is particularly useful for domain transfers where the expiry date cannot be calculated automatically. This can be enabled under [[Domains_Tab#Domain_Sync_Enabled|Setup > General Settings > Domains Tab]].

==Notes==
===.ca Registrations===
.ca Registrations require additional fields. A common error "Invalid registrant information" is caused by the location field. Instead of entering the full place name you should use one of the following province abbreviations:

*Alberta - AB
*British Columbia - BC
*Manitoba - MB
*New Brunswick - NB
*Newfoundland and Labrador - NL
*Northwest Territories - NT
*Nova Scotia - NS
*Nunavut - NU
*Ontario - ON
*Prince Edward Island - PE
*Quebec - QC
*Saskatchewan - SK
*Yukon - YT

===Upsell ID Protection===
We have created some 'copy & paste' ready code for adding to the order templates to promote the ID Protection service within the order process and change it from being something users have to opt-into to being an addon that's enabled by default that they have to opt out from instead. For more information refer to [[Enom ID Protection Promo]].

==Common Problems==
===User not permitted from this IP address===
This error message indicates that you haven't yet allowed your server's IP to [[#IP Registration (User not permitted from this IP address)|access your eNom account via the API]]. You have to do this by opening a ticket to eNom's API department before you can use the integration.

The IP you need to authorize is typically the main shared IP of the server, usually most easily found from the IP your WHMCS license is assigned to, but if you're unsure or neither of those IPs work, then eNom can assist and advise you of the IP they see your connection tests as coming from via a support ticket.

===Cannot parse empty response from server/Empty data response from server - Please try again later===
This can occur only if an empty response is received from eNom. This isn't a curl error, but an empty response from the eNom API. This suggests a temporary problem at eNom's end. Trying the command again later should be successful.

===Invalid data response from server - Please try again later===
This can occur when an unexpected response occurs. EG a 404 error or other non-XML method. This suggests a temporary problem at eNom's end. Trying the command again later should be successful.

===CURL Error===
A standard curl error which indicates a connection issue between your server and eNom's API. Please ensure your server is able to make cURL calls to the following URLs:

Demo mode: resellertest.enom.com<br/>
Live: reseller.enom.com

{{modules}}

Premium Domains

2017-04-17T23:57:38Z

ChrisD: /* Hooks */ Fixed formatting of links

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

Premium Domains are names with short, common or desirable words. Usually providing a more memorable web address for a premium price.

==Enabling Premium Domains==
Premium Domains require that you have a Domain Lookup provider selected that supports them.
[[File:lookup_provider.png|thumb|Selecting a Domain Lookup Provider]]
To configure your Domain Lookup Provider, go to Setup > Products/Services > Domain Pricing and click the Change button below your currently configured provider. This will provide a list of registrars that support Domain Lookups and Suggestions. Click on a registrar, and if required, additional lookup configuration will be provided. Once configured, click on Save on the modal popup window to save the domain lookup configuration.

Once a Lookup Provider that supports Premium Domains is selected, Premium Domains can be enabled in WHMCS in Setup > Products/Services > Domain Pricing. Once enabled, the configuration of percentage markups will become possible.

===Supported Registrars===
Premium Domain support is available when using the following registrars for WHOIS lookups:
* [[Enom|eNom]]
* All Logicboxes Modules ([[ResellerClub]], [[ResellerCamp]], [[NetEarthOne]] and [[Stargate|UK2 Group/StarGate]])

==Pricing Bands==
<div class="docs-alert-info">Returned Premium Prices will be in the currency configured for the registrar account. The currency of the registrar account must be available in Setup > Payments > Currencies.</div>
[[File:pricing_bands.png|thumb|Pricing Bands in WHMCS]]
Premium domain cost prices are fetched in real-time from domain registrar APIs. The price markups are applied as defined in the configuration. Markup percentages are based on bands, which can be defined as required.[[File:premium_domains_ordering.png|thumb|Ordering a Premium Domain]]
Premium pricing levels are configured as up to, but not including, the price entered.
Once enabled, ordering a domain, in the Client Area, that the registrar deems premium will have the markup applied.

==Renewals and Recurring Price==
Registration for premium domains is only possible for 1 year. After buying, the domain is considered premium if a premium renewal price is available.

The current raw renewal cost, in the Client currency, for a premium domain is under the Recurring Amount field. Consider the raw cost when making any manual changes to the recurring amount. [[File:premium2.png|thumb]] Checking the automatic recalculation box will recalculate the recurring cost for the domain on save.
The raw cost does not include any markup that will be applied.

==Premium Domain Identification==
A premium domain is identified in the Admin Area by a badge next to the order type when viewing the domain. [[File:premium1.png|thumb]]
A premium domain cannot have the Registration Period changed from 1 year.
A client ordering a domain renewal only be able to do so for the 1 year term and the price will be calculated based on the premium cost from the registrar.

==Can I override the price?==
A premium domain cost can range from tens of dollars, to thousands. There may be situations where the cost of the domain could exceed the balance of a registrar account, or require additional validation to confirm the customer is aware of the price they will be paying.
[[File:override_availability.png|thumb|Overriding Availability]]
[[File:contact_support.png|thumb|Contact Us]]
[[File:override_price.png|thumb|Overriding Price]]

WHMCS has a hook that allows the override of the registration or renewal price of the domain being ordered. Additionally, the same hook can instruct the customer to Contact Support, or show the domain as unavailable.
A similar hook is available when recalculating the recurring renewal price for the domain using the Automatic Recalculation on Save in the Admin Area.

===Hooks===
* [http://developers.whmcs.com/hooks-reference/everything-else/#premiumpriceoverride PremiumPriceOverride Hook] used when the domain is being ordered to override the prices for domain purchase.
* [http://developers.whmcs.com/hooks-reference/everything-else/#premiumpricerecalculationoverride PremiumPriceRecalculationOverride Hook] used to override the automatic recalculation on save pricing.

Premium Domains

2017-04-17T23:54:52Z

ChrisD: /* Hooks */ - Replaced URLs with correct development docs links

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

Premium Domains are names with short, common or desirable words. Usually providing a more memorable web address for a premium price.

==Enabling Premium Domains==
Premium Domains require that you have a Domain Lookup provider selected that supports them.
[[File:lookup_provider.png|thumb|Selecting a Domain Lookup Provider]]
To configure your Domain Lookup Provider, go to Setup > Products/Services > Domain Pricing and click the Change button below your currently configured provider. This will provide a list of registrars that support Domain Lookups and Suggestions. Click on a registrar, and if required, additional lookup configuration will be provided. Once configured, click on Save on the modal popup window to save the domain lookup configuration.

Once a Lookup Provider that supports Premium Domains is selected, Premium Domains can be enabled in WHMCS in Setup > Products/Services > Domain Pricing. Once enabled, the configuration of percentage markups will become possible.

===Supported Registrars===
Premium Domain support is available when using the following registrars for WHOIS lookups:
* [[Enom|eNom]]
* All Logicboxes Modules ([[ResellerClub]], [[ResellerCamp]], [[NetEarthOne]] and [[Stargate|UK2 Group/StarGate]])

==Pricing Bands==
<div class="docs-alert-info">Returned Premium Prices will be in the currency configured for the registrar account. The currency of the registrar account must be available in Setup > Payments > Currencies.</div>
[[File:pricing_bands.png|thumb|Pricing Bands in WHMCS]]
Premium domain cost prices are fetched in real-time from domain registrar APIs. The price markups are applied as defined in the configuration. Markup percentages are based on bands, which can be defined as required.[[File:premium_domains_ordering.png|thumb|Ordering a Premium Domain]]
Premium pricing levels are configured as up to, but not including, the price entered.
Once enabled, ordering a domain, in the Client Area, that the registrar deems premium will have the markup applied.

==Renewals and Recurring Price==
Registration for premium domains is only possible for 1 year. After buying, the domain is considered premium if a premium renewal price is available.

The current raw renewal cost, in the Client currency, for a premium domain is under the Recurring Amount field. Consider the raw cost when making any manual changes to the recurring amount. [[File:premium2.png|thumb]] Checking the automatic recalculation box will recalculate the recurring cost for the domain on save.
The raw cost does not include any markup that will be applied.

==Premium Domain Identification==
A premium domain is identified in the Admin Area by a badge next to the order type when viewing the domain. [[File:premium1.png|thumb]]
A premium domain cannot have the Registration Period changed from 1 year.
A client ordering a domain renewal only be able to do so for the 1 year term and the price will be calculated based on the premium cost from the registrar.

==Can I override the price?==
A premium domain cost can range from tens of dollars, to thousands. There may be situations where the cost of the domain could exceed the balance of a registrar account, or require additional validation to confirm the customer is aware of the price they will be paying.
[[File:override_availability.png|thumb|Overriding Availability]]
[[File:contact_support.png|thumb|Contact Us]]
[[File:override_price.png|thumb|Overriding Price]]

WHMCS has a hook that allows the override of the registration or renewal price of the domain being ordered. Additionally, the same hook can instruct the customer to Contact Support, or show the domain as unavailable.
A similar hook is available when recalculating the recurring renewal price for the domain using the Automatic Recalculation on Save in the Admin Area.

===Hooks===
* [http://developers.whmcs.com/hooks-reference/everything-else/#premiumpriceoverride| PremiumPriceOverride Hook] used when the domain is being ordered to override the prices for domain purchase.
* [http://developers.whmcs.com/hooks-reference/everything-else/#premiumpricerecalculationoverride| PremiumPriceRecalculationOverride Hook]] used to override the automatic recalculation on save pricing.