WHMCS Documentation - User contributions [en]

OpenID Connect Developer Guide

2024-05-14T13:28:22Z

AlexN: /* Getting Started */

Looking for the OpenID Connect User Guide? [[OpenID Connect|Click here...]]

==Getting Started==

To get started, you'll need to select an OpenID 2.0 compliant library compatible with your programming language.

The best place to look is the [http://openid.net/add-openid/add-getting-started/ Getting Started Guide] on [http://openid.net/ OpenID.net]. [http://code.google.com/apis/accounts/docs/OpenID.html Google's OpenID documentation] is also very useful. There are [http://openid.net/developers/libraries/ dozens of libraries] in all major languages.

If your application needs to use the RFC URL , please add the following rewrite rule to the .htaccess file in the main folder of the website where WHMCS is installed (usually called public_html), adjusting /oauth/openid-configuration.php accordingly if WHMCS is installed in a sub-folder:

<div class="source-cli"><nowiki># OpenID Discovery Document (http://openid.net/specs/openid-connect-discovery-1_0.html)</nowiki><br />
<nowiki>RewriteRule ^.well-known/openid-configuration ./oauth/openid-configuration.php [L,NC]</nowiki></div>

==Authenticating the User==

The OAuth 2.0 APIs in WHMCS can be used for both authentication and authorization. This document describes our OAuth 2.0 implementation for authentication, which conforms to the [http://openid.net/connect/ OpenID Connect] specification.

Authenticating the user involves obtaining an ID token and validating it. ID tokens are a standardized feature of [http://openid.net/connect/ OpenID Connect] designed for use in sharing identity assertions on the Internet.

===Authorization Endpoint===

You should retrieve the Authorization Endpoint URI and all other Endpoint URIs from the Discovery document located at https://www.example.com/whmcs/oauth/openid-configuration.php. This provides various endpoint URIs, including the Authorization Endpoint URI and Token Endpoint URI, defied as authorization_endpoint and token_endpoint,

<div class="docs-alert-info">'''Important Note:''' HTTPS must be used for all requests. SSL is required for all OAuth 2.0 interaction per the OpenID Connect specification.</div>

==The Workflow==

When a user tries to log in with WHMCS, you need to:

# Create an anti-forgery state token
# Send an Authentication Request to WHMCS
# Confirm the anti-forgery state token
# Exchange code for access_token and ID Token
# Obtain user information from the ID Token
# Authenticate the User

===Create an anti-forgery state token===

You must protect the security of your users by preventing request forgery attacks. The first step is creating a unique session token that holds state between your app and the user's client. You later match this unique session token with the authentication response returned by the WHMCS OAuth Login service to verify that the user is making the request and not a malicious attacker. These tokens are often referred to as cross-site request forgery ([http://en.wikipedia.org/wiki/Cross-site_request_forgery CSRF]) tokens.

Best practices for generating state tokens is beyond the scope of this document. At a minimum, we suggest a string of 32 characters constructed by a high-entropy random number generator. Another suggest is a one-way hash generated by signing session state information with a key that is kept secret on your back-end.

===Send an Authentication Request to WHMCS===

Applications need OAuth 2.0 credentials, including a client ID and client secret, to authenticate users and gain access to the WHMCS API. Instructions for provisioning these can be found in the OpenID Connect End User Documentation.

For a basic HTTPS POST request, the following parameters are required:

* '''client_id''' which you obtain from the OpenID Connect Management interface within WHMCS
* '''response_type''' which should be code.
* '''scope''' which in a basic request should be openid profile email.
* '''redirect_uri''' should be the HTTP endpoint on your server that will receive the response from WHMCS. This must match the URI you specified when configuring your Application inside WHMCS.
* '''state''' should include the value of the anti-forgery unique session token, as well as any other information needed to recover the context when the user returns to your application, e.g., the starting URL.

Here is an example of a complete OpenID Connect authentication URI, with line breaks and spaces for readability:

<source lang="php">
https://www.example.com/whmcs/oauth/authorize.php?
client_id=WHMCS-DEMO./hW6JgfqRfZ8eCCIsZHQTg==&
response_type=code&
scope=openid%20profile%20email&
redirect_uri=https://oauth2-login-demo.example.com/code&
state=security_token%3D138r5719ru3e1%26url%3Dhttps://oauth2-login-demo.example.com/index
</source>

===Confirm the anti-forgery state token===

In response to the query above, a redirect is performed where in the target URL will be the provided (and validated) redirect_uri with a code parameter and the state that you specified in the request. All responses are returned in the query string, as shown below:

<source lang="php">
https://oauth2-login-demo.example.com/code? state=security_token%3D138r5719ru3e1%26url%3Dhttps://oa2cb.example.com/index&code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7
</source>

On the server, you must confirm that the state received from WHMCS matches the session token you created in Step 1. This round-trip verification helps to ensure that the user, not a malicious script, is making the request.

===Exchange code for access token and ID Token===

The response includes a code parameter, a one-time, short-lived authorization code that your server can exchange for an access token and ID token. Your server makes this exchange by sending an HTTPS POST request. The POST request is sent to the token endpoint, which you should retrieve from the Discovery document using the key token_endpoint. The following discussion assumes the endpoint is https://www.example.com/whmcs/oauth/token.php. The request must include the following parameters in the POST body:

<table class="table table-striped">
<tr><td>code</td><td>The authorization code that is returned from the initial request.</td></tr>
<tr><td>client_id</td><td>The client ID that you obtain from the Developers Console, as described in Obtain OAuth 2.0 credentials.</td></tr>
<tr><td>client_secret</td><td>The client secret that you obtain from the Developers Console, as described in Obtain OAuth 2.0 credentials.</td></tr>
<tr><td>redirect_uri</td><td>The URI that you specify in the Developers Console, as described in Set a redirect URI.</td></tr>
<tr><td>grant_type</td><td>This field must contain a value of authorization_code, as defined in the OAuth 2.0 specification.</td></tr>
</table>

The actual request might look like the following example:

<source lang="php">
POST /whmcs/oauth/token.php HTTP/1.1
Host: www.example.com
Content-Type: application/x-www-form-urlencoded

code=4/P7q7W91a-oMsCeLvIaQm6bTrgtp7&
client_id=WHMCS-DEMO./hW6JgfqRfZ8eCCIsZHQTg==&
client_secret={client_secret}&
redirect_uri=https://oauth2-login-demo.example.com/code&
grant_type=authorization_code
</source>
A successful response to this request contains the following fields in a JSON array:

<table class="table table-striped">
<tr><td>access_token</td><td>A token that can be sent to a WHMCS API.</td></tr>
<tr><td>id_token</td><td>A JWT that contains identity information about the user that is digitally signed by WHMCS.</td></tr>
<tr><td>expires_in</td><td>The remaining lifetime of the access token.</td></tr>
<tr><td>token_type</td><td>Identifies the type of token returned. At this time, this field always has the value Bearer.</td></tr>
</table>

===Obtain user information from ID Token===

An ID Token is a JWT (JSON Web Token, https://tools.ietf.org/html/rfc7519), that is, a cryptographically signed Base64-encoded JSON object.

We highly recommend validating this signed token. Many API libraries combine the validation with the work of decoding the base64 and parsing the JSON, so you will probably end up validating the token as you access the fields in the ID token. You may also what to visit http://jwt.io/ for more information on JWT.

'''An ID token's payload'''

An ID token is a JSON object containing a set of name/value pairs. Here’s an example, formatted for readability:

<source lang="php">
{
"iss":"https://www.example.com/whmcs",
"sub":"78506140-dc6a-4a66-9faa-a3c9e52531a2",
"aud":"WHMCS-DEMO./hW6JgfqRfZ8eCCIsZHQTg==",
"iat": 1448466862,
"exp": 1448466962
}
</source>

WHMCS ID Tokens will contain the following fields (known as claims):

<table class="table table-striped">
<tr><td>iss</td><td>The Issuer Identifier for the Issuer of the response. Always the System SSL URL for your WHMCS installation</td></tr>
<tr><td>sub</td><td>An identifier for the user, unique among all WHMCS accounts and never reused. Use sub within your application as the unique-identifier key for the user.</td></tr>
<tr><td>aud</td><td>Identifies the audience that this ID token is intended for. It will be one of the OAuth 2.0 client IDs of as generated by your WHMCS installation and used by your application.</td></tr>
<tr><td>iat</td><td>The time the ID token was issued, represented in Unix time (integer seconds).</td></tr>
<tr><td>exp</td><td>The time the ID token expires, represented in Unix time (integer seconds).</td></tr>
</table>

===Authenticate the User In Your Application===

After obtaining user information from the ID token, you can utilize the sub value in the token. This value is unique to the user that has been authenticated and provided authorization at your WHMCS Billing & Support installation. If you have already associated this value with the user of your application you should start an application session for that user.

If you have not previously associated the sub with a registered user of your system, you can can either redirect the user to your new-user sign-up flow or request more information about the user from the WHMCS Billing & Support installation in order to receiver their email address. The latter would only be beneficial if you need the user's email as part of your association process or if you wish to pre-populate any fields for a registration or login form.

Associate the sub value with your users can be done once by asking the user to login with their pre-existing credentials in your application. After the user successfully authenticates into your application, you would store the sub value in your database related to your database record for that user.

If you want to get more information about the user, such as their email address, you would make a claim request with the access_token that was provided in the same response as the JWT.

==Available Claims==

The following claims are available:

<table class="table table-striped">
<tr><td>'''Claim Name'''</td><td>'''Supported Version'''</td></tr>
<tr><td>profile</td><td>6.2.0+</td></tr>
<tr><td>email</td><td>6.2.0+</td></tr>
</table>

==Setting up OAuth 2.0 API Methods==

The following API commands exist for interacting with OAuth/OpenID Connect credentials in WHMCS:

* [https://developers.whmcs.com/api-reference/listoauthcredentials/ ListOAuthCredentials]
* [https://developers.whmcs.com/api-reference/createoauthcredential/ CreateOAuthCredential]
* [https://developers.whmcs.com/api-reference/updateoauthcredential/ UpdateOAuthCredential]
* [https://developers.whmcs.com/api-reference/deleteoauthcredential/ DeleteOAuthCredential]

Version 8.10 Release Notes

2024-04-04T12:58:46Z

AlexN: /* ClopudFlare® Proxy Check */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.10.0<br />
Release Type: Release Candidate<br />
Latest Update: 3rd April 2024<br />
Distribution Types: Full and Via Automatic Updater
</div>

<div class="docs-alert-success">
For more information on WHMCS 8.10's important changes and exciting features, see [[New and Improved in WHMCS 8.10]].
</div>

==Version History==

<onlyinclude>
<table class="table table-striped">
<tr><td>8.10.0</td><td>Beta</td><td>18th March 2024</td></tr>
<tr><td>8.10.0</td><td>Release Candidate</td><td>3rd April 2024</td></tr>
</table>
</onlyinclude>

==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 introduced support for PHP 7.4, and WHMCS 8.6 introduced support for PHP 8.1.

<div class="docs-alert-warning">
Make certain that you update to a WHMCS version that supports your desired PHP version or higher '''before''' updating PHP.
* The [[Automatic Updater]] only displays updates if you are running a PHP version that is compatible with that WHMCS version.
* For example, if you are running PHP 7.1 or earlier, you must update to PHP 7.2 or later before updating to WHMCS 8.0 or higher.
</div>

[[Upgrading|Upgrade Instructions]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic Updater]].

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

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

== Release Notes ==

=== Sitejet Builder ===

WHMCS now includes full automation support for [https://www.sitejet.io/en Sitejet Builder] on cPanel & WHM and Plesk hosting servers. Sitejet Builder is included by default with cPanel & WHM or Plesk hosting plans that enable the feature. Additionally, you can choose to offer Sitejet Builder to customers as an optional Sitejet Builder product addon using the new '''Sitejet Builder''' predefined addon. Promotions for the Sitejet Builder options that you offer will automatically appear in the Client Area.

* When you log in to the Admin Area after upgrading to WHMCS 8.10 or higher, a banner will display information about Sitejet Builder. This banner displays regardless of whether you have any eligible hosting servers.<div class="docs-alert-info">Sitejet Builder is included by default on servers that run [https://go.whmcs.com/1821/cpanel-sitejet-builder cPanel & WHM version 116 or higher] or [https://go.whmcs.com/1825/plesk-sitejet-builder Plesk 18.0.57 or higher].</div>
* A new '''Features''' column in the list of products at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' displays up-to-date Sitejet Builder availability for products for your cPanel & WHM and Plesk servers.

After purchase, clients can access Sitejet Builder directly, without needing to first log in to their hosting account, from within the WHMCS Client Area by clicking '''Edit with Sitejet Builder'''. Admins can log in to Sitejet Builder by clicking '''Log in to Sitejet Builder''' for the appropriate service in the client's profile's '''[[Clients:Products/Services_Tab|Products/Services]]''' tab.

[[Sitejet Builder|Learn More]]

=== Automatic Cancellation for Overdue Invoices ===

In WHMCS 8.10 and later, the system cron can automatically cancel invoices after they have been overdue for a specified number of days. This allows you to remove old, overdue invoices that have accumulated on your system each time that the system cron runs.

You can enable this setting and set the number of days in the '''Billing Settings''' section at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]'''.

[[Automation Settings|Learn More]]

=== Update to Invoice Labels ===

To increase clarity when viewing clients' invoices, we have updated the labels that denote totals. The invoice's total at the top of the '''Summary''' tab is now '''Invoice Amount''', while the separate total in the '''Invoice Items''' list remains '''Total Due'''.

=== CloudFlare® Proxy Check ===

The list of checks at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > System Health''' now includes a warning if the system detects problems with your CloudFlare trusted proxies configuration.

If you see this warning, click the link to automatically correct the issue.

== Templates ==

For a list of changed files and a graphical view of the exact changes, see the GitHub™ repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.9.0 and 8.10.0:

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

=== Six Theme ===

The following link provides a comparison of changes between 8.9.0 and 8.10.0:

https://github.com/WHMCS/templates-six/compare/v8.9.0-release.1...v8.10.0-rc.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.9.0 and 8.10.0:

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.9.0-release.1...v8.10.0-rc.1

== Changelog ==

* [[Changelog:WHMCS_V8.10.0_Beta_1|Version 8.10.0 Beta 1]]
* [[Changelog:WHMCS_V8.10.0_RC_1|Version 8.10.0 RC 1]]

Cron Job Issues

2024-01-18T11:56:53Z

AlexN: /* Common Errors */

{{troubleshooting}}

You may encounter some common problems and errors that can occur when running the WHMCS cron job.

For more information about troubleshooting cron job issues, see [https://help.whmcs.com/m/automation/c/195647 our cron and automation troubleshooting guides].

==Troubleshooting==

There are several techniques available for troubleshooting the problems that you may encounter with the cron job:

===Cron Execution===

If you do not receive the daily cron digest email, see a warning on the System Health Status overview page, or on the Automation Status page then this indicates the cron not running. Troubleshooting and resolving this is a matter of priority, as the daily automation tasks are an integral part of WHMCS.

Detailed steps on how to debug the cron execution can be found in our [https://help.whmcs.com/m/automation/l/683269-advanced-cron-troubleshooting|Advanced Cron Troubleshooting] Guide.

===Run the cron job in your browser===

To do this:

# In the WHMCS admin area, go to the '''[[Other Tab|Other]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
# Enable the '''Display Errors''' option.
# Visit the <tt>cron.php</tt> file in your browser. For example: <source lang="php">http://www.example.com/whmcs/crons/cron.php</source>

<div class="docs-alert-info">
<span class="title">Note</span><br />
Executing <tt>cron.php</tt> from a web browser is not possible if the <tt>/crons</tt> directory is not inside a web-accessible directory. It will be subject to limitations that apply to executing any PHP script via a web browser such as, timeouts and won't provide any output on screen to examine (the execution must be observed from the Activity Log). Where possible, executing <tt>cron.php</tt> from your server's command line interface is the recommended troubleshooting method.
</div>

===Run the cron job from the server command line===

To do this:

# Access your server's command line.
# Copy the cron job command for the <tt>cron.php</tt> file from your server's cron tab. <source lang="php">crontab -u userName -l</source> Where <tt>userName</tt> represents the user on the server for which the cron command is configured under.
# Execute the command you copied with the addition of the verbose option:<source lang="php">php -q /path/to/whmcs/crons/cron.php -vvv</source>
# Examine the output for any errors.
# To execute all daily automation tasks, adjust the cron command again to add in the force option:<source lang="php">php -q /path/to/whmcs/crons/cron.php --force -vvv</source> This should only ever be executed once in any 24 hour period. Do this with the explicit intention of identifying why the cron may not be completing successfully.

For more information, see [[Crons#Commands|Cron Commands.]]

===Run the cron job from the server command line with debugging enabled===

To do this:

* Make sure you have enabled '''Display Errors''' in the '''[[Other Tab|Other]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
* Access your server's command line.
* Make sure you have enabled '''display_errors''' in your command line PHP environment: <source lang="php">php -i | grep display_errors
display_errors => STDOUT => STDOUT</source>
* Copy the cron job command for the <tt>cron.php</tt> file from your server's crontab: <source lang="php">crontab -u userName -l</source>
* Add the --force option to the end of the cron command and execute it:<source lang="php">php -q /path/to/whmcs/crons/cron.php all --force -vvv</source>
*Examine the output for any errors. The final line output should be "'''[OK] Completed'''".

==Common Errors==

===Site error: the file /path/to/crons/cron.php requires the ionCube PHP Loader ioncube_loader_lin_5.6.so to be installed by the website operator===

Seeing this error output indicates that the PHP configuration for your WHMCS installation may be different than the one on the command line.

Log in as the same user that the cron job runs under. Then, run the following command at the server's command line to see the version information for your PHP and ionCube Loader® configurations:

<source lang="php">
php -v
</source>

You should get an output along the lines of:

<source lang="php">
PHP 5.4.43 (cli) (built: Aug 2 2015 02:44:35)
Copyright (c) 1997-2014 The PHP Group
Zend Engine v2.4.0, Copyright (c) 1998-2014 Zend Technologies
with the ionCube PHP Loader v4.7.5, Copyright (c) 2002-2014, by ionCube Ltd.
</source>

If the <tt>with the ionCube PHP Loader</tt> line is absent, this indicates that ionCube Loader is not available for this user. Work with your hosting provider or server administrator to ensure that ionCube Loader is available to the cron job user.

===Unable to communicate with the WHMCS installation===

This error occurs when the <tt>cron.php</tt> file is unable to communicate with the WHMCS installation. This typically occurs when you are using a custom location for the <tt>/crons</tt> directory. The <tt>cron.php</tt> file will look for the WHMCS directory in the location that you specified in the <tt>/crons/config.php</tt> file. To resolve this error:

* Open the <tt>/crons/config.php</tt> file.
* Ensure the <tt>$whmcspath</tt> line is uncommented by removing the preceding <tt>//</tt> characters.
* Ensure the <tt>$whmcspath</tt> path is the full system path to your WHMCS directory. This is the directory that contains the <tt>init.php</tt> and <tt>clientarea.php</tt> files.

When you finish, the entire file will look like this:

<source lang="php">
<?php
/**
* Custom Crons Directory Configuration
*
* This crons folder may be moved to any place above or below the docroot.
*
* We recommend locating it outside the docroot to prevent browser based access.
*
* Upon moving it, you must provide the path to your WHMCS installation to
* allow the cron task files to communicate with the parent WHMCS installation.
*
* To do this, rename this file config.php, then uncomment and enter the full
* path to the WHMCS root directory in the $whmcspath variable below.
*
* You must also provide the appropriate path to the crons folder in the
* $crons_dir variable inside the WHMCS master configuration file.
*
* For more information please see http://docs.whmcs.com/Custom_Crons_Directory
*/

$whmcspath = '/home/username/public_html/whmcs/';
</source>

===Could not open input file: /path/to/crons/cron.php ===

This error occurs when the <tt>cron.php</tt> file is not present in specified directory path. Check the path and correct it, or ensure the <tt>cron.php</tt> file is present.

===Oops! Something went wrong and we couldn't process your request===

This indicates that a fatal PHP error has occurred. Go to the '''[[Other Tab|Other]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. Select 'Display Errors'. Then, run the cron job again. The system will display the full error. The error normally indicates an issue with one or more modules.

For example, you could see:

<source lang="php">
<p class="debug">exception 'Whoops\Exception\ErrorException' with message 'Cannot redeclare class module_class' in /home/whmcs/public_html/modules/gateways/module-name/module-file.php:16<br />
</source>

If the error references a third party module you are using, you will need to contact the developers of the module to review and resolve the error. If the error references a WHMCS-developed and shipped module, contact our Support Team. It may also indicate an issue with the PHP configuration. For more information, see the sections below.

===Fatal error: Allowed memory size of 33554432 bytes exhausted (tried to allocate 20480 bytes)===

This error indicates that the system is terminating the cron job because it has exceeded the 'memory_limit' value of 32 MB. Increase this to 64 MB (128 MB if possible) to resolve this. Contact your server administrator or hosting provider for assistance with this.

You can check the limit using this command:

<source lang="php">
php -ini | grep "memory_limit"
</source>

===The file /path/to/crons/cron.php is corrupted===

You may see this error in version 7.5 and above. This error will occur if you are running ionCube Loader 10.0 or earlier. WHMCS 7.5 requires ionCube Loader 10.1.0 or above. If your WHMCS installation is working, it indicates that the PHP configuration for your WHMCS installation may be different than the one that you use on the command line. To check this, you can again use the command below:

<source lang="php">
php -v
</source>

Look for the following line to identify the ionCube Loader version:

<source lang="php">
with the ionCube PHP Loader (enabled) + Intrusion Protection from ioncube24.com (unconfigured) v10.2.0, Copyright
(c) 2002-2018, by ionCube Ltd.
</source>

===Error: Call to undefined function curl_init()===

This error indicates that the system is terminating the cron job because the 'curl' extension is missing. To check this, run the following command:

<source lang="php">
php -m
</source>

A similar error may also occur if the 'curl_init' function is a disabled function in your PHP configuration.

===Whoops\Exception\ErrorException' with message 'Maximum execution time of 30 seconds exceeded===

This error indicates that the system is terminating the cron job because it has exceeded the 'max_execution_limit' value of 30 seconds. Increase this to an appropriate value for the size of your installation. For most servers, a limit of '120' is sufficient, but larger servers may need a value of '300'.

You can check the limit using this command:
<source lang="php">php -ini | grep "max_execution_time"</source>

===Segmentation fault===

This error is not directly related to the WHMCS software and can occur for many different reasons. It most commonly indicates that PHP is crashing and suggests there is an issue with your PHP installation (for example, a malfunctioning extension). It is something your server administrator or hosting provider would need to investigate, possibly using the 'strace' utility.

===Domain renew link in emails is broken===

Under some PHP server configurations, the system generates the URL for the domain renewal link in domain renewal reminder emails incorrectly.

You can usually fix this by using the correct PHP binary on your cron job. Alternatively, you can adjust the cron job to work around the issue by formatting your cron command, as in the following example:

<source lang="php">
cd /path/to/crons/ && php -q cron.php
</source>

===Could not connect to database===

This error occurs when the <tt>cron.php</tt> script cannot access your MySQL® database. This is often because the PHP configuration that the <tt>cron.php</tt> script runs under is missing one or all of the following extensions:

* PDO
* PDO MySQL
* MySQLi

It can also be the result of a jailed environment with strict limitations. Your system administrator or hosting provider can check for the required extensions and any environmental limitations by testing a connection to the database and resolving any issues.

{{troubleshooting}}

ImportAssist

2024-01-11T08:34:21Z

AlexN: /* Can I import data from a newer version into an older version?= */

== About this Addon Module ==

ImportAssist is a tool that migrates data from external systems into a WHMCS installation. In addition to importing data from another WHMCS instance, ImportAssist can also import from a range of other web-based billing applications.

<table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;">
<tr>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th>
</tr>
<tr>
<td style="border:1px #AAA solid;padding:0.2em;">ImportAssist</td>
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
<td style="border:1px #AAA solid;padding:0.2em;">WHMCS 8.3 and later*</td>
<td style="border:1px #AAA solid;padding:0.2em;color:darkred;">No</td>
</tr>
</table>

[[File:Available_on_marketplace.png|link=https://marketplace.whmcs.com/product/46]]

'' * See below for additional import compatibility.''

== Activating ImportAssist ==

Before you can activate ImportAssist, you must download it from the WHMCS Marketplace.

To do this:

# Download ImportAssist from [https://marketplace.whmcs.com/product/46 the ImportAssist Marketplace listing].
# Unzip the ZIP file.
# Upload the <tt>import_assist</tt> directory to <tt>/modules/addons</tt> in your WHMCS installation.
# Log in to the WHMCS Admin Area.
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
# Perform the displayed steps to complete activation.
# Select the admin role groups who will have access to this addon.
# Click '''Save Changes'''.

== Using this Addon ==

You can access activated installations of ImportAssist by navigating to '''Addons > ImportAssist for WHMCS'''.

The system will then guide you through performing a data migration.

<div class="docs-alert-warning">
We recommend taking a full backup of your WHMCS database before performing any import. This will allow you to revert your changes in case of problems.
</div>

== Supported Scripts and Versions ==

WHMCS ImportAssist supports importing data from the following applications and versions:

* WHMCS Versions 6.2.x, 6.3.x, 7.0.x, 7.1.x, 7.2.x, 7.3.x, 7.4.x, 7.5.x, 7.6.x, 7.7.x, 7.8.x, 7.9.x, 7.10.x, 8.0x, v8.1.x, 8.2.x, 8.3.x, 8.4.x, 8.5.x, 8.6.x, 8.7.x
* Blesta Versions 2.x, 3.x, 4.1
* ClientExec Versions 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.x
* HostBill Versions 2016 and later

While performing imports from other software versions may be possible, use of these versions is '''unsupported'''.

You can import:

=== WHMCS 6.2 through 7.7 ===

<div class="row">
<div class="col-sm-3">Addon</div>
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">ClientNotes</div>
<div class="col-sm-3">ConfigOption</div>
<div class="col-sm-3">ConfigOptionGroup</div>
<div class="col-sm-3">ConfigOptionOption</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">CustomField</div>
<div class="col-sm-3">CustomFieldValue</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Promotion</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">ServiceConfigOption</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketLog</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== WHMCS 7.8 through 7.10 ===

<div class="row">
<div class="col-sm-3">Addon</div>
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">ClientNotes</div>
<div class="col-sm-3">ConfigOption</div>
<div class="col-sm-3">ConfigOptionGroup</div>
<div class="col-sm-3">ConfigOptionOption</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">CustomField</div>
<div class="col-sm-3">CustomFieldValue</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pay Methods</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Promotion</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">ServiceConfigOption</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketLog</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== WHMCS 8.0 and later ===

<div class="row">
<div class="col-sm-3">Addon</div>
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">ClientNotes</div>
<div class="col-sm-3">ConfigOption</div>
<div class="col-sm-3">ConfigOptionGroup</div>
<div class="col-sm-3">ConfigOptionOption</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">CustomField</div>
<div class="col-sm-3">CustomFieldValue</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pay Methods</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Promotion</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">ServiceConfigOption</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketLog</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
<div class="col-sm-3">Users</div>
</div>

=== Blesta 2.x ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== Blesta 3.x, 4.1 ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== ClientExec ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== HostBill ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

== Troubleshooting ==

In the unlikely event of an import failure, download a copy of the '''Import Log'''. The '''Import Log''' is available to download during and after the import process.

For help with any problems, send us the '''Import Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, in WHMCS 8.0 and earlier, '''Utilities > Logs''' in a Technical Support ticket describing the issue.

=== Unable to connect to the database ===

This error indicates that ImportAssist cannot establish a connection to the source database from which the data is being imported. Check the following points to resolve this error:

* Valid database connection details exist in ImportAssist. If they are not up-to-date, correct them.
* The database host is valid relative to the WHMCS installation that is using ImportAssist. If the source database is located on the same server, try using <tt>localhost</tt> or <tt>127.0. 0.1</tt>.
* If the source data is remote, ensure that [https://docs.cpanel.net/cpanel/databases/remote-mysql/ remote MySQL® access] is permitted on the source server.
* The MySQL service on the source server is online and remotely accessible.
* The specified MySQL user has been assigned to the desired database and given full access to it.

===Import does not complete (remains processing indefinitely)===

This usually indicates that the connection to the database is terminated. Work with your server administrator or hosting provider to check and increase the MySQL <tt>wait_timeout</tt> setting, then attempt the importation again.

===Non-Latin Characters not imported correctly===

ImportAssist explicitly sets the database charset to <tt>utf8</tt> and the table collations to <tt>utf8_unicode_ci</tt> during the import process. This means that both the source and destination databases must use UTF-8.

Work with your database administrator to convert the existing data to the collations used by WHMCS.

===Can I import data from a newer version into an older version?===

It is not possible to import data from a newer version of WHMCS into an older version.
You can import data from an installation on the same version or from an older version of WHMCS into a newer version.

== Change Log ==

See the [https://marketplace.whmcs.com/product/46-importassist#changelog ImportAssist] Marketplace listing.

ImportAssist

2024-01-11T08:21:41Z

AlexN: /* Can I import data from a newer version into an older version?= */

== About this Addon Module ==

ImportAssist is a tool that migrates data from external systems into a WHMCS installation. In addition to importing data from another WHMCS instance, ImportAssist can also import from a range of other web-based billing applications.

<table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;">
<tr>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th>
</tr>
<tr>
<td style="border:1px #AAA solid;padding:0.2em;">ImportAssist</td>
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
<td style="border:1px #AAA solid;padding:0.2em;">WHMCS 8.3 and later*</td>
<td style="border:1px #AAA solid;padding:0.2em;color:darkred;">No</td>
</tr>
</table>

[[File:Available_on_marketplace.png|link=https://marketplace.whmcs.com/product/46]]

'' * See below for additional import compatibility.''

== Activating ImportAssist ==

Before you can activate ImportAssist, you must download it from the WHMCS Marketplace.

To do this:

# Download ImportAssist from [https://marketplace.whmcs.com/product/46 the ImportAssist Marketplace listing].
# Unzip the ZIP file.
# Upload the <tt>import_assist</tt> directory to <tt>/modules/addons</tt> in your WHMCS installation.
# Log in to the WHMCS Admin Area.
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
# Perform the displayed steps to complete activation.
# Select the admin role groups who will have access to this addon.
# Click '''Save Changes'''.

== Using this Addon ==

You can access activated installations of ImportAssist by navigating to '''Addons > ImportAssist for WHMCS'''.

The system will then guide you through performing a data migration.

<div class="docs-alert-warning">
We recommend taking a full backup of your WHMCS database before performing any import. This will allow you to revert your changes in case of problems.
</div>

== Supported Scripts and Versions ==

WHMCS ImportAssist supports importing data from the following applications and versions:

* WHMCS Versions 6.2.x, 6.3.x, 7.0.x, 7.1.x, 7.2.x, 7.3.x, 7.4.x, 7.5.x, 7.6.x, 7.7.x, 7.8.x, 7.9.x, 7.10.x, 8.0x, v8.1.x, 8.2.x, 8.3.x, 8.4.x, 8.5.x, 8.6.x, 8.7.x
* Blesta Versions 2.x, 3.x, 4.1
* ClientExec Versions 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.x
* HostBill Versions 2016 and later

While performing imports from other software versions may be possible, use of these versions is '''unsupported'''.

You can import:

=== WHMCS 6.2 through 7.7 ===

<div class="row">
<div class="col-sm-3">Addon</div>
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">ClientNotes</div>
<div class="col-sm-3">ConfigOption</div>
<div class="col-sm-3">ConfigOptionGroup</div>
<div class="col-sm-3">ConfigOptionOption</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">CustomField</div>
<div class="col-sm-3">CustomFieldValue</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Promotion</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">ServiceConfigOption</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketLog</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== WHMCS 7.8 through 7.10 ===

<div class="row">
<div class="col-sm-3">Addon</div>
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">ClientNotes</div>
<div class="col-sm-3">ConfigOption</div>
<div class="col-sm-3">ConfigOptionGroup</div>
<div class="col-sm-3">ConfigOptionOption</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">CustomField</div>
<div class="col-sm-3">CustomFieldValue</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pay Methods</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Promotion</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">ServiceConfigOption</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketLog</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== WHMCS 8.0 and later ===

<div class="row">
<div class="col-sm-3">Addon</div>
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">ClientNotes</div>
<div class="col-sm-3">ConfigOption</div>
<div class="col-sm-3">ConfigOptionGroup</div>
<div class="col-sm-3">ConfigOptionOption</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">CustomField</div>
<div class="col-sm-3">CustomFieldValue</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pay Methods</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Promotion</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">ServiceConfigOption</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketLog</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
<div class="col-sm-3">Users</div>
</div>

=== Blesta 2.x ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== Blesta 3.x, 4.1 ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== ClientExec ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== HostBill ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

== Troubleshooting ==

In the unlikely event of an import failure, download a copy of the '''Import Log'''. The '''Import Log''' is available to download during and after the import process.

For help with any problems, send us the '''Import Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, in WHMCS 8.0 and earlier, '''Utilities > Logs''' in a Technical Support ticket describing the issue.

=== Unable to connect to the database ===

This error indicates that ImportAssist cannot establish a connection to the source database from which the data is being imported. Check the following points to resolve this error:

* Valid database connection details exist in ImportAssist. If they are not up-to-date, correct them.
* The database host is valid relative to the WHMCS installation that is using ImportAssist. If the source database is located on the same server, try using <tt>localhost</tt> or <tt>127.0. 0.1</tt>.
* If the source data is remote, ensure that [https://docs.cpanel.net/cpanel/databases/remote-mysql/ remote MySQL® access] is permitted on the source server.
* The MySQL service on the source server is online and remotely accessible.
* The specified MySQL user has been assigned to the desired database and given full access to it.

===Import does not complete (remains processing indefinitely)===

This usually indicates that the connection to the database is terminated. Work with your server administrator or hosting provider to check and increase the MySQL <tt>wait_timeout</tt> setting, then attempt the importation again.

===Non-Latin Characters not imported correctly===

ImportAssist explicitly sets the database charset to <tt>utf8</tt> and the table collations to <tt>utf8_unicode_ci</tt> during the import process. This means that both the source and destination databases must use UTF-8.

Work with your database administrator to convert the existing data to the collations used by WHMCS.

===Can I import data from a newer version into an older version?====

It is not possible to import data from a newer version of WHMCS into an older version.
You can import data from an installation on the same version or from an older version of WHMCS into a newer version.

== Change Log ==

See the [https://marketplace.whmcs.com/product/46-importassist#changelog ImportAssist] Marketplace listing.

Ioncube Installation Tutorial

2024-01-02T14:53:24Z

AlexN: /* cPanel & WHM */

ionCube Loader® is an extension for PHP that allows the system to decode and execute encoded files. Encoded files execute and load faster, giving better performance results for WHMCS. ionCube Loader is a [[System Environment Guide|requirement]] for running WHMCS.

== Installing ionCube Loader ==

For Linux applications, installation requires root access to the server. If you do not have root access and your server does not have ionCube Loader already, contact your hosting provider for assistance. If you do not know whether you have ionCube Loader, you can check by creating a <tt>phpinfo</tt> page and visiting it in your browser

<source lang="php">
<?php phpinfo(); ?>
</source>

=== cPanel & WHM ===

You can use two methods to install ionCube Loader on a cPanel & WHM server:

To install via WHM:

# Go to '''WHM >> EasyApache'''.
# Find '''ioncubeXX''' in the '''PHP Extensions''' list, where <tt>XX</tt> is the ionCube Loader version.
# Select the correct package for your PHP version.
# Finalize the installation.

To install via SSH:

# SSH in to your server as the <tt>root</tt> user.
# Run the following command, where <tt>YY</tt> is the desired PHP version: <source lang="bash">yum install ea-phpYY-php-ioncubeXX</source>

=== Other Servers ===

To install ionCube Loader on other servers:

# Download [http://www.ioncube.com/loaders.php the latest supported ionCube Loader].
# Extract the contents of the archived file on your local computer.
# Upload the <tt>IONCUBE</tt> folder via FTP to your domain.
# Establish an SSH connection with the server using a suitable client (for example, PuTTY or Terminal). Usually, this requires you to run the following command and supply your password: <source lang="bash">SSH rootusername@example.com</source>
# Browse to the public folder that contains the <tt>IONCUBE</tt> directory.
# Move the folder to a permanent location: <source lang="bash">mv ioncube /usr/local</source>
# Locate the <tt>php.ini</tt> file: <source lang="bash">locate php.ini</source> Usually, you can find it at <tt>/usr/local/lib/php.ini</tt>.
# Edit the file using your preferred editor.
# Find the other Zend extensions (<tt>zend_extension</tt>).
# Add a new line for ionCube Loader: <source lang="bash">zend_extension = /usr/local/ioncube/ioncube_loader_lin_x.so</source> Replace <tt>x</tt> with your version of PHP.
# Save the changes.
# Restart the server: <source lang="bash">/etc/init.d/httpd restart </source>

To verify that installation was successful, check the PHP Info output for your server. You should see a new section:

Additional Modules
Module Name ionCube Loader

<div class="docs-alert-danger">
WHMCS Support cannot assist with any ionCube Loader problems you may be continuing to have. For help, contact [http://support.ioncube.com ionCube support] directly.
</div>

Ioncube Installation Tutorial

2024-01-02T14:53:05Z

AlexN: /* cPanel & WHM */

ionCube Loader® is an extension for PHP that allows the system to decode and execute encoded files. Encoded files execute and load faster, giving better performance results for WHMCS. ionCube Loader is a [[System Environment Guide|requirement]] for running WHMCS.

== Installing ionCube Loader ==

For Linux applications, installation requires root access to the server. If you do not have root access and your server does not have ionCube Loader already, contact your hosting provider for assistance. If you do not know whether you have ionCube Loader, you can check by creating a <tt>phpinfo</tt> page and visiting it in your browser

<source lang="php">
<?php phpinfo(); ?>
</source>

=== cPanel & WHM ===

You can use two methods to install ionCube Loader on a cPanel & WHM server:

To install via WHM:

# Go to '''WHM >> EasyApache'''.
# Find '''ioncubeXX''' in the '''PHP Extensions''' list, where <tt>XX</tt> is the ionCube Loader version.
# Select the correct package for your PHP version.
# Finalize the installation.

To install via SSH:

# SSH in to your server as the <tt>root</tt> user.
# Run the following command, where <tt>YY</tt> is the desired PHP version: <source lang="bash">yum install ea-phpXX-php-ioncubeXX</source>

=== Other Servers ===

To install ionCube Loader on other servers:

# Download [http://www.ioncube.com/loaders.php the latest supported ionCube Loader].
# Extract the contents of the archived file on your local computer.
# Upload the <tt>IONCUBE</tt> folder via FTP to your domain.
# Establish an SSH connection with the server using a suitable client (for example, PuTTY or Terminal). Usually, this requires you to run the following command and supply your password: <source lang="bash">SSH rootusername@example.com</source>
# Browse to the public folder that contains the <tt>IONCUBE</tt> directory.
# Move the folder to a permanent location: <source lang="bash">mv ioncube /usr/local</source>
# Locate the <tt>php.ini</tt> file: <source lang="bash">locate php.ini</source> Usually, you can find it at <tt>/usr/local/lib/php.ini</tt>.
# Edit the file using your preferred editor.
# Find the other Zend extensions (<tt>zend_extension</tt>).
# Add a new line for ionCube Loader: <source lang="bash">zend_extension = /usr/local/ioncube/ioncube_loader_lin_x.so</source> Replace <tt>x</tt> with your version of PHP.
# Save the changes.
# Restart the server: <source lang="bash">/etc/init.d/httpd restart </source>

To verify that installation was successful, check the PHP Info output for your server. You should see a new section:

Additional Modules
Module Name ionCube Loader

<div class="docs-alert-danger">
WHMCS Support cannot assist with any ionCube Loader problems you may be continuing to have. For help, contact [http://support.ioncube.com ionCube support] directly.
</div>

ImportAssist

2023-12-05T09:28:36Z

AlexN: /* Troubleshooting */

== About this Addon Module ==

ImportAssist is a tool that migrates data from external systems into a WHMCS installation. In addition to importing data from another WHMCS instance, ImportAssist can also import from a range of other web-based billing applications.

<table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;">
<tr>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th>
</tr>
<tr>
<td style="border:1px #AAA solid;padding:0.2em;">ImportAssist</td>
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
<td style="border:1px #AAA solid;padding:0.2em;">WHMCS 8.3 and later*</td>
<td style="border:1px #AAA solid;padding:0.2em;color:darkred;">No</td>
</tr>
</table>

[[File:Available_on_marketplace.png|link=https://marketplace.whmcs.com/product/46]]

'' * See below for additional import compatibility.''

== Activating ImportAssist ==

Before you can activate ImportAssist, you must download it from the WHMCS Marketplace.

To do this:

# Download ImportAssist from [https://marketplace.whmcs.com/product/46 the ImportAssist Marketplace listing].
# Unzip the ZIP file.
# Upload the <tt>import_assist</tt> directory to <tt>/modules/addons</tt> in your WHMCS installation.
# Log in to the WHMCS Admin Area.
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
# Perform the displayed steps to complete activation.
# Select the admin role groups who will have access to this addon.
# Click '''Save Changes'''.

== Using this Addon ==

You can access activated installations of ImportAssist by navigating to '''Addons > ImportAssist for WHMCS'''.

The system will then guide you through performing a data migration.

<div class="docs-alert-warning">
We recommend taking a full backup of your WHMCS database before performing any import. This will allow you to revert your changes in case of problems.
</div>

== Supported Scripts and Versions ==

WHMCS ImportAssist supports importing data from the following applications and versions:

* WHMCS Versions 6.2.x, 6.3.x, 7.0.x, 7.1.x, 7.2.x, 7.3.x, 7.4.x, 7.5.x, 7.6.x, 7.7.x, 7.8.x, 7.9.x, 7.10.x, 8.0x, v8.1.x, 8.2.x, 8.3.x, 8.4.x, 8.5.x, 8.6.x, 8.7.x
* Blesta Versions 2.x, 3.x, 4.1
* ClientExec Versions 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.x
* HostBill Versions 2016 and later

While performing imports from other software versions may be possible, use of these versions is '''unsupported'''.

You can import:

=== WHMCS 6.2 through 7.7 ===

<div class="row">
<div class="col-sm-3">Addon</div>
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">ClientNotes</div>
<div class="col-sm-3">ConfigOption</div>
<div class="col-sm-3">ConfigOptionGroup</div>
<div class="col-sm-3">ConfigOptionOption</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">CustomField</div>
<div class="col-sm-3">CustomFieldValue</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Promotion</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">ServiceConfigOption</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketLog</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== WHMCS 7.8 through 7.10 ===

<div class="row">
<div class="col-sm-3">Addon</div>
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">ClientNotes</div>
<div class="col-sm-3">ConfigOption</div>
<div class="col-sm-3">ConfigOptionGroup</div>
<div class="col-sm-3">ConfigOptionOption</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">CustomField</div>
<div class="col-sm-3">CustomFieldValue</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pay Methods</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Promotion</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">ServiceConfigOption</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketLog</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== WHMCS 8.0 and later ===

<div class="row">
<div class="col-sm-3">Addon</div>
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">ClientNotes</div>
<div class="col-sm-3">ConfigOption</div>
<div class="col-sm-3">ConfigOptionGroup</div>
<div class="col-sm-3">ConfigOptionOption</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">CustomField</div>
<div class="col-sm-3">CustomFieldValue</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pay Methods</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Promotion</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">ServiceConfigOption</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketLog</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
<div class="col-sm-3">Users</div>
</div>

=== Blesta 2.x ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== Blesta 3.x, 4.1 ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== ClientExec ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== HostBill ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

== Troubleshooting ==

In the unlikely event of an import failure, download a copy of the '''Import Log'''. The '''Import Log''' is available to download during and after the import process.

For help with any problems, send us the '''Import Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, in WHMCS 8.0 and earlier, '''Utilities > Logs''' in a Technical Support ticket describing the issue.

=== Unable to connect to the database ===

This error indicates that ImportAssist cannot establish a connection to the source database from which the data is being imported. Check the following points to resolve this error:

* Valid database connection details exist in ImportAssist. If they are not up-to-date, correct them.
* The database host is valid relative to the WHMCS installation that is using ImportAssist. If the source database is located on the same server, try using <tt>localhost</tt> or <tt>127.0. 0.1</tt>.
* If the source data is remote, ensure that [https://docs.cpanel.net/cpanel/databases/remote-mysql/ remote MySQL® access] is permitted on the source server.
* The MySQL service on the source server is online and remotely accessible.
* The specified MySQL user has been assigned to the desired database and given full access to it.

===Import does not complete (remains processing indefinitely)===

This usually indicates that the connection to the database is terminated. Work with your server administrator or hosting provider to check and increase the MySQL <tt>wait_timeout</tt> setting, then attempt the importation again.

===Non-Latin Characters not imported correctly===

ImportAssist explicitly sets the database charset to <tt>utf8</tt> and the table collations to <tt>utf8_unicode_ci</tt> during the import process. This means that both the source and destination databases must use UTF-8.

Work with your database administrator to convert the existing data to the collations used by WHMCS.

===Can I import data from a newer version into an older version?====

It is not possible to import data from a newer version of WHMCS into an older version.
You can import data from an installation on the same version or from an older version of WHMCS insto a newer version.

== Change Log ==

See the [https://marketplace.whmcs.com/product/46-importassist#changelog ImportAssist] Marketplace listing.

ImportAssist

2023-10-02T12:57:36Z

AlexN: /* Change Log */

== About this Addon Module ==

ImportAssist is a tool that migrates data from external systems into a WHMCS installation. In addition to importing data from another WHMCS instance, ImportAssist can also import from a range of other web-based billing applications.

<table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;">
<tr>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th>
</tr>
<tr>
<td style="border:1px #AAA solid;padding:0.2em;">ImportAssist</td>
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
<td style="border:1px #AAA solid;padding:0.2em;">N/A</td>
<td style="border:1px #AAA solid;padding:0.2em;">WHMCS 8.3 and later*</td>
<td style="border:1px #AAA solid;padding:0.2em;color:darkred;">No</td>
</tr>
</table>

[[File:Available_on_marketplace.png|link=https://marketplace.whmcs.com/product/46]]

'' * See below for additional import compatibility.''

== Activating ImportAssist ==

Before you can activate ImportAssist, you must download it from the WHMCS Marketplace.

To do this:

# Download ImportAssist from [https://marketplace.whmcs.com/product/46 the ImportAssist Marketplace listing].
# Unzip the ZIP file.
# Upload the <tt>import_assist</tt> directory to <tt>/modules/addons</tt> in your WHMCS installation.
# Log in to the WHMCS Admin Area.
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
# Perform the displayed steps to complete activation.
# Select the admin role groups who will have access to this addon.
# Click '''Save Changes'''.

== Using this Addon ==

You can access activated installations of ImportAssist by navigating to '''Addons > ImportAssist for WHMCS'''.

The system will then guide you through performing a data migration.

<div class="docs-alert-warning">
We recommend taking a full backup of your WHMCS database before performing any import. This will allow you to revert your changes in case of problems.
</div>

== Supported Scripts and Versions ==

WHMCS ImportAssist supports importing data from the following applications and versions:

* WHMCS Versions 6.2.x, 6.3.x, 7.0.x, 7.1.x, 7.2.x, 7.3.x, 7.4.x, 7.5.x, 7.6.x, 7.7.x, 7.8.x, 7.9.x, 7.10.x, 8.0x, v8.1.x, 8.2.x, 8.3.x, 8.4.x, 8.5.x, 8.6.x, 8.7.x
* Blesta Versions 2.x, 3.x, 4.1
* ClientExec Versions 5.3, 5.4, 5.5, 5.6, 5.7, 5.8, 5.9, 6.x
* HostBill Versions 2016 and later

While performing imports from other software versions may be possible, use of these versions is '''unsupported'''.

You can import:

=== WHMCS 6.2 through 7.7 ===

<div class="row">
<div class="col-sm-3">Addon</div>
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">ClientNotes</div>
<div class="col-sm-3">ConfigOption</div>
<div class="col-sm-3">ConfigOptionGroup</div>
<div class="col-sm-3">ConfigOptionOption</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">CustomField</div>
<div class="col-sm-3">CustomFieldValue</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Promotion</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">ServiceConfigOption</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketLog</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== WHMCS 7.8 through 7.10 ===

<div class="row">
<div class="col-sm-3">Addon</div>
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">ClientNotes</div>
<div class="col-sm-3">ConfigOption</div>
<div class="col-sm-3">ConfigOptionGroup</div>
<div class="col-sm-3">ConfigOptionOption</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">CustomField</div>
<div class="col-sm-3">CustomFieldValue</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pay Methods</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Promotion</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">ServiceConfigOption</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketLog</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== WHMCS 8.0 and later ===

<div class="row">
<div class="col-sm-3">Addon</div>
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">ClientNotes</div>
<div class="col-sm-3">ConfigOption</div>
<div class="col-sm-3">ConfigOptionGroup</div>
<div class="col-sm-3">ConfigOptionOption</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">CustomField</div>
<div class="col-sm-3">CustomFieldValue</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pay Methods</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Promotion</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">ServiceConfigOption</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketLog</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
<div class="col-sm-3">Users</div>
</div>

=== Blesta 2.x ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== Blesta 3.x, 4.1 ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketNote</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== ClientExec ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">ClientGroup</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

=== HostBill ===

<div class="row">
<div class="col-sm-3">Client</div>
<div class="col-sm-3">Contact</div>
<div class="col-sm-3">Currency</div>
<div class="col-sm-3">Domain</div>
<div class="col-sm-3">Invoice</div>
<div class="col-sm-3">InvoiceItem</div>
<div class="col-sm-3">Pricing</div>
<div class="col-sm-3">Product</div>
<div class="col-sm-3">ProductGroup</div>
<div class="col-sm-3">Server</div>
<div class="col-sm-3">Service</div>
<div class="col-sm-3">ServiceAddon</div>
<div class="col-sm-3">SupportDepartment</div>
<div class="col-sm-3">Ticket</div>
<div class="col-sm-3">TicketReply</div>
<div class="col-sm-3">Transaction</div>
</div>

== Troubleshooting ==

In the unlikely event of an import failure, download a copy of the '''Import Log'''. The '''Import Log''' is available to download during and after the import process.

For help with any problems, send us the '''Import Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, in WHMCS 8.0 and earlier, '''Utilities > Logs''' in a Technical Support ticket describing the issue.

=== Unable to connect to the database ===

This error indicates that ImportAssist cannot establish a connection to the source database from which the data is being imported. Check the following points to resolve this error:

* Valid database connection details exist in ImportAssist. If they are not up-to-date, correct them.
* The database host is valid relative to the WHMCS installation that is using ImportAssist. If the source database is located on the same server, try using <tt>localhost</tt> or <tt>127.0. 0.1</tt>.
* If the source data is remote, ensure that [https://docs.cpanel.net/cpanel/databases/remote-mysql/ remote MySQL® access] is permitted on the source server.
* The MySQL service on the source server is online and remotely accessible.
* The specified MySQL user has been assigned to the desired database and given full access to it.

== Change Log ==

See the [https://marketplace.whmcs.com/product/46-importassist#changelog ImportAssist] Marketplace listing.

Live Chat Addon

2023-10-02T12:57:18Z

AlexN: /* Change Log */

== About this Addon Module ==

Live Chat allows you to chat and engage with customers. It includes in-chat access to customer products and billing, and chat transcripts become support tickets after the chat concludes. You can use Live Chat from a downloadable client that's available for most major mobile and desktop operating systems.

<table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;">
<tr>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th>
</tr>
<tr>
<td style="border:1px #AAA solid;padding:0.2em;">Live Chat Addon'</td>
<td style="border:1px #AAA solid;padding:0.2em;">17th May 2021</td>
<td style="border:1px #AAA solid;padding:0.2em;">5.8.9800</td>
<td style="border:1px #AAA solid;padding:0.2em;">WHMCS 8.0 and later</td>
<td style="border:1px #AAA solid;padding:0.2em;color:darkred;">No</td>
</tr>
</table>

[[File:Available_on_marketplace.png|link=https://marketplace.whmcs.com/product/34]]

== Activating Live Chat Addon ==

Before you can activate Live Chat, you must download it from the WHMCS Marketplace.

<html><a href="http://www.youtube.com/watch?v=fcCKomdCe4Y&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>

To do this:

# If you have not already purchased it, purchase Live Chat from [https://marketplace.whmcs.com/product/34 the Live Chat listing].
# [https://www.whmcs.com/members/ Log in here].
# Go to '''Services > All Products & Services'''.
# Perform one of the following actions:
## If you purchased your WHMCS license directly, select your main WHMCS license, select the '''Information''' tab, and download Live Chat.
## If you purchased your WHMCS license from a reseller, select your Live Chat purchase, select the '''Downloads''' tab, and download Live Chat.
# Unzip the ZIP file.
# Upload the contents of the <tt>upload_me</tt> directory to the root directory in your WHMCS installation.
# Check to ensure that the <tt>/modules/livehelp/templates_c/</tt> directory is writeable.
# Go to <tt><nowiki>www.example.com/whmcs/modules/livehelp/install</nowiki></tt>, where <tt>www.example.com</tt> is the domain for your WHMCS installation, to complete installation.
# Delete the <tt>/modules/livehelp/install/</tt> directory.

<div class="docs-alert-warning"><strong><i class="fa fa-info-circle"></i> License Update</strong><br />If you purchased the Live Chat Addon prior to installation, you may need to force a license update for your WHMCS installation to recognise the purchase. If you receive a license error or have trouble logging in after installation, log in to the WHMCS Admin Area, go to '''Help > License Information''', and click '''Force License Update'''. Then, reattempt login.</div>

== Using this Addon ==

To log in to Live Chat, visit <tt><nowiki>www.example.com/whmcs/modules/livehelp/admin</nowiki></tt>, where <tt>www.example.com</tt> is the domain for your WHMCS installation.

You can log in using the same username and password that you use for the WHMCS Admin Area.

=== First Login ===

The first time that you use this, a login prompt will display. Enter your account, username and password:

* '''Account or Server:''' Enter the full path to the <tt>modules</tt> directory for your WHMCS installation.
* '''Username / Password:''' Enter the same username and password that you use to log in to the WHMCS Admin Area.
* '''Enable Secure Sign In:''' Enable this if your WHMCS installation uses SSL.
* '''Sign In Automatically:''' Enable this to sign in automatically for future logins. If you enable this, in the future on this device you will only need to enter your password.

For more information, see [https://www.chatstack.com/kb/category/apps/ the ChatStack website].

=== Desktop Applications ===

Downloadable clients are available for Windows®, Mac®, and Linux®. Mobile Apps are also available for iPhone® and Android™.

[https://www.chatstack.com/kb/download-live-chat/ Download the latest version of the Windows desktop application] and follow the automated installation process.

The Windows app has the following minimum requirements:

*Windows 7 / Vista / XP SP 2
*Internet Explorer 7 or above
*[http://www.microsoft.com/downloads/details.aspx?FamilyId=333325FD-AE52-4E35-B531-508D977D32A6 .NET Framework 3.5 SP1 or above]
*Internet Connection

For other operating systems, check their app stores for the downloadable clients.

== Upgrading ==

If you have an earlier version of the Live Chat Addon, perform these steps to upgrade to the latest version:

# Log in [https://www.whmcs.com/members/ here].
# Go to '''Services > All Products & Services'''.
# Select your Live Chat purchase.
# Go to the '''Downloads''' tab.
# Download Live Chat.
# Unzip the ZIP file download.
# Upload the contents of the <tt>upload_me</tt> directory to your WHMCS installation's root directory.
# Log in to the Live Chat Addon administration panel to complete the upgrade process at <tt><nowiki>www.example.com/whmcs/modules/livehelp/admin</nowiki></tt>, where <tt>www.example.com</tt> is the domain for your WHMCS installation.
# Delete the <tt>/modules/livehelp/install/</tt> directory.

== Uninstallation ==

To remove the Live Chat Addon from your installation, delete the <tt>/modules/livehelp/</tt> directory and the <tt>/includes/hooks/livehelp.php</tt> file.

Optionally, you can also remove the database tables that begin with <tt>mod_livehelp</tt>.

== Integration Outside of WHMCS ==

<div class="docs-alert-warning">'''Do Not Attempt''' to add this code to WHMCS templates. Those templates handle it automatically.</div>

To integrate visitor tracking and live help in pages outside of your WHMCS installation (for example, your main website), perform the steps below:

# Add the following lines to each page, once per page, after the <tt><title></tt> tag and jQuery call and before the <tt></head></tt> tag: <br /><source lang="js"><script type="text/javascript">

</script>
</source>Make certain to update<tt><nowiki>www.example.com/support/modules</nowiki></tt> with the path to your WHMCS installation's <tt>modules</tt> directory.
# Optionally, you can either or both of these chat initiation methods:
## To display the Live Chat Operator status and end user chat initiation button:<source lang="js">
<a href="#" class="LiveHelpButton"><img src="http://www.example.com/whmcs/modules/livehelp/status.php" id="LiveHelpStatus" name="LiveHelpStatus" class="LiveHelpStatus" border="0" alt="Live Help" /></a>
</source>
##To display a static text link for chat initiation:<source lang="php">
<a href="#" class="LiveHelpButton">Chat With Us Live</a>
</source>

== Troubleshooting ==

===Chat button non-functional / Blank live chat window===
If clicking the chat button results in nothing happening or the live chat popup window is showing a blank chat window, make certain that the <tt>/modules/livehelp/templates_c/</tt> directory both exists and is writeable.

We recommend that you try the following permissions in this order: <tt>755</tt>, <tt>775</tt>, and <tt>777</tt>.

===The requested content cannot be loaded. Please try again later.===
This message may appear when you click '''Chat Now'''. This indicates that the system cannot create the templates cache.

To resolve this, make certain that the <tt>/modules/livehelp/templates_c/</tt> directory exists and is writeable.

We recommend that you try the following permissions in this order: <tt>755</tt>, <tt>775</tt>, and <tt>777</tt>.

===License Invalid / Unable to login===
If you see a "License Invalid" warning message when you open the Live Chat admin interface, your WHMCS installation has not yet updated to recognise your purchase of the addon. Your WHMCS installation only calls home to validate your license with us periodically. If you recently purchased the addon, you may need to force a local key update to have it take effect.

To do this, navigate to '''Help > [[License Information]]''' and click '''Force License Update'''. Then, attempt logging in again.

===Connection Error===
Connection errors when attempting to log in to the Live Chat administration area are typically due to misconfigured file and folder permissions.

This configuration varies depending on your particular server environment. For example, the permissions setting for the <tt>/modules/livehelp/xml/WebService.php</tt> file should be <tt>644</tt>.

* suPHP and PHP suEXEC require more restriction. If you use DSO as your PHP handler, you '''must''' use <tt>644</tt> permissions.
* Limit access to only the account that owns the web server process. Make sure that no other system or user accounts can read your configuration file or modify any WHMCS-related files.

If the issue persists, enable your [https://help.whmcs.com/m/troubleshooting/l/1312423-an-error-occurred-while-communicating-with-the-server-please-try-again browser network console] and examine the response for more information.

===Incorrect Server/Host===

Receiving this error message in one of the Desktop or Mobile clients indicates that the Live Help installation cannot be found at the given URL. Make certain that you entered the correct URL.

===Sending Emails===

By default, the Live Chat addon will use the <tt>PHP mail()</tt> function, and '''not''' the WHMCS mail configuration, to send emails. To configure sending via SMTP, see [https://www.chatstack.com/kb/setup-smtp-authentication/ Setup SMTP Authentication].

== Change Log ==

See the [https://marketplace.whmcs.com/product/34-live-chat-visitor-tracking Live Chat] Marketplace listing.

Live Chat Addon

2023-10-02T12:56:23Z

AlexN: /* Change Log */

== About this Addon Module ==

Live Chat allows you to chat and engage with customers. It includes in-chat access to customer products and billing, and chat transcripts become support tickets after the chat concludes. You can use Live Chat from a downloadable client that's available for most major mobile and desktop operating systems.

<table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;">
<tr>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th>
<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th>
</tr>
<tr>
<td style="border:1px #AAA solid;padding:0.2em;">Live Chat Addon'</td>
<td style="border:1px #AAA solid;padding:0.2em;">17th May 2021</td>
<td style="border:1px #AAA solid;padding:0.2em;">5.8.9800</td>
<td style="border:1px #AAA solid;padding:0.2em;">WHMCS 8.0 and later</td>
<td style="border:1px #AAA solid;padding:0.2em;color:darkred;">No</td>
</tr>
</table>

[[File:Available_on_marketplace.png|link=https://marketplace.whmcs.com/product/34]]

== Activating Live Chat Addon ==

Before you can activate Live Chat, you must download it from the WHMCS Marketplace.

<html><a href="http://www.youtube.com/watch?v=fcCKomdCe4Y&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>

To do this:

# If you have not already purchased it, purchase Live Chat from [https://marketplace.whmcs.com/product/34 the Live Chat listing].
# [https://www.whmcs.com/members/ Log in here].
# Go to '''Services > All Products & Services'''.
# Perform one of the following actions:
## If you purchased your WHMCS license directly, select your main WHMCS license, select the '''Information''' tab, and download Live Chat.
## If you purchased your WHMCS license from a reseller, select your Live Chat purchase, select the '''Downloads''' tab, and download Live Chat.
# Unzip the ZIP file.
# Upload the contents of the <tt>upload_me</tt> directory to the root directory in your WHMCS installation.
# Check to ensure that the <tt>/modules/livehelp/templates_c/</tt> directory is writeable.
# Go to <tt><nowiki>www.example.com/whmcs/modules/livehelp/install</nowiki></tt>, where <tt>www.example.com</tt> is the domain for your WHMCS installation, to complete installation.
# Delete the <tt>/modules/livehelp/install/</tt> directory.

<div class="docs-alert-warning"><strong><i class="fa fa-info-circle"></i> License Update</strong><br />If you purchased the Live Chat Addon prior to installation, you may need to force a license update for your WHMCS installation to recognise the purchase. If you receive a license error or have trouble logging in after installation, log in to the WHMCS Admin Area, go to '''Help > License Information''', and click '''Force License Update'''. Then, reattempt login.</div>

== Using this Addon ==

To log in to Live Chat, visit <tt><nowiki>www.example.com/whmcs/modules/livehelp/admin</nowiki></tt>, where <tt>www.example.com</tt> is the domain for your WHMCS installation.

You can log in using the same username and password that you use for the WHMCS Admin Area.

=== First Login ===

The first time that you use this, a login prompt will display. Enter your account, username and password:

* '''Account or Server:''' Enter the full path to the <tt>modules</tt> directory for your WHMCS installation.
* '''Username / Password:''' Enter the same username and password that you use to log in to the WHMCS Admin Area.
* '''Enable Secure Sign In:''' Enable this if your WHMCS installation uses SSL.
* '''Sign In Automatically:''' Enable this to sign in automatically for future logins. If you enable this, in the future on this device you will only need to enter your password.

For more information, see [https://www.chatstack.com/kb/category/apps/ the ChatStack website].

=== Desktop Applications ===

Downloadable clients are available for Windows®, Mac®, and Linux®. Mobile Apps are also available for iPhone® and Android™.

[https://www.chatstack.com/kb/download-live-chat/ Download the latest version of the Windows desktop application] and follow the automated installation process.

The Windows app has the following minimum requirements:

*Windows 7 / Vista / XP SP 2
*Internet Explorer 7 or above
*[http://www.microsoft.com/downloads/details.aspx?FamilyId=333325FD-AE52-4E35-B531-508D977D32A6 .NET Framework 3.5 SP1 or above]
*Internet Connection

For other operating systems, check their app stores for the downloadable clients.

== Upgrading ==

If you have an earlier version of the Live Chat Addon, perform these steps to upgrade to the latest version:

# Log in [https://www.whmcs.com/members/ here].
# Go to '''Services > All Products & Services'''.
# Select your Live Chat purchase.
# Go to the '''Downloads''' tab.
# Download Live Chat.
# Unzip the ZIP file download.
# Upload the contents of the <tt>upload_me</tt> directory to your WHMCS installation's root directory.
# Log in to the Live Chat Addon administration panel to complete the upgrade process at <tt><nowiki>www.example.com/whmcs/modules/livehelp/admin</nowiki></tt>, where <tt>www.example.com</tt> is the domain for your WHMCS installation.
# Delete the <tt>/modules/livehelp/install/</tt> directory.

== Uninstallation ==

To remove the Live Chat Addon from your installation, delete the <tt>/modules/livehelp/</tt> directory and the <tt>/includes/hooks/livehelp.php</tt> file.

Optionally, you can also remove the database tables that begin with <tt>mod_livehelp</tt>.

== Integration Outside of WHMCS ==

<div class="docs-alert-warning">'''Do Not Attempt''' to add this code to WHMCS templates. Those templates handle it automatically.</div>

To integrate visitor tracking and live help in pages outside of your WHMCS installation (for example, your main website), perform the steps below:

# Add the following lines to each page, once per page, after the <tt><title></tt> tag and jQuery call and before the <tt></head></tt> tag: <br /><source lang="js"><script type="text/javascript">

</script>
</source>Make certain to update<tt><nowiki>www.example.com/support/modules</nowiki></tt> with the path to your WHMCS installation's <tt>modules</tt> directory.
# Optionally, you can either or both of these chat initiation methods:
## To display the Live Chat Operator status and end user chat initiation button:<source lang="js">
<a href="#" class="LiveHelpButton"><img src="http://www.example.com/whmcs/modules/livehelp/status.php" id="LiveHelpStatus" name="LiveHelpStatus" class="LiveHelpStatus" border="0" alt="Live Help" /></a>
</source>
##To display a static text link for chat initiation:<source lang="php">
<a href="#" class="LiveHelpButton">Chat With Us Live</a>
</source>

== Troubleshooting ==

===Chat button non-functional / Blank live chat window===
If clicking the chat button results in nothing happening or the live chat popup window is showing a blank chat window, make certain that the <tt>/modules/livehelp/templates_c/</tt> directory both exists and is writeable.

We recommend that you try the following permissions in this order: <tt>755</tt>, <tt>775</tt>, and <tt>777</tt>.

===The requested content cannot be loaded. Please try again later.===
This message may appear when you click '''Chat Now'''. This indicates that the system cannot create the templates cache.

To resolve this, make certain that the <tt>/modules/livehelp/templates_c/</tt> directory exists and is writeable.

We recommend that you try the following permissions in this order: <tt>755</tt>, <tt>775</tt>, and <tt>777</tt>.

===License Invalid / Unable to login===
If you see a "License Invalid" warning message when you open the Live Chat admin interface, your WHMCS installation has not yet updated to recognise your purchase of the addon. Your WHMCS installation only calls home to validate your license with us periodically. If you recently purchased the addon, you may need to force a local key update to have it take effect.

To do this, navigate to '''Help > [[License Information]]''' and click '''Force License Update'''. Then, attempt logging in again.

===Connection Error===
Connection errors when attempting to log in to the Live Chat administration area are typically due to misconfigured file and folder permissions.

This configuration varies depending on your particular server environment. For example, the permissions setting for the <tt>/modules/livehelp/xml/WebService.php</tt> file should be <tt>644</tt>.

* suPHP and PHP suEXEC require more restriction. If you use DSO as your PHP handler, you '''must''' use <tt>644</tt> permissions.
* Limit access to only the account that owns the web server process. Make sure that no other system or user accounts can read your configuration file or modify any WHMCS-related files.

If the issue persists, enable your [https://help.whmcs.com/m/troubleshooting/l/1312423-an-error-occurred-while-communicating-with-the-server-please-try-again browser network console] and examine the response for more information.

===Incorrect Server/Host===

Receiving this error message in one of the Desktop or Mobile clients indicates that the Live Help installation cannot be found at the given URL. Make certain that you entered the correct URL.

===Sending Emails===

By default, the Live Chat addon will use the <tt>PHP mail()</tt> function, and '''not''' the WHMCS mail configuration, to send emails. To configure sending via SMTP, see [https://www.chatstack.com/kb/setup-smtp-authentication/ Setup SMTP Authentication].

== Change Log ==

See the [https://marketplace.whmcs.com/product/46-importassist#changelog ImportAssist] Marketplace listing.

Live Chat Addon

2023-10-02T12:55:53Z

AlexN: /* Change Log */

Enabling Error Reporting

2023-07-12T11:39:10Z

AlexN: /* PHP Warnings and Notices */

==Getting Error Information==

The WHMCS [[Error Management]] system includes many useful options. '''Display Errors''' allows you to view additional information about critical errors.

===When Should You Enable Display Errors===

'''Display Errors''' provides additional information when you experience a critical error that results in one of the following issues:

* Friendly "Oops!" pages
* Entirely blank pages
* Partially rendered pages

In most cases, use the '''Log Errors''' and '''SQL Debug Mode''' options first. These options will usually capture the same information that '''Display Errors''' renders. In the event that these options are not viable or do not yield any information, '''Display Errors''' is a good alternative.

'''Display Errors''' will show your error information to anyone who is encountering the same error condition. Avoid showing errors to visitors or non-privileged staff whenever possible.''

===Typical Causes===

Some of the most common causes of "Oops!", partial, or empty page rendering include:

* Missing or corrupted files or incomplete uploads.
* The server doesn't meet the [[System Requirements|minimum system requirements]].
* PHP, Apache, or ionCube Loader®-related errors.
* Incompatible hooks or addons.
* Syntax errors in custom modules, hooks, or templates.

==Enabling Error Reporting==

===Enabling From The Admin Area===

If possible, attempt the following steps to enable '''Display Errors''' via the [[Admin Area]]:

# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
# Choose the '''[[Other Tab|Other]]''' tab.
# Select '''Display Errors'''.
# Click '''Save Changes'''.
# Retry the steps that previously led to the blank or partially-rendered page. The system will display additional error information.

''Remember to disable Display Errors when you are finished troubleshooting. Leaving error display enabled can be a security concern.''

===Enabling From Your Configuration File===

If the error is severe enough, you may not be able to log in to the admin area. In those situations, there is a manual configuration file flag option that you can add to the <tt>configuration.php</tt> file in the WHMCS root directory to enable error reporting.

Add the lines to the end of the <tt>configuration.php</tt> file. This will be immediately before the closing PHP tag (''?>'') if your <tt>configuration.php</tt> file has one. If it doesn't, this will be after the last line in the file.

<source lang="php">
$display_errors = true;
</source>

After adding the lines and saving and uploading the file, retry the steps that previously led to the blank or partially rendered page. The system will display additional error information.

''Remember to disable '''Display Errors''' when you are finished troubleshooting. Leaving error display enabled can be a security concern.''

==Disabling Error Reporting==

===Disabling from the admin area===

If you enabled error reporting via the admin area, make sure to follow the steps below after you finish troubleshooting:

# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
# Choose the '''[[Other Tab|Other]]''' tab.
# Deselect '''Display Errors''' at the bottom of the page.
# Click '''Save Changes'''.

===Disabling from the configuration.php file===

If you enabled error reporting via the <tt>configuration.php</tt> file, make sure to remove the following line from the <tt>configuration.php</tt> file after you finish troubleshooting.

<source lang="php">
$display_errors = true;
</source>

Sometimes, you may also see the following lines in <tt>configuration.php</tt> file:

<source lang="php">
$display_errors = E_NOTICE;
$display_errors = E_ALL;
</source>

As a precaution, remove any lines starting with <tt>$display_errors</tt> from the <tt>configuration.php</tt> file.

==PHP Warnings and Notices==

If the Display Error options are disabled and you're still seeing warning messages, it indicates the Error Reporting level in your server's PHP configuration is too high. This is a PHP configuration level issue. Shared hosting or reseller users may require the assistance of the hosting provider.

If you have sufficient access and have configured your server to use WHM for administration, follow these steps:

# In WHM, navigate to '''Software >> MultiPHP INI Editor'''.
# Click the '''Editor Mode''' tab.
# Select your PHP version from the '''Select a PHP version''' menu.
# Scroll down to the <tt>error_reporting</tt> setting.
# Change the value to the following string:
<source lang="sql">E_ALL & ~E_WARNING & ~E_USER_WARNING & ~E_NOTICE & ~E_USER_NOTICE & ~E_STRICT & ~E_DEPRECATED & ~E_USER_DEPRECATED</source>

If you have set it correctly, the <tt>error_reporting</tt> variable within the server's PHP configuration will show a numerical value of <tt>4597</tt>.

Enabling Error Reporting

2023-07-12T11:38:20Z

AlexN: /* PHP Warnings and Notices */

==Getting Error Information==

The WHMCS [[Error Management]] system includes many useful options. '''Display Errors''' allows you to view additional information about critical errors.

===When Should You Enable Display Errors===

'''Display Errors''' provides additional information when you experience a critical error that results in one of the following issues:

* Friendly "Oops!" pages
* Entirely blank pages
* Partially rendered pages

In most cases, use the '''Log Errors''' and '''SQL Debug Mode''' options first. These options will usually capture the same information that '''Display Errors''' renders. In the event that these options are not viable or do not yield any information, '''Display Errors''' is a good alternative.

'''Display Errors''' will show your error information to anyone who is encountering the same error condition. Avoid showing errors to visitors or non-privileged staff whenever possible.''

===Typical Causes===

Some of the most common causes of "Oops!", partial, or empty page rendering include:

* Missing or corrupted files or incomplete uploads.
* The server doesn't meet the [[System Requirements|minimum system requirements]].
* PHP, Apache, or ionCube Loader®-related errors.
* Incompatible hooks or addons.
* Syntax errors in custom modules, hooks, or templates.

==Enabling Error Reporting==

===Enabling From The Admin Area===

If possible, attempt the following steps to enable '''Display Errors''' via the [[Admin Area]]:

# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
# Choose the '''[[Other Tab|Other]]''' tab.
# Select '''Display Errors'''.
# Click '''Save Changes'''.
# Retry the steps that previously led to the blank or partially-rendered page. The system will display additional error information.

''Remember to disable Display Errors when you are finished troubleshooting. Leaving error display enabled can be a security concern.''

===Enabling From Your Configuration File===

If the error is severe enough, you may not be able to log in to the admin area. In those situations, there is a manual configuration file flag option that you can add to the <tt>configuration.php</tt> file in the WHMCS root directory to enable error reporting.

Add the lines to the end of the <tt>configuration.php</tt> file. This will be immediately before the closing PHP tag (''?>'') if your <tt>configuration.php</tt> file has one. If it doesn't, this will be after the last line in the file.

<source lang="php">
$display_errors = true;
</source>

After adding the lines and saving and uploading the file, retry the steps that previously led to the blank or partially rendered page. The system will display additional error information.

''Remember to disable '''Display Errors''' when you are finished troubleshooting. Leaving error display enabled can be a security concern.''

==Disabling Error Reporting==

===Disabling from the admin area===

If you enabled error reporting via the admin area, make sure to follow the steps below after you finish troubleshooting:

# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
# Choose the '''[[Other Tab|Other]]''' tab.
# Deselect '''Display Errors''' at the bottom of the page.
# Click '''Save Changes'''.

===Disabling from the configuration.php file===

If you enabled error reporting via the <tt>configuration.php</tt> file, make sure to remove the following line from the <tt>configuration.php</tt> file after you finish troubleshooting.

<source lang="php">
$display_errors = true;
</source>

Sometimes, you may also see the following lines in <tt>configuration.php</tt> file:

<source lang="php">
$display_errors = E_NOTICE;
$display_errors = E_ALL;
</source>

As a precaution, remove any lines starting with <tt>$display_errors</tt> from the <tt>configuration.php</tt> file.

==PHP Warnings and Notices==

If the Display Error options are disabled and you're still seeing warning messages, it indicates the Error Reporting level in your server's PHP configuration is too high. This is a PHP configuration level issue. Shared hosting or reseller users may require the assistance of the hosting provider.

If you have sufficient access and have configured your server to use WHM for administration, follow these steps:

# In WHM, navigate to '''Software >> MultiPHP INI Editor'''.
# Click the '''Editor Mode''' tab.
# Select your PHP version from the '''Select a PHP version''' menu.
# Scroll down to the <tt>error_reporting</tt> setting.
# Change the value to the following string:
<source lang="sql">E_ALL & ~E_WARNING & ~E_USER_WARNING & ~E_NOTICE & ~E_USER_NOTICE & ~E_STRICT & ~E_DEPRECATED & ~E_USER_DEPRECATED</source>

When correctly set, the <tt>error_reporting</tt> variable within the server's PHP configuration will show a numerical value of <tt>4597</tt>.

Configuring Sign-In using Google

2023-05-30T08:32:56Z

AlexN: /* Configuring Sign-In with Google */

Enabling the Google [[Sign-In Integrations]] enables visitors and customers to register, sign in, and connect their Google accounts with your WHMCS installation for faster signup and automatic sign-in.

[[File:Signinintegrationslogin.png]]

== Configuring Sign-In with Google ==

Google Sign-In Integration requires a Google Developer Project and API credentials. You can create this using your existing Google account. Users will only see the app name you define and will not see anything relating to the account you use to create the project.

To do this:

# Visit <tt>https://console.developers.google.com/</tt>.
# Log in to your Google account. <div class="docs-alert-warning">Changing the Google account you use to create the app requires users to reauthenticate and relink their accounts.</div>
# Choose '''Select a project''' on the top menu.<br/>[[File:Google-sign-in-1.png|600px]]<br/><br/>
# Choose '''New Project'''.<br/>[[File:Google-sign-in-2.png|600px]]<br/><br/>
# Enter a project name.<br/>[[File:Google-sign-in-3.png|600px]]<br/><br/>
# Click '''Create'''.
# Select '''Credentials''' in the left sidebar.
# Choose '''Create Credentials'''.<br/>[[File:Google-sign-in-5.png|600px]]<br/><br/>
# Select '''OAuth client ID'''.
# Click '''Configure Consent Screen'''.
# Select '''External'''.<br/>[[File:Google-sign-in-6.png|600px]]<br/><br/>
# Click '''Create'''.
# Add app information details.<br/>[[File:Google-sign-in-7.png|600px]]<br/><br/>
# Add an app domain.<br/>[[File:Google-sign-in-8.png|600px]]<br/><br/>
# Add authorised domains.<br/>[[File:Google-sign-in-9.png|600px]]<br/><br/>
# Add developer contact information.<br/>[[File:Google-sign-in-10.png|600px]]<br/><br/>
# Click '''Save and Continue'''.
# Select '''Credentials''' in the left sidebar.
# Choose '''Create Credentials'''.
# Select '''OAuth client ID'''.
# Choose '''Web Application'''.<br/>[[File:Google-sign-in-11.png|600px]]<br/><br/>
# Enter a name for your OAuth 2.0 client.
# Enter your full root domain in '''Authorized JavaScript origins'''.<br/>[[File:Google-sign-in-12.png|600px]]<br/><br/>
# Enter your full root domain in '''Authorized redirect URI'''.<br/>[[File:Google-sign-in-13.png|600px]]<br/><br/>
# Click '''Create'''.
# Save your client ID and secret, which you will use to activate Google Sign-In within WHMCS. <br/>[[File:Google-sign-in-14.png|600px]]<br/><br/>
# Log in to the WHMCS [[Admin Area]].
# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Sign-In Integrations]]''' or, prior to WHMCS 8.0, '''Setup > Sign-In Integrations'''.
# Select '''Activate''' under the Google heading.
# Enter your Google Client ID and Client Secret.
# Click '''Save & Activate'''.

WHMCS will attempt to validate the details you have entered. If the client ID and secret are valid and successfully authenticate with the Google API, the values will be saved.

For troubleshooting help, see [[Troubleshooting Sign-In using Google]].

Skrill 1-Tap

2023-04-17T09:48:27Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-Tap repeat payments and recurring payments using the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] Skrill payment gateway
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [https://www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API or MQI password. You must use a separate password for API or MQI requests. This ensures that you can change the password that you use to access your Skrill Digital Wallet account.
#*# Click '''Save''' to confirm
#*# Specify at least one IP address from which the system will make requests will be made. You can grant access to a single IP address (for example <tt>192.168.0.2</tt>), multiple IP addresses, separated by a space (for example <tt>192.168.0.2 10.0.0.2</tt>) or a subnet in CIDR notation (for example <tt>175.10.10.252/30</tt>). CIDR ranges should be no longer than 256 IP addresses.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-04-17T09:48:04Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-Tap repeat payments and recurring payments using the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] Skrill payment gateway
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [https://www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API or MQI password. You must use a separate password for API or MQI requests. This ensures that you can change the password that you use to access your Skrill Digital Wallet account.
#*# Click '''Save''' to confirm
#*# Specify at least one IP address from which the system will make requests will be made. You can grant access to a single IP address (for example <tt>192.168.0.2</tt>), multiple IP addresses, separated by a space (for example 192.168.0.2 10.0.0.2) or a subnet in CIDR notation (for example 175.10.10.252/30). CIDR ranges should be no longer than 256 IP addresses.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-04-17T09:47:43Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-Tap repeat payments and recurring payments using the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] Skrill payment gateway
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [https://www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API or MQI password. You must use a separate password for API or MQI requests. This ensures that you can change the password that you use to access your Skrill Digital Wallet account.
#*# Click '''Save''' to confirm
#*# Specify at least one IP address from which the system will make requests will be made. You can grant access to a single IP address (for example <tt>192.168.0.2<tt>), multiple IP addresses, separated by a space (for example 192.168.0.2 10.0.0.2) or a subnet in CIDR notation (for example 175.10.10.252/30). CIDR ranges should be no longer than 256 IP addresses.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-04-17T09:46:28Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-Tap repeat payments and recurring payments using the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] Skrill payment gateway
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [https://www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API or MQI password. You must use a separate password for API or MQI requests. This ensures that you can change the password that you use to access your Skrill Digital Wallet account.
#*# Click '''Save''' to confirm
#*# Specify at least one IP address from which requests will be made. Access can be granted to a single IP address (e.g. 192.168.0.2), multiple IP addresses, separated by a space (e.g. 192.168.0.2 10.0.0.2) or a subnet in CIDR notation (e.g. 175.10.10.252/30). CIDR ranges should be no longer than 256 IP addresses.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-04-17T09:46:05Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-Tap repeat payments and recurring payments using the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] Skrill payment gateway
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [https://www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API or MQI password. You must use a separate password for API or MQI requests. This ensures that the password you use to access your Skrill Digital Wallet account can be changed without affecting the API or MQI.
#*# Click '''Save''' to confirm
#*# Specify at least one IP address from which requests will be made. Access can be granted to a single IP address (e.g. 192.168.0.2), multiple IP addresses, separated by a space (e.g. 192.168.0.2 10.0.0.2) or a subnet in CIDR notation (e.g. 175.10.10.252/30). CIDR ranges should be no longer than 256 IP addresses.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-04-17T09:45:44Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-Tap repeat payments and recurring payments using the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] Skrill payment gateway
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [https://www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API or MQI password. You must use a separate password for API or MQI requests. This ensures that the password you use to access your Skrill Digital Wallet account can be changed without affecting the API or MQI.
#*# Click "Save" to confirm
#*# Specify at least one IP address from which requests will be made. Access can be granted to a single IP address (e.g. 192.168.0.2), multiple IP addresses, separated by a space (e.g. 192.168.0.2 10.0.0.2) or a subnet in CIDR notation (e.g. 175.10.10.252/30). CIDR ranges should be no longer than 256 IP addresses.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-04-17T09:44:40Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-Tap repeat payments and recurring payments using the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] Skrill payment gateway
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [https://www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API or MQI password, and click Save to confirm. You must use a separate password for API or MQI requests. This ensures that the password you use to access your Skrill Digital Wallet account can be changed without affecting the API or MQI.
#*# Specify at least one IP address from which requests will be made. Access can be granted to a single IP address (e.g. 192.168.0.2), multiple IP addresses, separated by a space (e.g. 192.168.0.2 10.0.0.2) or a subnet in CIDR notation (e.g. 175.10.10.252/30). CIDR ranges should be no longer than 256 IP addresses.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-04-17T09:43:44Z

AlexN: /* About this Module */

== About this Module ==

This module allows you to process Skrill 1-Tap repeat payments and recurring payments using the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] Skrill payment gateway
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [https://www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API / MQI Password, and click Save to confirm. You must use a separate password for API or MQI requests. This ensures that the password you use to access your Skrill Digital Wallet account can be changed without affecting the API or MQI.
#*# Specify at least one IP address from which requests will be made. Access can be granted to a single IP address (e.g. 192.168.0.2), multiple IP addresses, separated by a space (e.g. 192.168.0.2 10.0.0.2) or a subnet in CIDR notation (e.g. 175.10.10.252/30). CIDR ranges should be no longer than 256 IP addresses.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-04-17T09:43:25Z

AlexN: /* About this Module */

== About this Module ==

This module allows you to process Skrill 1-Tap repeat payments and recurring payments using the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] Skrill payment gateway

{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [https://www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API / MQI Password, and click Save to confirm. You must use a separate password for API or MQI requests. This ensures that the password you use to access your Skrill Digital Wallet account can be changed without affecting the API or MQI.
#*# Specify at least one IP address from which requests will be made. Access can be granted to a single IP address (e.g. 192.168.0.2), multiple IP addresses, separated by a space (e.g. 192.168.0.2 10.0.0.2) or a subnet in CIDR notation (e.g. 175.10.10.252/30). CIDR ranges should be no longer than 256 IP addresses.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-03-07T14:03:59Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-tap for repeat payments with a single touch and recurring payments. It can be used to process recurring payments via the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] payment gateway.
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API / MQI Password, and click Save to confirm. You must use a separate password for API or MQI requests. This ensures that the password you use to access your Skrill Digital Wallet account can be changed without affecting the API or MQI.
#*# Specify at least one IP address from which requests will be made. Access can be granted to a single IP address (e.g. 192.168.0.2), multiple IP addresses, separated by a space (e.g. 192.168.0.2 10.0.0.2) or a subnet in CIDR notation (e.g. 175.10.10.252/30). CIDR ranges should be no longer than 256 IP addresses.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-03-07T14:01:06Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-tap for repeat payments with a single touch and recurring payments. It can be used to process recurring payments via the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] payment gateway.
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API / MQI Password, and click Save to confirm. You must use a separate password for API or MQI requests. This ensures that the password you use to access your Skrill Digital Wallet account can be changed without affecting the API or MQI.
#*# Specify at least one IP address from which requests will be made. Access can be granted to a single IP address (e.g. 192.168.0.2), multiple IP addresses, separated by a space (e.g. 192.168.0.2 10.0.0.2) or a subnet in CIDR notation (e.g. 175.10.10.252/30). CIDR ranges should be no longer than 256 IP addresses.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
# Click '''Save Changes'''.

<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-03-07T14:00:16Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-tap for repeat payments with a single touch and recurring payments. It can be used to process recurring payments via the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] payment gateway.
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API / MQI Password, and click Save to confirm. You must use a separate password for API or MQI requests. This ensures that the password you use to access your Skrill Digital Wallet account can be changed without affecting the API or MQI.
#*# Specify at least one IP address from which requests will be made. Access can be granted to:
#*# A single IP address (e.g. 192.168.0.2).
* Multiple IP addresses, separated by a space (e.g. 192.168.0.2 10.0.0.2) .
* A subnet in CIDR notation (e.g. 175.10.10.252/30). Warning: CIDR ranges should be no longer than 256 IP addresses.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
# Click '''Save Changes'''.

<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-03-07T13:58:52Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-tap for repeat payments with a single touch and recurring payments. It can be used to process recurring payments via the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] payment gateway.
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API / MQI Password, and click Save to confirm. You must use a separate password for API or MQI requests. This ensures that the password you use to access your Skrill Digital Wallet account can be changed without affecting the API or MQI.
#*# Specify at least one IP address from which requests will be made. Access can be granted to:
* A single IP address (e.g. 192.168.0.2).
* Multiple IP addresses, separated by a space (e.g. 192.168.0.2 10.0.0.2) .
* A subnet in CIDR notation (e.g. 175.10.10.252/30). Warning: CIDR ranges should be no longer than 256 IP addresses.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
# Click '''Save Changes'''.

<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-03-07T13:58:02Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-tap for repeat payments with a single touch and recurring payments. It can be used to process recurring payments via the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] payment gateway.
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API / MQI Password, and click Save to confirm.
<div class="docs-alert-info">
You must use a separate password for API or MQI requests. This ensures that the password you use to access your Skrill Digital Wallet account can be changed without affecting the API or MQI.
</div>
#*# Specify at least one IP address from which requests will be made.
<div class="docs-alert-info">
Access can be granted to:
* A single IP address (e.g. 192.168.0.2).
* Multiple IP addresses, separated by a space (e.g. 192.168.0.2 10.0.0.2) .
* A subnet in CIDR notation (e.g. 175.10.10.252/30). Warning: CIDR ranges should be no longer than 256 IP addresses.
</div>
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
# Click '''Save Changes'''.

<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-03-07T13:54:46Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-tap for repeat payments with a single touch and recurring payments. It can be used to process recurring payments via the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] payment gateway.
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API / MQI Password, and click Save to confirm.
#*# Specify at least one IP address from which requests will be made.
<div class="docs-alert-info">
Access can be granted to:
* A single IP address (e.g. 192.168.0.2).
* Multiple IP addresses, separated by a space (e.g. 192.168.0.2 10.0.0.2) .
* A subnet in CIDR notation (e.g. 175.10.10.252/30). Warning: CIDR ranges should be no longer than 256 IP addresses.
You must use a separate password for API or MQI requests. This ensures that the password you use to access your Skrill Digital Wallet account can be changed without affecting the API or MQI.
</div>
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
# Click '''Save Changes'''.

<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-03-07T13:51:14Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-tap for repeat payments with a single touch and recurring payments. It can be used to process recurring payments via the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] payment gateway.
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Set the API / MQI Password, and click Save to confirm.
#*# Specify at least one IP address from which requests will be made.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
# Click '''Save Changes'''.

<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-03-07T13:48:52Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-tap for repeat payments with a single touch and recurring payments. It can be used to process recurring payments via the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] payment gateway.
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [www.skrill.com Skrill].[[File:Skrill api.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Check '''Enable service''' next to the API and MQI.
#*# Specify at least one IP address or range of IP addresses from which to allow requests. The system will deny all other requests.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
# Click '''Save Changes'''.

<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

File:Skrill api.png

2023-03-07T13:48:36Z

AlexN:

Skrill 1-Tap

2023-03-07T13:47:20Z

AlexN: /* Adding the Skrill 1-Tap Payment Gateway */

== About this Module ==

This module allows you to process Skrill 1-tap for repeat payments with a single touch and recurring payments. It can be used to process recurring payments via the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] payment gateway.
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [www.skrill.com Skrill].[[File:skrill_api_ip_settings.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings > API / MQI / GSR / CVT Management'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Check '''Enable service''' next to the API and MQI.
#*# Specify at least one IP address or range of IP addresses from which to allow requests. The system will deny all other requests.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
# Click '''Save Changes'''.

<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Skrill 1-Tap

2023-03-07T13:45:48Z

AlexN: /* About this Module */

== About this Module ==

This module allows you to process Skrill 1-tap for repeat payments with a single touch and recurring payments. It can be used to process recurring payments via the [https://www.skrill.com/en/business/shopping-carts/whmcs/ Skrill] payment gateway.
{{gateways
| onetime = yes
| recurring = yes
| refunds = yes
}}

== Adding the Skrill 1-Tap Payment Gateway ==

To set up the Skrill 1-Tap payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
# Click '''Skrill 1-Tap'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Skrill 1-Tap credentials.
#* To enable the MQI or API:
#*# Log in to [www.skrill.com Skrill].[[File:skrill_api_ip_settings.png|200px|thumb|right|Enable the API and MQI and setup a password and IP range for these services]]
#*# Go to '''Settings > Developer Settings'''. If the '''Settings > Developer Settings''' section is not displayed in the Skrill account, contact [mailto:merchantservices@skrill.com Skrill Merchant Services].
#*# Check '''Enable service''' next to the API and MQI.
#*# Specify at least one IP address or range of IP addresses from which to allow requests. The system will deny all other requests.
#*# Click '''Save'''
#*# Enable an API or MQI password:
#*## Go to '''Settings >> Developer Settings > Change MQI / API password'''.
#*## Enter and confirm a new password.<div class="docs-alert-info">The password must be at least 8 characters long and must contain at least one alphabetic and one non-alphabetic character.</div>
#*## Click '''Save'''.
# Click '''Save Changes'''.

<div class="docs-alert-info">
* If you already receive wallet payments with Skrill, [mailto:merchantservices@skrill.com contact the merchant services team] to enable 1-Tap for your existing account.
* If you receive direct payments via '''Skrill Quick Checkout''', [https://signup.skrill.com/business/#/?lang=EN&rid=96648253 sign up for 1-Tap]. You will need to register a new email address that you have not already used with Skrill.</div>

=== Test Mode ===

This module does not support test mode.

== Troubleshooting ==

''N/A''

{{modules}}

Hiding and Retiring Products

2023-03-07T13:44:30Z

AlexN: /* When to Use It */

==Introduction==
Hiding and retiring products can be used when products are no longer offered, or when products should only be available when a direct link to the product is available.

Also applies to product addons - the same options appear in the same place when editing a product addon.

==Hiding a Product==

===When to Use It===

When a product is hidden, this will stop it from appearing on the order pages in the client area. If a user has a direct link to the product, it can still be purchased.
Hidden products should be used when an admin still wishes to sell the product, but only to those with a direct link, or from the Admin area.

===How to set it===

When editing the product in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services''', check '''Hidden''' box on the '''Details''' tab to set the product as hidden.

==Retiring==

===When to Use It===

A retired product will stop any new orders for the product from the admin and client areas. This will not affect existing products. However, if you change the service from a retired product, you will not be able to change it back to that product later. A retired product can still be ordered via the API.

===How to set it===

When editing the product, check the '''retired''' box on the details tab to set the product as retired.

Friendly URLs

2023-01-24T13:38:32Z

AlexN: /* Other Friendly URLs */

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> We added this feature in WHMCS 7.2.</div>

Many parts of WHMCS can be accessed through search-engine-friendly URLs. The way in which WHMCS processes these depends on your server environment.

== What is a Friendly URL? ==

By default, URLs in WHMCS use the following format:

<div class="source-cli">/knowledgebase.php?action=view&id=1</div>

However, when you enable Search Engine Friendly URLs, they use this format:

<div class="source-cli">/knowledgebase/1/How_do_I_access_my_control_panel.html</div>

You can enable these for MarketConnect landing pages, announcements, downloads, and the knowledgebase sections of the WHMCS Client Area.

==Product and Product Group Friendly URLs==

<div class="docs-alert-info"> We added product group URLs in WHMCS 8.0 and product URLs in WHMCS 8.3.</div>

When you click '''Edit''' for a product group or product at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services''', the system displays a link for the group or various links for the product. You can use these links to direct clients to a specific page or to load the product into their cart and immediately take them to the configuration step for that product.

[[File:link-tab-urls-83.png|thumb|]]

For more information, see [[Linking to WHMCS]].

== Other Friendly URLs ==

<div class="docs-alert-info"> We added these features in WHMCS 7.2.</div>

You can use the settings in the '''[[General Tab|General]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings''' to configure the following behavior:

* WHMCS's behavior for other friendly URLs.
* The mode that WHMCS uses.

WHMCS uses the URI path mode when it constructs URIs, URLs, or relative paths in rendered output (for example, links on pages).

[[File:friendly_uri_setting.png|700px]]

For more information about each setting, help for selecting your configuration, and examples of related <tt>.htaccess</tt> rules, see [[General_Tab#WHMCS_Rules|General Tab]].

[[File:Friendly_Url_Simple_Mode_Select.png|280px]]

<div class="docs-alert-info"> WHMCS is unable to detect the most viable '''Friendly URL''' setting for your installation when you have enabled '''Maintenance Mode''', because the system defaults to Basic URLs.</div>

=== Upgrading to WHMCS 7.2 ===

Upon installation (or upgrade to v7.2), WHMCS will perform an evaluation of your current environment. This evaluation will inspect the following:

A. Does the current environment support Apache Mod_Rewrite?

B. Is there an .htaccess file within the WHMCS root directory?

C. If there is an .htaccess file, are the contents identical to the suggested ruleset provided in htaccess.txt of previous WHMCS releases?

D. If there is an .htaccess file, and it is not identical to previous releases' ruleset suggestions, do the contents contain the WHMCS comment marks indicating WHMCS has leveraged this file in the past?

After the evaluation, one of the following will occur:

* If the current environment is not supported (not A), then Auto-Managed Rewrite is disabled and and no further action will be taken.

* If the environment is supported (A) and a .htaccess file does exist (not B), Auto-Managed Rewrite will be enabled and a fresh .htaccess file will be created with the latest WHMCS rewrite ruleset. Any future update of WHMCS that requires a change to the rewrite ruleset will be applied automatically during the update process.

* If the environment is supported (A) and there is an .htaccess file (B), only if the contents are solely WHMCS content (C) or the WHMCS ruleset has been managed by WHMCS automation along with your own custom rules (D) will Auto-Managed Rewrite be enabled. The current .htaccess file will be updated to the current WHMCS ruleset. Any future update of WHMCS that requires a change to the rewrite ruleset will be applied automatically during the update process.

* If the environment is supported (A) and there is a .htaccess file (B), but it is not solely WHMCS content or there is no indication that WHMCS can manage its rules along side your custom rules (neither C or D), then Auto-Managed Rewrite is disabled and no further action will be taken.

Setup/Configuration

2023-01-12T08:43:54Z

AlexN: /* Popular In This Section */

<noinclude>
WHMCS has many options which control how the software operates. This section details the setup and configuration options available, select a category to see related settings:

<div class="row">
<div class="col-sm-4 col-md-3">
<div class="home-button"><i class="fa fas fa-wrench"></i>[[General Configuration]]</div>
</div>
<div class="col-sm-4 col-md-3">
<div class="home-button"><i class="fa fas fa-credit-card"></i>[[Payment Configuration]]</div>
</div>
<div class="col-sm-4 col-md-3">
<div class="home-button"><i class="fa fas fa-shopping-cart"></i>[[Products/Services Configuration]]</div>
</div>
<div class="col-sm-4 col-md-3">
<div class="home-button"><i class="fa fas fa-life-ring"></i>[[Support Configuration]]</div>
</div>
<div class="col-sm-4 col-md-3">
<div class="home-button"><i class="fa fas fa-desktop"></i>[[System Configuration]]</div>
</div>
<div class="col-sm-4 col-md-3">
<div class="home-button"><i class="fa fas fa-code"></i>[https://developers.whmcs.com/ Developers Configuration]</div>
</div>
</div>

==Popular In This Section==
<div class="row">
<div class="col-sm-4">
[[Configuration|General Settings]]<br />
[[Currencies]]<br />
[[Products and Services|Configuring Products/Services]]<br />
[[Support_Departments|Support Departments]]

</div>
<div class="col-sm-4">
[[Automation Settings]]<br />
[[Payment Gateways]]<br />
[[Domains_Configuration#Registrar_Configuration|Domain Registrars]]<br />
[[Email Piping]]

</div>
<div class="col-sm-4">
[[Administrators and Permissions]]<br />
[[Invoicing Setup]]<br />
[[Servers]]<br />
[[Security/Ban Control|IP/Email Ban Control]]

</div>
</div>

<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small><b>Configuration Service:</b> Have our team configure WHMCS for you.</small></em><span class="button">Services</span></a></html>

==Setup/Configuration List==
</noinclude>
===General===

{{:General Configuration}}

===Payments===

{{:Payment Configuration}}

===Products/Services===

{{:Products/Services_Configuration}}

===Support===

{{:Support_Configuration}}

===System===

{{:System_Configuration}}

__NOTOC__

Configuring Notifications with Slack

2022-12-14T13:09:21Z

AlexN: /* Creating an App for Slack */

Configuring Notifications with Slack allows you to receive notifications in your Slack channels when events occur within WHMCS.

==Configuring Slack Notifications==

To enable WHMCS to communicate with the Slack API, WHMCS requires an OAuth Access Token.

You can create an OAuth Access Token quickly and easily by following the steps below.

===Creating an App for Slack===

To create a Slack app:

1. Log in to your Slack Workspace.

2. Go to https://api.slack.com/.

3. Click '''Create an app'''. You will need to log in if you haven't already.

4. Select '''From scratch'''.

5. Enter a name for the app. We recommend something like ''WHMCS''. Choose the workspace you wish to add the app to and click '''Continue'''.

6. Under the '''Add features and functionality''' heading, select the '''Permissions''' option.

[[File:Slack_features.png|500px]]

7. Scroll down to '''Scopes: Bot Token Scopes'''.

8. Click '''Add an OAuth Scope''' and assign the following permissions:

* channels:join
* channels:read
* chat:write
* groups:read

[[File:Slack_scopes.png|500px]]

9. Click '''Install App to Workspace'''.

[[File:Slack_install_to_workspace.png|500px]]

10. Confirm authorization for the permissions for the app that you just configured.

11. You will now be presented with the Bot User OAuth Access Token you need for WHMCS integration. Copy this value.

[[File:Slack_oauth.png|500px]]

12. In WHMCS, to go '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Notifications]]''' or, prior to WHMCS 8.0, '''Setup > Notifications'''.

13. Under the Slack notification provider, click '''Configure'''.

14. Enter the Bot User OAuth Access Token you copied in step 10 into the OAuth Access Token input field.

15. Click '''Save Changes'''.

[[File:Whmcs_slack_oauth.png|500px]]

WHMCS will attempt to verify the OAuth Access Token provided and automatically join your App.

* If the verification fails you will receive an error message. Check the Access Token is entered correctly, has all the required scopes and try again.
* If successful, the modal will close and you will now be able to send notifications to Slack.

You are now ready to [[Notifications#Creating_a_Notification_Rule|Create Your First Notification Rule]].

WHMCS will attempt to automatically join your Bot to a Slack channel when one is defined in a Notification Rule.

====Private Channels====

To send notifications in private channels, follow these extra steps:

# Open the Slack app,
# Navigate to your private channel
# Invite the app to the channel with the command:<div class="source-cli">/invite @app_name</div>Replace <tt>app_name</tt> with the name of your app, eg:<br/><br/>[[File:Slack invite app.png]]<br/>
# Send the message
The app will join the private channel, and now be available for selection in WHMCS when [[Notifications#Creating_a_Notification_Rule|creating a notification rule]].

Domain Pricing

2022-12-13T13:32:07Z

AlexN: /* Adding a New TLD */

You can configure the prices you charge to your clients for domain registration and associated addons. You can also configure namespinning, premium domains, spotlight TLDs, and other ways to increase your domain sales.

You can access this feature at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Pricing''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Pricing'''.

For instructions for configuring WHMCS to register, renew, or transfer domains automatically, see [[Domains Configuration]].

<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small><b>Need help with domain configuration?</b> Have our team configure WHMCS for you.</small></em><span class="button">Services</span></a></html>

== Domains/TLDs ==

You can use the list of TLDs to configure all the extensions or TLDs you wish to offer, their features, and pricing.

Using the list of TLDs, you can:

* Add and remove spotlight TLDs.
* Add and remove sales groups.
* Configure TLD pricing.
* Enable and disable DNS management, email forwarding, ID protection, and EPP codes.
* Enable, disable, and set the registrar for auto registration.
* Configure grace and redemption periods.
* Reorganize the list of TLDs.
* Remove TLDs.

=== Spotlight TLDs ===

Use the Spotlight TLDs feature to highlight specific TLDs on the domain results page. The first suggested result for the spotlighted TLD will appear in highlighted boxes directly below the client's check result. Clients will be able to add the TLDs you select to their shopping cart with one click.

[[File:Spotlight TLD.png|thumb|Managing Spotlight TLDs]]

To add a Spotlight TLD, click the lightbulb icon next to the desired TLD in the list. It will appear in the Spotlight TLD section at the top of the page.

Your currently-selected spotlight TLDs appear above the list of TLDs.

* You can select up to eight spotlight TLDs.
* Drag TLDs left and right to change the order in which they appear on the domain results page.
* Click the '''X''' icon next to the TLD in the '''Spotlight TLDs''' section to remove it from the list of spotlight TLDs.

For information on adding logos for Spotlight TLDs that do not already have a PNG logo file in the <tt>/assets/img/tld_logos</tt> folder or applying custom styling, see [[Domain Pricing Matrix]].

=== Adding a New TLD ===

[[File:Tld pricing.png|thumb|Domain Pricing Page]][[File:Domainprice matrix.png|thumb|Domain Pricing Matrix]]

The empty last row in the TLDs table is where you add new TLDs to your list. Remember that you can't configure pricing until after you initially save the TLD.

To add a new TLD:

# Enter the TLD, including the preceeding <tt>.</tt> (for example, <tt>.com</tt> or <tt>.net</tt>).
# Check or uncheck the '''DNS Management''', '''Email Forwarding''', or '''ID Protection''' checkboxes to enable the desired features.
# Check '''EPP Code''' to require an EPP code for transfers.
# If you want to perform automatic registrations on payment, select a registrar from the '''Auto Registration''' menu (see below). If you do not want to use automatic registration, select ''None''.
# Click '''Save Changes'''.

After you add the new TLD, make certain that you update the pricing matrix for the new TLD by clicking '''Pricing'''. For more information, see below.

<div class="docs-alert-info">While WHMCS allows you to enter 1–10 years for transfer pricing, most registrars and TLDs do not support multi-year transfers.
</div>

==== Auto Registration ====

Automatic domain registration automates registration and transfer request submissions to supported registrars. When you enable this, WHMCS will automatically submit the request to the registrar as soon as the client pays you for it. WHMCS never submits domain registrations before you receive payment.

If you disable automatic domain registration, the system will wait to submit the registration until after a client has paid ''and'' an admin user manually reviews the order and accepts it.

=== Sales Groups ===

[[File:Sales group.png|thumb|Managing Sales Groups]]

Sales groups highlight certain TLDs to customers by displaying colourful labels next to the domains on the domain results page. All results for the TLD within a sales group will display the label for the group. You can use this in conjunction with spotlight TLDs, so a domain can be both spotlighted and in a sales group for extra prominence.

To assign a TLD to a sales group, click the arrow next to the TLD and select the desired option: '''HOT''', '''NEW''', or '''SALE'''.

To remove the TLD from the sales group, click the arrow next to the TLD and select '''NONE'''.

=== Configuring TLD Pricing Matrixes ===

You can adjust the prices for each TLD on both a per-year registration length and per-currency basis.

Any changes you make here will only affect new domain name registrations and transfers. The changes you make won't affect existing domain registrations. To update renewal prices for existing customers domains, you need to use the [[Bulk Pricing Updater]].

To modify a TLD's pricing matrix:

# Click '''Pricing''' for the desired TLD.
# Select the desired client group from the '''Pricing Slab for''' menu.
#* The pricing slab feature enables different domain pricing for different client groups on a per-TLD basis.
#* For more information, see [[Client Groups]].
# Check '''Enable''' for each desired year or currency to enable pricing.
# Enter the prices for registrations, transfers, and renewals. You can set a different price for each option.
# Click '''Save Changes'''.

=== Domain Grace and Redemption Grace Periods ===

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

[[File:Domain-grace-periods-config.png|thumb|Domain Grace Settings]]

The '''Grace Period''' and '''Redemption Period''' settings enable fine-grained control over what happens when clients renew domains after the expiration date. There are two tiers that control any extra charges you wish to make, which depend on how late a client renews a domain. You can control pricing on a per-TLD basis.

To configure '''Grace Period''' and '''Redemption Period''' settings:

# Click the gear icon for that TLD.
# Enter the desired duration in days.
# Enter the desired fee.
# Click '''Save Changes'''.

For more information, see [[Domain_Grace_and_Redemption_Grace_Periods|Domain Grace and Redemption Grace Periods]].

=== Reordering TLDs ===

To reorder TLDs, click and hold the up-and-down arrow icon for the desired TLD. Then, drag the row to the desired location.

=== Removing TLDs ===

To remove a TLD from the list, click the red delete icon. Then, click '''OK''' to confirm the deletion.

== Lookup Provider ==

WHMCS supports many domain lookup providers for domain searches in the Client Area's domain checker or shopping cart.

The lookup provider defaults to '''Standard WHOIS'''. Only change this if you want to sell premium domains or use lookup functionality in your specific registrar.

To change your lookup provider:

# Click '''Change'''.
# Click '''Select''' for the desired provider. You can choose from the following options:
#* '''Standard WHOIS''' — This checks domain availability using WHOIS servers directly and is the default domain lookup provider. When using this method, WHMCS can display the status of the domain name with other TLD extensions in addition to the user's chosen TLD.
#* '''WHMCS Namespinning''' — This option generates, ranks, and returns relevant domain name suggestions across a wide range of TLDs to help drive more domain registrations (see below).
#* '''Domain Registrar''' — This allows you to choose a domain registrar to use as the lookup provider. WHMCS will use the chosen domain registrar to provide suggestions using the registrar's suggestion engine or API. <div class="docs-alert-info">You '''must''' first configure the registrar at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.</div>
# Follow the prompts to provide the remaining information. This will include choosing TLDs to check and, depending on your lookup provider selection, may also include settings like geolocation-specific suggestions and adult domain name controls.
# Click '''Save'''.

If your selected lookup provider supports premium domains, you can enable them next (see below). After you enable premium domains, you '''cannot''' configure percentage markups and selling premium domains.

=== Namespinning ===

Namespinning provides intelligent automated suggestions based on the domain or keywords a user enters. It generates, ranks, and returns relevant domain name suggestions across a wide range of TLDs.

If the search's TLD is not supported, it will return <tt>unsupported</tt> and WHMCS will instead check the availability of the domain using the [[WHOIS Servers]].

Namespinning supports the following languages:

* English
* French
* German
* Italian
* Japanese
* Korean
* Portuguese
* Spanish
* Turkish
* Chinese

To disable namespinning, select '''Standard WHOIS''' as the lookup provider.

==Premium Domains==

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

[[File:Premium domain on.png|thumb|Premium Domains Activated]]

Premium Domains are names with short, common, or desirable words. Usually, this is providing a more memorable web address for a premium price. The system fetches the pricing in real-time from the registrar (you must use a registrar that supports this functionality), the Lookup Provider. The system then applies any markup you configure to determine the final price for the customer.

To enable premium domains, set the toggle to '''ON'''.

To configure premium domain settings, click '''Configure'''. Then, set the desired prices and markup percentages and click '''Save'''.

For more information, see [[Premium Domains]].

== Bulk Management ==

[[File:Screenshot 2018-10-06 WHMCS - Domains TLDS.png|thumb|TLD Bulk Management actions]]

The Bulk Management actions allow for quick updates to the registration, transfer, and renewal amounts for the 1 to 10 year cycles for all configured TLDs. It also allows you to mass-configure the grace and redemption periods and amounts to charge for those to all TLDs.

For example, to change the pricing for one-year registrations for all TLDs to $14:

#Enter <tt>14</tt> into the '''1 Year Registration''' box.
#To apply the same change to years 2 to 10 with automatic multiplication of the 1 year amount, check '''Set 2-10 years based on 1 year price''' for registration and renewals..
#Click '''Save Changes'''.

We introduced the Grace Period and Redemption Period bulk actions with support for Grace and Redemption Periods in WHMCS 7.5. You can use these options to quickly enable or update the '''Grace Period''' and '''Redemption Period''' settings for all TLDs at once. This can be helpful when first enabling these features on the configured TLDs. For more information on how to set these items, see [[Domain Grace and Redemption Grace Periods]].

==Domain Addons — ID Protection, DNS Management, and Email Forwarding==

[[File:Domain addons.png|thumb|Domain Addons]]

In WHMCS, these are domain addons. Often, some addons aren't compatible with all the TLDs you offer. In WHMCS, you can enable or disable them on a per TLD basis. You can configure them and specify each addon's available extensions for using the checkboxes on each TLD row.

If you wish to offer one or more of these addons for free with a domain name, leave the price at <tt>0.00</tt>. It will appear as a free option on the domain configuration page of the order form.

Domain Pricing

2022-12-13T13:26:45Z

AlexN: /* Bulk Management */

You can configure the prices you charge to your clients for domain registration and associated addons. You can also configure namespinning, premium domains, spotlight TLDs, and other ways to increase your domain sales.

You can access this feature at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Domain Pricing''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Pricing'''.

For instructions for configuring WHMCS to register, renew, or transfer domains automatically, see [[Domains Configuration]].

<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small><b>Need help with domain configuration?</b> Have our team configure WHMCS for you.</small></em><span class="button">Services</span></a></html>

== Domains/TLDs ==

You can use the list of TLDs to configure all the extensions or TLDs you wish to offer, their features, and pricing.

Using the list of TLDs, you can:

* Add and remove spotlight TLDs.
* Add and remove sales groups.
* Configure TLD pricing.
* Enable and disable DNS management, email forwarding, ID protection, and EPP codes.
* Enable, disable, and set the registrar for auto registration.
* Configure grace and redemption periods.
* Reorganize the list of TLDs.
* Remove TLDs.

=== Spotlight TLDs ===

Use the Spotlight TLDs feature to highlight specific TLDs on the domain results page. The first suggested result for the spotlighted TLD will appear in highlighted boxes directly below the client's check result. Clients will be able to add the TLDs you select to their shopping cart with one click.

[[File:Spotlight TLD.png|thumb|Managing Spotlight TLDs]]

To add a Spotlight TLD, click the lightbulb icon next to the desired TLD in the list. It will appear in the Spotlight TLD section at the top of the page.

Your currently-selected spotlight TLDs appear above the list of TLDs.

* You can select up to eight spotlight TLDs.
* Drag TLDs left and right to change the order in which they appear on the domain results page.
* Click the '''X''' icon next to the TLD in the '''Spotlight TLDs''' section to remove it from the list of spotlight TLDs.

For information on adding logos for Spotlight TLDs that do not already have a PNG logo file in the <tt>/assets/img/tld_logos</tt> folder or applying custom styling, see [[Domain Pricing Matrix]].

=== Adding a New TLD ===

[[File:Tld pricing.png|thumb|Domain Pricing Page]][[File:Domainprice matrix.png|thumb|Domain Pricing Matrix]]

The empty last row in the TLDs table is where you add new TLDs to your list. Remember that you can't configure pricing until after you initially save the TLD.

To add a new TLD:

# Enter the TLD, including the preceeding <tt>.</tt> (for example, <tt>.com</tt> or <tt>.net</tt>).
# Check or uncheck the '''DNS Management''', '''Email Forwarding''', or '''ID Protection''' checkboxes to enable the desired features.
# Check '''EPP Code''' to require an EPP code for transfers.
# If you want to perform automatic registrations on payment, select a registrar from the '''Auto Registration''' menu (see below). If you do not want to use automatic registration, select ''None''.
# Click '''Save Changes'''.

After you add the new TLD, make certain that you update the pricing matrix for the new TLD by clicking '''Pricing'''. For more information, see below.

==== Auto Registration ====

Automatic domain registration automates registration and transfer request submissions to supported registrars. When you enable this, WHMCS will automatically submit the request to the registrar as soon as the client pays you for it. WHMCS never submits domain registrations before you receive payment.

If you disable automatic domain registration, the system will wait to submit the registration until after a client has paid ''and'' an admin user manually reviews the order and accepts it.

=== Sales Groups ===

[[File:Sales group.png|thumb|Managing Sales Groups]]

Sales groups highlight certain TLDs to customers by displaying colourful labels next to the domains on the domain results page. All results for the TLD within a sales group will display the label for the group. You can use this in conjunction with spotlight TLDs, so a domain can be both spotlighted and in a sales group for extra prominence.

To assign a TLD to a sales group, click the arrow next to the TLD and select the desired option: '''HOT''', '''NEW''', or '''SALE'''.

To remove the TLD from the sales group, click the arrow next to the TLD and select '''NONE'''.

=== Configuring TLD Pricing Matrixes ===

You can adjust the prices for each TLD on both a per-year registration length and per-currency basis.

Any changes you make here will only affect new domain name registrations and transfers. The changes you make won't affect existing domain registrations. To update renewal prices for existing customers domains, you need to use the [[Bulk Pricing Updater]].

To modify a TLD's pricing matrix:

# Click '''Pricing''' for the desired TLD.
# Select the desired client group from the '''Pricing Slab for''' menu.
#* The pricing slab feature enables different domain pricing for different client groups on a per-TLD basis.
#* For more information, see [[Client Groups]].
# Check '''Enable''' for each desired year or currency to enable pricing.
# Enter the prices for registrations, transfers, and renewals. You can set a different price for each option.
# Click '''Save Changes'''.

=== Domain Grace and Redemption Grace Periods ===

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

[[File:Domain-grace-periods-config.png|thumb|Domain Grace Settings]]

The '''Grace Period''' and '''Redemption Period''' settings enable fine-grained control over what happens when clients renew domains after the expiration date. There are two tiers that control any extra charges you wish to make, which depend on how late a client renews a domain. You can control pricing on a per-TLD basis.

To configure '''Grace Period''' and '''Redemption Period''' settings:

# Click the gear icon for that TLD.
# Enter the desired duration in days.
# Enter the desired fee.
# Click '''Save Changes'''.

For more information, see [[Domain_Grace_and_Redemption_Grace_Periods|Domain Grace and Redemption Grace Periods]].

=== Reordering TLDs ===

To reorder TLDs, click and hold the up-and-down arrow icon for the desired TLD. Then, drag the row to the desired location.

=== Removing TLDs ===

To remove a TLD from the list, click the red delete icon. Then, click '''OK''' to confirm the deletion.

== Lookup Provider ==

WHMCS supports many domain lookup providers for domain searches in the Client Area's domain checker or shopping cart.

The lookup provider defaults to '''Standard WHOIS'''. Only change this if you want to sell premium domains or use lookup functionality in your specific registrar.

To change your lookup provider:

# Click '''Change'''.
# Click '''Select''' for the desired provider. You can choose from the following options:
#* '''Standard WHOIS''' — This checks domain availability using WHOIS servers directly and is the default domain lookup provider. When using this method, WHMCS can display the status of the domain name with other TLD extensions in addition to the user's chosen TLD.
#* '''WHMCS Namespinning''' — This option generates, ranks, and returns relevant domain name suggestions across a wide range of TLDs to help drive more domain registrations (see below).
#* '''Domain Registrar''' — This allows you to choose a domain registrar to use as the lookup provider. WHMCS will use the chosen domain registrar to provide suggestions using the registrar's suggestion engine or API. <div class="docs-alert-info">You '''must''' first configure the registrar at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.</div>
# Follow the prompts to provide the remaining information. This will include choosing TLDs to check and, depending on your lookup provider selection, may also include settings like geolocation-specific suggestions and adult domain name controls.
# Click '''Save'''.

If your selected lookup provider supports premium domains, you can enable them next (see below). After you enable premium domains, you '''cannot''' configure percentage markups and selling premium domains.

=== Namespinning ===

Namespinning provides intelligent automated suggestions based on the domain or keywords a user enters. It generates, ranks, and returns relevant domain name suggestions across a wide range of TLDs.

If the search's TLD is not supported, it will return <tt>unsupported</tt> and WHMCS will instead check the availability of the domain using the [[WHOIS Servers]].

Namespinning supports the following languages:

* English
* French
* German
* Italian
* Japanese
* Korean
* Portuguese
* Spanish
* Turkish
* Chinese

To disable namespinning, select '''Standard WHOIS''' as the lookup provider.

==Premium Domains==

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

[[File:Premium domain on.png|thumb|Premium Domains Activated]]

Premium Domains are names with short, common, or desirable words. Usually, this is providing a more memorable web address for a premium price. The system fetches the pricing in real-time from the registrar (you must use a registrar that supports this functionality), the Lookup Provider. The system then applies any markup you configure to determine the final price for the customer.

To enable premium domains, set the toggle to '''ON'''.

To configure premium domain settings, click '''Configure'''. Then, set the desired prices and markup percentages and click '''Save'''.

For more information, see [[Premium Domains]].

== Bulk Management ==

[[File:Screenshot 2018-10-06 WHMCS - Domains TLDS.png|thumb|TLD Bulk Management actions]]

The Bulk Management actions allow for quick updates to the registration, transfer, and renewal amounts for the 1 to 10 year cycles for all configured TLDs. It also allows you to mass-configure the grace and redemption periods and amounts to charge for those to all TLDs.

For example, to change the pricing for one-year registrations for all TLDs to $14:

#Enter <tt>14</tt> into the '''1 Year Registration''' box.
#To apply the same change to years 2 to 10 with automatic multiplication of the 1 year amount, check '''Set 2-10 years based on 1 year price''' for registration and renewals..
#Click '''Save Changes'''.

We introduced the Grace Period and Redemption Period bulk actions with support for Grace and Redemption Periods in WHMCS 7.5. You can use these options to quickly enable or update the '''Grace Period''' and '''Redemption Period''' settings for all TLDs at once. This can be helpful when first enabling these features on the configured TLDs. For more information on how to set these items, see [[Domain Grace and Redemption Grace Periods]].

==Domain Addons — ID Protection, DNS Management, and Email Forwarding==

[[File:Domain addons.png|thumb|Domain Addons]]

In WHMCS, these are domain addons. Often, some addons aren't compatible with all the TLDs you offer. In WHMCS, you can enable or disable them on a per TLD basis. You can configure them and specify each addon's available extensions for using the checkboxes on each TLD row.

If you wish to offer one or more of these addons for free with a domain name, leave the price at <tt>0.00</tt>. It will appear as a free option on the domain configuration page of the order form.

OpenSRS

2022-10-18T13:52:35Z

AlexN: /* Additional Registrar Module Files Requirement */

== About this Module ==

The OpenSRS module allows you to register and manage domains with OpenSRS.
{{registrar
| register = yes
| transfer = yes
| renew = yes
| lock = yes
| dns = yes
| whois = yes
| regns = yes
| getepp = yes
| domainsync = yes
}}
== Activation ==

To activate and begin using the OpenSRS registrar module:

# Check to ensure that your server includes all required third-party classes (for example, PEAR). If it does not, see [[#Additional_Registrar_Module_Files_Requirement|the section below]].
# Log in to the WHMCS Admin Area.
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
# Find '''OpenSRS''' in the list.
# Click '''Activate'''.
# Enter your OpenSRS credentials. You can generate your '''PrivateKey''' value at '''Generate New Private Key''' in the OpenSRS Reseller Web Interface.
# Click '''Save Changes'''.
# In the OpenSRS Reseller Web Interface, go to '''Add IPs for Script/API Access''' and configure access for your server's IP address. You can find this address in WHMCS at '''Help > [[License Information]]'''.
# Configure and fund your OpenSRS reseller account. For more information, see [http://opensrs.com/resources OpenSRS's documentation].

=== Test Mode ===

You can use test mode to simulate domain registration and management function without registering a domain or incurring charges. This can be useful to test WHMCS configurations.

=== Additional Registrar Module Files Requirement ===

If your server does not include all of the required third-party classes, you must [https://www.whmcs.com/members/dl.php?type=d&id=29 download the necessary files] and upload them to the <tt>/modules/registrars/opensrs/</tt> directory.

== Automatic Registration ==

WHMCS allows you to set up automatic domain registration on a per-extension basis, enabling you to use different registrars for different TLDs.

To enable automatic registration, see [[Domain Pricing]].

== Automatic Domain Synchronization ==

This module supports automatic domain synchronization for syncing expiry dates and status changes for incoming transfers.

To use this, enable '''Domain Sync Enabled''' in the '''[[Domains_Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. You must also make certain to configure the '''[[Crons#Domain_Sync_Cron|Domain Sync Cron]]'''.

== Troubleshooting ==

=== Blank Response or Connection Error Message ===

This usually indicates that the OpenSRS API port numbers (<tt>55443</tt> and <tt>55000</tt>) are blocked by your server's firewall and you must open them for outbound connections.

=== Partially Loaded Page (Blank or Lost Formatting) ===

The OpenSRS module requires additional files.

[http://www.whmcs.com/members/dl.php?type=d&id=29 Download these files] and then upload them to the <tt>/modules/registrars/opensrs/</tt> folder.<br>
For more information, see [[OpenSRS#Activation|OpenSRS Activation]].

=== Domain Already Renewed ===

This indicates that the '''Expiry Date''' value in the client's '''[[Clients:Domains Tab|Domains]]''' tab is invalid or incorrect. Correcting this value allows domain renewal.

=== Order xxxxxxx is not a pending, declined or cancelled order and cannot be processed ===

The system still registers the domain name when this error occurs. To stop the error, set '''Process Immediately''' to '''Off''' in your OpenSRS account.

{{modules}}

Stargate

2022-09-20T09:58:05Z

AlexN: /* About this Module */

== About this Module ==

<div class="docs-alert-info">
This domain registrar module is also the Resell.biz and UK2 modules.
</div>

The Stargate/UK2 module allows you to register and manage domains with UK2.
{{registrar
| register = yes
| transfer = yes
| renew = yes
| lock = yes
| dns = yes
| whois = yes
| getepp = yes
| regns = yes
| dnsmanagement = yes
| emailforwarding = yes
| domainrelease = yes
| domainsync = yes
| premium = yes
| tldpricingsync = yes
}}

== Activation ==

To activate and begin using the Stargate registrar module:

# Log in to the WHMCS Admin Area.
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
# Find '''Stargate/UK2''' in the list.
# Click '''Activate'''.
# Enter your Stargate credentials.
# Click '''Save Changes'''.
# [https://www.resell.biz/ Open a resell.biz ticket] to request API access to your Stargate account for your server's IP address.
#* You can find this IP address in WHMCS at '''Help > [[License Information]]'''.
#* If you do not perform this step, you will see an ''Access Denied'' error.

=== Test Mode ===

You can use test mode to simulate domain registration and management function without registering a domain or incurring charges. This can be useful to test WHMCS configurations.

== Automatic Registration ==

WHMCS allows you to set up automatic domain registration on a per-extension basis, enabling you to use different registrars for different TLDs.

To enable automatic registration, see [[Domain Pricing]].

== Automatic Domain Synchronization ==

This module supports automatic domain synchronization for syncing expiry dates and status changes for incoming transfers.

To use this, enable '''Domain Sync Enabled''' in the '''[[Domains_Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. You must also make certain to configure the '''[[Crons#Domain_Sync_Cron|Domain Sync Cron]]'''.

== Troubleshooting ==

Because Stargate uses the LogicBoxes platform, see the [[ResellerClub]] documentation for configuration and troubleshooting information.

{{modules}}

ResellerCamp

2022-09-20T09:57:47Z

AlexN: /* About this Module */

== About this Module ==

The ResellerCamp module allows you to register and manage domains with ResellerCamp.
{{registrar
| register = yes
| transfer = yes
| renew = yes
| lock = yes
| dns = yes
| whois = yes
| getepp = yes
| regns = yes
| dnsmanagement = yes
| emailforwarding = yes
| domainrelease = yes
| domainsync = yes
| premium = yes
| tldpricingsync = yes
}}

==Activation==

To activate and use the ResellerCamp registrar module:

# Log in to the WHMCS Admin Area.
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
# Find '''ResellerCamp''' in the list.
# Click '''Activate'''.
# Enter your ResellerCamp credentials.
# Click '''Save Changes'''.
# [https://resellercamp.com/ Open a ticket] with ResellerCamp, requesting them to allow your IP address access to your ResellerCamp account via the API. To find the IP address to whitelist, go to '''Help > [[License Information]]''' in the WHMCS Admin Area.<div class="docs-alert-info">Failure to do this will result in you seeing the following message: '''Access Denied: You are not authorized to perform this action'''</div>

=== Test Mode ===

You can use test mode to simulate domain registration and management function without registering a domain or incurring charges. This can be useful to test WHMCS configurations.

== Automatic Registration ==

WHMCS allows you to set up automatic domain registration on a per-extension basis, enabling you to use different registrars for different TLDs.

To enable automatic registration, see [[Domain Pricing]].

== Automatic Domain Synchronization ==

This module supports automatic domain synchronization for syncing expiry dates and status changes for incoming transfers.

To use this, enable '''Domain Sync Enabled''' in the '''[[Domains_Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. You must also make certain to configure the '''[[Crons#Domain_Sync_Cron|Domain Sync Cron]]'''.

==Troubleshooting==

ResellerCamp uses the LogicBoxes platform. For more information, see [[ResellerClub]].

{{modules}}

NetEarthOne

2022-09-20T09:57:30Z

AlexN: /* About this Module */

== About this Module ==

The NetEarthOne module allows you to register and manage domains with NetEarthOne.
{{registrar
| register = yes
| transfer = yes
| renew = yes
| lock = yes
| dns = yes
| whois = yes
| getepp = yes
| regns = yes
| dnsmanagement = yes
| emailforwarding = yes
| domainrelease = yes
| domainsync = yes
| premium = yes
| tldpricingsync = yes
}}

== Activation ==

To activate and begin using the NetEarthOne registrar module, follow the steps below:

# Log in to the WHMCS Admin Area.
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
# Find '''NetEarthOne''' in the list.
# Click '''Activate'''.
# Enter your NetEarthOne credentials.
# Click '''Save Changes'''.
# [https://www.netearthone.com/ Open a NetEarthOne ticket] and request API access to your NetEarthOne account for your server's IP address.
#* You can find this IP address in the WHMCS Admin Area at '''Help > [[License Information]]'''.
#* If you don't do this, you will see an ''Access Denied'' message.

=== Test Mode ===

You can use test mode to simulate domain registration and management function without registering a domain or incurring charges. This can be useful to test WHMCS configurations.

== Automatic Registration ==

WHMCS allows you to set up automatic domain registration on a per-extension basis, enabling you to use different registrars for different TLDs.

To enable automatic registration, see [[Domain Pricing]].

== Automatic Domain Synchronization ==

This module supports automatic domain synchronization for syncing expiry dates and status changes for incoming transfers.

To use this, enable '''Domain Sync Enabled''' in the '''[[Domains_Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. You must also make certain to configure the '''[[Crons#Domain_Sync_Cron|Domain Sync Cron]]'''.

== Troubleshooting ==

Because NetEarthOne uses the LogicBoxes platform, see the [[ResellerClub]] documentation for configuration and troubleshooting information.

{{modules}}

ResellerClub

2022-09-20T09:56:40Z

AlexN: /* About this Module */

== About this Module ==

The ResellerClub module allows you to register and manage domains with ResellerClub.

For more information, see [[ResellerClub Reseller Accounts FAQ]].
{{registrar
| register = yes
| transfer = yes
| renew = yes
| lock = yes
| dns = yes
| whois = yes
| getepp = yes
| regns = yes
| dnsmanagement = yes
| emailforwarding = yes
| domainrelease = yes
| domainsync = yes
| premium = yes
| transferout = yes
| tldpricingsync = yes
}}

== Activation ==

<div class="docs-alert-success">
You must sign up for a [https://freeaccount.partnersite.myorderbox.com/reseller.php?action=show_signupform ResellerClub account].
</div>

To activate and begin using the ResellerClub registrar module:

# Log in to the WHMCS Admin Area.
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
# Find '''ResellerClub''' in the list.
# Click '''Activate'''.
# Enter your Resellerclub API credentials and configure the module's settings. [[File:Rcprofile.png|thumb|User Profile Menu]]
#* You can find your ResellerClub API credentials in the ResellerClub control panel:
#** Your reseller ID appears at '''User Profile > Manage Profile'''.
#** Your API key appears at '''Settings > API'''.
#* Enable '''Designated Agent''' to act as the designated agent for all contact changes. For more information, [https://freeaccount.myorderbox.com/kb/node/5 see the ResellerClub documentation].
# Click '''Save Changes'''.
# Grant API access to your ResellerClub account to your server's IP address. You can do this by going to '''Settings > API''' in the LogicBoxes/ResellerClub control panel and entering your IP address.
#* You can find the IP address to use in WHMCS at '''Help > [[License Information]]'''.
#* If you do not do this, you will see a <tt>You must authorize your IP address to use this API.</tt> error in WHMCS 8.4 and later or an <tt>Access Denied</tt> error in WHMCS 8.3 and earlier.

=== Test Mode ===

<div class="docs-alert-warning">
ResellerClub requires the use of a '''Demo Account Reseller ID''' and '''API Key''' with the '''Test URL''' instead of your '''Live Account''' credentials. Use of your '''Live Account''' credentials, even with the '''Test URL''', will cause you to [http://freeaccount.myorderbox.com/kb/answer/753#heading_6 perform actions in the live environment].
</div>

You can use test mode to simulate domain registration and management function without registering a domain or incurring charges. This can be useful to test WHMCS configurations.

==== Nameservers ====

Live nameservers will return a <tt>Nameserver is not a valid Nameserver</tt> error unless you create and register them in the demo environment before attempting domain registrations on the demo platform. The demo control panel will try to check the validity of the nameservers in the demo platform and not on the registry.

You can use <tt><nowiki>ns1.onlyfordemo.net</nowiki></tt> and <tt><nowiki>ns2.onlyfordemo.net</nowiki></tt> as your nameservers without registering them on the demo environment.

=== IDN Configuration ===

<div class="docs-alert-info">
The following information is for WHMCS 7.10 and earlier.
</div>

To register internationalized domain names (IDNs) through ResellerClub, you must add an additional domain field to WHMCS via the <tt>resources/domains/additionalfields.php</tt> file.

The language options differ for each TLD. You can find the appropriate values in the <tt>idnLanguageCode</tt> section in the [http://manage.uk.resellerclub.com/kb/answer/752#heading_1 ResellerClub API Documentation].

For example, to register a <tt>.eu</tt> domain, add the following line to the <tt>/resources/domains/additionalfields.php</tt> file:

<source lang="php">
<?php
$additionaldomainfields[".eu"][] = array(
"Name" => "IDN Language",
"DisplayName" => "IDN Language",
"LangVar" => "idnlang",
"Type" => "dropdown",
"Options" => "latin",
"Default" => "latin",
"Required" => "true",
);
</source>

For <tt>.org</tt> domains, add the following line to the <tt>/resources/domains/additionalfields.php</tt> file:

<source lang="php">
$additionaldomainfields[".org"][] = array(
"Name" => "IDN Language",
"DisplayName" => "IDN Language",
"LangVar" => "idnlang",
"Type" => "dropdown",
"Options" => "da,de,hu,is,ko,lv,lt,pl,es,sv",
"Default" => "da",
"Required" => "true",
);
</source>

For more information, see [[Additional Domain Fields]].

=== Domain Contacts ===

Prior to WHMCS 6, domain registration through LogicBoxes modules (ResellerClub, NetEarthOne, and Stargate) always used the client's profile data regardless of whether '''User Client Details''' was disabled.

If a client has multiple registered domains, they will use the same contact details for all four Whois contacts. Changing the Whois details on one domain will also change the details for the others.

In WHMCS 6 and later, domain registration creates a unique contact for each domain. This contact becomes the Registrant, Billing, Tech, and Admin contact for the domain's Whois records. Modifying the Whois details for the domain will change only that domain.

== Automatic Registration ==

WHMCS allows you to set up automatic domain registration on a per-extension basis, enabling you to use different registrars for different TLDs.

To enable automatic registration, see [[Domain Pricing]].

== Automatic Domain Synchronization ==

This module supports automatic domain synchronization for syncing expiry dates and status changes for incoming transfers.

To use this, enable '''Domain Sync Enabled''' in the '''[[Domains_Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. You must also make certain to configure the '''[[Crons#Domain_Sync_Cron|Domain Sync Cron]]'''.

==Troubleshooting==

==== Connection Problems ====

The following errors occur when the ResellerClub server is unreachable. They may be experiencing problems or a local firewall may block the connection:

* [http://www.myorderbox.com/anacreon/servlet/APIv3 HTTP Error: Couldn't open socket connection to server].
* Domain Registration Error - Unable to connect to Registry.

==== Access Problems ====

The following errors indicate problems accessing ResellerClub:

* Access Denied: You are not authorized to perform this action.
* CURL Error: 7 - couldn't connect to host.

Usually, this indicates that you haven't allowed your server's IP address to access your ResellerClub account via the API. Do this in the '''Settings > API''' section of the LogicBoxes control panel.

The IP address you need to authorize is typically the main shared IP address of the server, which is usually the IP address your WHMCS license is assigned to. If you experience problems, contact ResellerClub.

==== Invalid Password/Username, or your User account maybe Inactive or Suspended ====

This error response indicates that the login details in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Domain Registrars''', for the Resellerclub module are incorrect or your account is suspended.

==== Website Doesn't Exist For xxx ====

This error indicates that the domain does not exist in your ResellerClub account while a domain transfer is in progress. It automatically disappears when the transfer is complete.

==== Telephone No. is invalid. Please note that only digits are allowed ====

This error displays when you include a country code in a phone number. Only enter the phone number as it would be called from that country.

==== Language code not valid for this TLD ====

This error occurs when attempting to register an IDN without specifying a valid language for the domain. For more information, see [[#IDN_Configuration|IDN Configuration]].

If you have already configured a IDN Language additional domain field, this error indicates that the selected language is not valid for the TLD. For more information, see the <tt>idnLanguageCode</tt> section in the [http://manage.uk.resellerclub.com/kb/answer/752#heading_1 ResellerClub API Documentation].

==== An unknown fault occurred - please contact support ====

This error occurs when the client's profile data contains characters other than a-z and 0-9. The ResellerClub API won't accept any accents or other non-Latin characters.

You can customize WHMCS to automatically convert non-Latin characters. For more information, see [[Custom Transliteration]].

==== An unexpected error has occurred ====

This error usually indicates that the login details are missing or incorrect. Make sure that you have correctly entered your reseller ID and API key at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.

==== Required parameter missing: name ====

This error indicates that ResellerClub is not receiving the client's details. Make sure to enter the appropriate information in the following locations:

* Enter the client's details in the '''Profile''' and '''Contacts''' tabs.
* Enter your company details in the '''[[Domains Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.

Also make certain to check '''Use Clients Details''' in the '''[[Domains Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.

==== There is already a pending action on this domain ====

This message indicates that a Whois contact details update is pending on this domain. Once the new contact details are confirmed by the new and old contact, this message will disappear within one day.

For more information, see [http://blog.whmcs.com/?t=121202 in our blog].

{{modules}}

Enom

2022-09-20T09:55:59Z

AlexN: /* About this Module */

== About this Module ==

The Enom module allows you to register and manage domains with Enom.
{{registrar
| register = yes
| transfer = yes
| renew = yes
| lock = yes
| dns = yes
| whois = yes
| getepp = yes
| regns = yes
| dnsmanagement = yes
| emailforwarding = yes
| domainsync = yes
| premium = yes
| transferout = yes
| tldpricingsync = yes
}}

==Activation==

<div class="docs-alert-success">
You must create an [https://www.whmcs.com/partners/enom/ Enom account].
</div>

To activate and begin using the Enom registrar module:

# Log in to your account on the [https://www.enom.com/apitokens/default.aspx Enom website].
# Enter an identifying name in the textbox (for example, <tt>WHMCS</tt>).
# Click '''Generate New API Token'''.
# Copy the generated API token.
# Log in to the WHMCS Admin Area.
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
# Find '''Enom''' in the list.
# Click '''Activate'''.
# Enter your Enom username.
# Paste in the API token.
# Check '''Disable IRTP''' to prevent WHMCS from displaying contact information verification notices.
# Check '''Use Default Nameservers''' to use Enom's default nameservers for new registrations, overriding the nameservers in WHMCS.
# Click '''Save Changes'''.
# In your Enom account, go to '''Resellers > Manage > API''' and add your server's IP address.
#* You can find this address in WHMCS at '''Help > [[License Information]]'''.
#* If you do not do this, you will see a '''Registrar Error Invalid Client IP''' error.

<html><a href="http://www.youtube.com/watch?v=0Sz9mkBzLN0&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>
<div class="docs-alert-warning">Before you can begin using the Enom API with your account. you must authorize your server IP address for access to your account. See below for steps to do this.</div>

=== Test Mode ===

You can use test mode to simulate domain registration and management function without registering a domain or incurring charges. This can be useful to test WHMCS configurations.

Before you enable '''Test Mode''' in WHMCS, you must register on Enom's Reseller Test environment:

# Log in to [https://resellertest.enom.com/resellers/reseller-testaccount.aspx Enom's Reseller Test Account].
# Click all three links under '''Test Interface Options''' to configure the test account.
# [https://resellertest.enom.com/apitokens/default.aspx Generate a test API token.]

When you place domain registration orders in WHMCS with test mode active, the domains will appear on your demo Enom account (<tt>http://resellertest.enom.com</tt>) but no domain will actually be registered and you will not be charged.

=== .ca Registrations ===

<tt>.ca</tt> registrations require additional fields. The <tt>Invalid registrant information</tt> error is due to problems with the location field.

Instead of entering the full place name, use one of the following province abbreviations:

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

== Transfer Pricing ==

Enom does not allow a domain's registration term to be defined when transferring a domain name.

When configuring pricing for TLDs to transfer using Enom, only configure a one year transfer price. Set all other transfer prices to <tt>-1.00</tt>.

== Automatic Registration ==

WHMCS allows you to set up automatic domain registration on a per-extension basis, enabling you to use different registrars for different TLDs.

To enable automatic registration, see [[Domain Pricing]].

== Automatic Domain Synchronization ==

This module supports automatic domain synchronization for syncing expiry dates and status changes for incoming transfers.

To use this, enable '''Domain Sync Enabled''' in the '''[[Domains_Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. You must also make certain to configure the '''[[Crons#Domain_Sync_Cron|Domain Sync Cron]]'''.

== Troubleshooting ==

=== 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]]. This must be done via the Enom website 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; e.g. 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. Make certain that your server is able to make cURL calls to the following URLs:

Demo Mode: <tt>resellertest.enom.com</tt>
Live Mode: <tt>reseller.enom.com</tt>

=== Domain name not found ===

This error occurs when the domain does not exist in your Enom account. This message will be displayed when a domain transfer is in progress but will automatically disappear when the transfer is complete.

{{modules}}

Stripe

2022-09-14T13:18:51Z

AlexN: /* Troubleshooting */

== About this Module ==

The WHMCS Stripe payment gateway uses Stripe's tokenised storage system to submit credit card information to Stripe, which stores it remotely.

For other Stripe options, see [[Stripe ACH]] and [[Stripe SEPA]].
{{gateways
| type = token
| recurring = yes
| onetime = yes
| refunds = yes
| updatecc = yes
| deletecc = yes
| 3dsecure = yes
}}
<div class="docs-alert-warning">
The Stripe payment gateway module is not compatible with the Modern or Boxes order form templates.
</div>
== Adding the Stripe Payment Gateway ==

[[File:stripe.png|thumb|Stripe Module Settings]]

To set up the Stripe payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.6 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 8.0 to 8.6, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > Payment Gateways''' and choose '''All Payment Gateways'''.
# Click '''Stripe'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Configure a display name. We recommend <tt>Credit Card</tt>.
# Go to the [https://dashboard.stripe.com/account/apikeys Stripe portal] and retrieve the publishable and secret API keys.
# Enter your Stripe credentials.
# Optionally, customize the '''Statement Descriptor Suffix''' with a maximum of 22 characters.
# In WHMCS 8.0 and later, leave the '''Stripe WebHook Endpoint Secret''' and '''Stripe WebHook Endpoint Secret (Test/Sandbox)''' empty. WHMCS auto-generates these. See below for more information.
# Optionally, check '''Allow Payment Request Buttons'''. See below for more information.
# Click '''Save Changes'''.
# If you use different default currencies in Stripe and WHMCS, make certain that you have also configured your Stripe account's currency with a valid exchange rate at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Currencies'''. Stripe only returns transaction fees in the default currency for the Stripe account.

=== WebHook Endpoints ===

<div class="docs-alert-info">
You can use Stripe Webhooks in WHMCS v8.0 and above.
</div>

Stripe's WebHook Endpoints update WHMCS automatically with changes to your customers' cards. In WHMCS 8.0 and later, when you click '''Save Changes''', WHMCS will use the '''Stripe Publishable API Key''' and '''Stripe Secret API Key''' to generate the '''Stripe WebHook Endpoint Secret''' and '''Stripe WebHook Endpoint Secret (Test/Sandbox)'''.

* If you enter live API keys (<tt>sk_live</tt>), WHMCS will generate the '''Stripe WebHook Endpoint Secret'''.
* If you enter test API keys (<tt>sk_test</tt>), WHMCS will generate the '''Stripe WebHook Endpoint Secret (Test/Sandbox)'''.

WHMCS registers the WebHook Endpoints to deliver these events from Stripe:

* <tt>customer.source.updated</tt>
* <tt>customer.card.updated</tt>
* <tt>payment_method.updated</tt>

To change the WebHook ID, empty '''Stripe WebHook Endpoint Secret''' and '''Stripe WebHook Endpoint Secret (Test/Sandbox)''' and click '''Save Changes'''. WHMCS will auto-generate them again with new values.

=== Payment Request Button ===

Enabling this option within the module configuration provides customers with a platform-specific payment request button (for example, Apple® Pay). For customers who don’t use Apple Pay, '''Payment Request''' supports credit cards stored in the browser, Google® Pay, and Microsoft® Pay.

==== Apple Pay ====

[[File:apple_pay_checkout.png|thumb|The Apple Pay Button on Checkout]]

When you enable this, Apple Pay allows access to payment details that users have stored in their Apple Wallet. If they're using Safari® on their iPhone® or iPad®, when they tap "Buy with Apple Pay" on your site, they'll be shown a modal payment sheet. If they're using Safari on their Mac®, and have an iOS® device in range, they'll be prompted on their device to authorize the payment, which will then be sent to the browser.

To use Apple Pay with a live Stripe API key, you must register all of the domains that will display an Apple Pay button with Apple. This includes both top-level domains (for example, <tt><nowiki>whmcs.com</nowiki></tt>) and subdomains (for example, <tt><nowiki>shop.whmcs.com</nowiki></tt>).
<div class="docs-alert-info"><i class="fa fa-info-circle"></i> An SSL certificate is '''required''' to use Apple Pay.</div>

To do this:

# Download this [https://stripe.com/files/apple-pay/apple-developer-merchantid-domain-association domain association file] and host it at <tt>/.well-known/apple-developer-merchantid-domain-association</tt> on your site. For example, if you're registering <tt><nowiki>https://example.com</nowiki></tt>, make that file available at <tt><nowiki>https://example.com/.well-known/apple-developer-merchantid-domain-association</nowiki></tt>.
# To instruct Stripe to register the domain with Apple, go to the '''[https://dashboard.stripe.com/account/apple_pay Apple Pay]''' tab in '''Account Settings''' in the Stripe Dashboard.

==== Google Pay ====

Google Pay allows customers to make payments using any credit or debit card on their Google account, including Google Play, YouTube™, Chrome™, or an Android™ device.

==== Microsoft Pay ====

Microsoft Pay allows customers to make payments using any credit or debit card on their Microsoft account.

=== Test Mode ===

This module does not support test mode.

== Payment Workflow ==

[[File:stripe_checkout.png|thumb|The Stripe module on Checkout]]

The Stripe payment workflow supports automated recurring and on-demand billing.

Customers can choose between previously-stored cards or entering new ones during payment, and they can update their credit cards at any time in the Client Area. Admins can also update credit card information in the WHMCS Admin Area.

During checkout, clients never leave WHMCS. Personal card information goes directly to Stripe and is never stored within WHMCS. The Stripe API handles all refunds and obtains transaction information.

In WHMCS 7.8 and later, WHMCS uses the Stripe Elements implementation method. When performing checkout, if customer authorisation is required, the system will prompt the user automatically to approve the payment. This process is also commonly referred to as 3D Secure. Use of 3D Secure depends on the card type and issuer.

<div class="docs-alert-info">
WHMCS 8.3 and higher includes support for disputes for Stripe and PayPal® transactions at '''Billing > [[Disputes]]'''.
</div>

===Recurring Payments===

Automated recurring payments use stored tokens. If a client card requires SCA, the system will deny the payment attempt and the client must log in to WHMCS manually to process the payment.

== Payment Gateway Balances ==

In WHMCS 8.2 and later, you can view payment gateway balances directly within the WHMCS Admin Area, with native support for Stripe balances.

At '''Billing > [[Transactions]]''', you can view balances in the transaction list and in the transaction details for individual transactions. For more information, see [[Payment Gateway Balances and Transactions]].

This requires you to enable '''View Gateway Balances''' for the desired administrator role at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Administrator Roles]]'''.

<div class="docs-alert-warning">
In the Admin Area [[Admin_Dashboard|Dashboard]], you can view your Stripe balances through the '''Stripe Balance''' widget. However, this widget does not use the <tt>WHMCS\Module\Gateway\Balance</tt> and <tt>WHMCS\Module\Gateway\BalanceCollection</tt> classes to display balances. For more information, see [[Stripe Balance Widget]].
</div>

== Migrating to Stripe ==

The Stripe payment gateway module supports migrating locally-stored credit card details to Stripe's tokenized storage. This is useful when you transition from another non-tokenized merchant gateway provider to Stripe.

For an existing client with a locally-stored credit card, the first time that the system attempts to capture payment for an invoice using Stripe, the system will submit the credit card details to Stripe and create and store a token. Then, the system will remove the local copy of the card details.

To migrate to Stripe and ensure all future credit card processing uses it:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.6 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 8.0 to 8.6, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > Payment Gateways''' and choose '''All Payment Gateways'''.
# Activate the Stripe module.
# Click '''Deactivate''' for your previous merchant gateway provider.
# Select Stripe as the replacement gateway to switch users of the previous gateway module to.
# Click '''OK'''.

=== Migrating from a 3rd Party Stripe Module ===

The WHMCS Stripe module uses the Stripe <tt>cus_</tt> reference to capture payments (for example, <tt>cus_9MvIb7UlgJfJTn</tt>). The WHMCS Stripe module can replace any third-party module that uses this.

To check whether your current Stripe module uses the <tt>cus_</tt> reference, navigate to a client that you know has an active Stripe token and click on one of the pay methods in the '''Summary''' tab of the client's profile. Verify that the listed token includes the <tt>cus_</tt> prefix.

To start using the WHMCS Stripe module:

# Note the internal name of the previous Stripe module, which you can find by looking in the gateway column in the <tt>tblpaymentgateways</tt> database table.
# Activate our official Stripe module.
# Deactivate the previous Stripe module.
# Check one of the Stripe pay methods on a client. If the token contains <tt>cus{_}</tt>, you can use it with our module but it will require a manual database edit first. To allow that, run the following SQL query using phpMyAdmin or another tool, replacing "example" with the name of the previous module: <source lang="sql">UPDATE tblpaymethods SET gateway_name = 'stripe' WHERE gateway_name = 'example'; </source>
# Remove any third-party files and template customisations for the previous Stripe module.

==Troubleshooting==

===Remote Transaction Failure. Please Contact Support===

This issue has multiple causes. This may also display as '''Error'''.

# Begin by going to '''Billing > Gateway Log'''.
# Look at the Result and Debug Data columns.
# At the time of the payment attempt this should display an error message or code. Refer to the Stripe documentation for more information:
* https://stripe.com/docs/error-codes
* https://stripe.com/docs/declines/codes

Other common causes of this error are explained below.

====Payment Blocked By Stripe====

This indicates that a rule in your Stripe account may be blocking payment.

To resolve this:
# Log in to your [https://dashboard.stripe.com/ Stripe Dashboard].
# Go to '''Developers > Logs'''.
# Find the log entries from the time at which the payment was attempted. The details of the log will show whether the payment was blocked (for example, with a '''The zip code you supplied failed validation''' error).
# Adjust the rules in your Stripe account for the error. For help, contact [https://support.stripe.com/ Stripe support].

====Customisations====

This issue may also present itself as '''"No Stripe Details Found for Update"''' in the Gateway Log.

This issue can occur due to interference from a third-party Stripe module. Using the official Stripe module requires the full uninstallation and removal of any custom or third-party Stripe integrations. This includes removal of all files and template modifications.

For example, these issues may trigger this error:

* A hook file in <tt>/includes/hooks/stripe.php</tt>. Remove this file when switching to the WHMCS Stripe module.
* Template customisations in your active order form template files.
* The payment method is set to a module other than Stripe. In this case, perform one of the following actions:
** Change the client's '''Payment Method''' setting in the client's '''Profile''' tab to the Stripe module.
** Make Stripe the system default payment gateway at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.

====Out Of Date Template Files====

The error indicates that you have out-of-date template files. Make certain that your client theme and order form templates are fully compatible with your version of WHMCS. The [[Release Notes]] for each version of WHMCS provide links to template changes.

====Network Analyser Tool====

Another method to diagnose this error is to use your browser's network analyser tool. Please see the section '''Another Error Type''' in [https://help.whmcs.com/m/troubleshooting/l/1312423-an-error-occurred-while-communicating-with-the-server-please-try-again this help article]. Whilst the article is for another issue, it describes how to use your browser's network analyser tool to help identify underlying errors.

===No Stripe Customer Details Found===
The system logs this error in the debug data section of '''Billing > [[Gateway Log]]'''. It indicates that the client does not have a payment method in WHMCS. You can confirm this in the '''[[Pay Methods]]''' section of the client's '''[[Clients:Summary Tab|Summary]]''' tab.

To resolve this, ask the client to log in to the Client Area, go to the unpaid invoice, and click '''Pay Now''' to make a payment via Stripe. This will create a payment method to use for future automatic payments.

==="You must provide a value for 'cvc'===

If you see at '''Billing > [[Gateway Log]]''' for a failed payment attempt by an admin or the cron job, this indicates that the customer is in an European country or has a European billing address. Stripe's API requires that they make at least one manual payment to get added to their system.

To resolve this, ask the client to log in to the Client Area, go to the unpaid invoice, and click '''Pay Now''' to make a payment via Stripe.

For more information, see [https://stripe.com/docs/api?lang=python#create_card_token Stripe's documentation] (click '''show child parameters''').

When you do this, the system displays the following data:

cvc
usually required
Card security code. Highly recommended to always include this value, but it's only required for accounts based in European countries.

After the customer makes a manual payment, the system adds them to Stripe and any future attempts (automatic or manual) will work normally.

===Network error [errno 35]: Unsupported SSL protocol version===
This error indicates a server configuration issue. The server is attempting a secure connection to Stripe using an outdated SSL protocol. Most providers now require connections via TLS for security purposes. For more information, see [https://stripe.com/docs/security#tls Stripe TLS Documentation].

To resolve this issue, work with your system administrator or hosting provider to ensure that remote cURL connections use TLS by default. You may also need to update your OpenSSL version.

===You passed an empty string for 'statement_descriptor'===
This indicates an empty '''Statement Descriptor''' field in the payment gateway configuration. Make certain that you set your entire [[#Setup|gateway configuration]].

===Bad Request===
This error may appear in the Client Area when a client attempts to pay for an invoice or order using an existing stored payment method. It indicates that the customer or the token in WHMCS do not exist in Stripe. To ensure that the pay method is correctly stored in Stripe, delete the stored payment method from the Admin Area via the client's profile's '''[[Clients:Summary Tab|Summary]]''' tab (which may display a more-informative error to administrators). Then, add the payment method again.

Customised or outdated system themes or order form templates can also cause this error. To troubleshoot this:

# Go to the '''[[General Tab|General]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
# Select ''Six'' or ''Twenty-One'' for '''System Theme'''.
# Go to the '''[[Ordering Tab|Ordering]]''' tab.
# Select a '''[[Standard_Order_Form_Templates|Default Order Form Template]]'''.
# Click '''Save Changes'''.
# Return to the Client Area and refresh the page.

<div class="docs-alert-warning">
<span class="title">Client Area System Themes</span><br />
We introduced Twenty-One in WHMCS 8.1. We plan to remove Six in a future version.
</div>

===An unexpected error - No Stripe Payment Method found from token===
This error indicates that the system could not transmit some of the required data to Stripe. This is usually due to outdated order form templates. Check this issue using the Twenty-One or Six system theme and the Standard Cart order form template.

<div class="docs-alert-warning">
<span class="title">Client Area System Themes</span><br />
We introduced Twenty-One in WHMCS 8.1. We plan to remove Six in a future version.
</div>

This can also be caused by a JavaScript error from custom code (for example, template changes, hooks, or addons) preventing the standard Stripe JavaScript from running correctly. Your browser console will show whether a JavaScript error is occurring.
* If one is, the custom JavaScript will need to be corrected.
* If the JavaScript error is coming from a third-party customisation, contact the developer for assistance.

If the issue persists, contact our [https://www.whmcs.com/submit-a-ticket/ support team].

===Error Updating Remote Pay Method: Remote Storage Failed===
You can find information about this error at '''Billing > [[Gateway Log]]'''.

===Stripe India Accounts===
India-based Stripe accounts require the following additional conditions for a successful payment capture:

* The client's address and billing contact must use a valid Indian postal address.
* The payment card must be from an Indian bank.
* The invoice must use INR as the currency.

To automatically convert invoice totals into other currencies upon payment in WHMCS:

# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Currencies'''.
# Add <tt>INR</tt> as an [[Currencies#Adding.2FEditing_a_Currency|additional currency]].
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
# Set '''Convert To For Processing''' on the Stripe gateway to ''INR''.

For more information about the additional Stripe requirements for Indian Stripe accounts, see [https://support.stripe.com/questions/requirements-for-india-export-charges Stripe's documentation].

{{modules}}

Stripe

2022-09-14T13:18:22Z

AlexN: /* Remote Transaction Failure. Please Contact Support */

== About this Module ==

The WHMCS Stripe payment gateway uses Stripe's tokenised storage system to submit credit card information to Stripe, which stores it remotely.

For other Stripe options, see [[Stripe ACH]] and [[Stripe SEPA]].
{{gateways
| type = token
| recurring = yes
| onetime = yes
| refunds = yes
| updatecc = yes
| deletecc = yes
| 3dsecure = yes
}}
<div class="docs-alert-warning">
The Stripe payment gateway module is not compatible with the Modern or Boxes order form templates.
</div>
== Adding the Stripe Payment Gateway ==

[[File:stripe.png|thumb|Stripe Module Settings]]

To set up the Stripe payment gateway in WHMCS:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.6 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 8.0 to 8.6, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > Payment Gateways''' and choose '''All Payment Gateways'''.
# Click '''Stripe'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Configure a display name. We recommend <tt>Credit Card</tt>.
# Go to the [https://dashboard.stripe.com/account/apikeys Stripe portal] and retrieve the publishable and secret API keys.
# Enter your Stripe credentials.
# Optionally, customize the '''Statement Descriptor Suffix''' with a maximum of 22 characters.
# In WHMCS 8.0 and later, leave the '''Stripe WebHook Endpoint Secret''' and '''Stripe WebHook Endpoint Secret (Test/Sandbox)''' empty. WHMCS auto-generates these. See below for more information.
# Optionally, check '''Allow Payment Request Buttons'''. See below for more information.
# Click '''Save Changes'''.
# If you use different default currencies in Stripe and WHMCS, make certain that you have also configured your Stripe account's currency with a valid exchange rate at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Currencies'''. Stripe only returns transaction fees in the default currency for the Stripe account.

=== WebHook Endpoints ===

<div class="docs-alert-info">
You can use Stripe Webhooks in WHMCS v8.0 and above.
</div>

Stripe's WebHook Endpoints update WHMCS automatically with changes to your customers' cards. In WHMCS 8.0 and later, when you click '''Save Changes''', WHMCS will use the '''Stripe Publishable API Key''' and '''Stripe Secret API Key''' to generate the '''Stripe WebHook Endpoint Secret''' and '''Stripe WebHook Endpoint Secret (Test/Sandbox)'''.

* If you enter live API keys (<tt>sk_live</tt>), WHMCS will generate the '''Stripe WebHook Endpoint Secret'''.
* If you enter test API keys (<tt>sk_test</tt>), WHMCS will generate the '''Stripe WebHook Endpoint Secret (Test/Sandbox)'''.

WHMCS registers the WebHook Endpoints to deliver these events from Stripe:

* <tt>customer.source.updated</tt>
* <tt>customer.card.updated</tt>
* <tt>payment_method.updated</tt>

To change the WebHook ID, empty '''Stripe WebHook Endpoint Secret''' and '''Stripe WebHook Endpoint Secret (Test/Sandbox)''' and click '''Save Changes'''. WHMCS will auto-generate them again with new values.

=== Payment Request Button ===

Enabling this option within the module configuration provides customers with a platform-specific payment request button (for example, Apple® Pay). For customers who don’t use Apple Pay, '''Payment Request''' supports credit cards stored in the browser, Google® Pay, and Microsoft® Pay.

==== Apple Pay ====

[[File:apple_pay_checkout.png|thumb|The Apple Pay Button on Checkout]]

When you enable this, Apple Pay allows access to payment details that users have stored in their Apple Wallet. If they're using Safari® on their iPhone® or iPad®, when they tap "Buy with Apple Pay" on your site, they'll be shown a modal payment sheet. If they're using Safari on their Mac®, and have an iOS® device in range, they'll be prompted on their device to authorize the payment, which will then be sent to the browser.

To use Apple Pay with a live Stripe API key, you must register all of the domains that will display an Apple Pay button with Apple. This includes both top-level domains (for example, <tt><nowiki>whmcs.com</nowiki></tt>) and subdomains (for example, <tt><nowiki>shop.whmcs.com</nowiki></tt>).
<div class="docs-alert-info"><i class="fa fa-info-circle"></i> An SSL certificate is '''required''' to use Apple Pay.</div>

To do this:

# Download this [https://stripe.com/files/apple-pay/apple-developer-merchantid-domain-association domain association file] and host it at <tt>/.well-known/apple-developer-merchantid-domain-association</tt> on your site. For example, if you're registering <tt><nowiki>https://example.com</nowiki></tt>, make that file available at <tt><nowiki>https://example.com/.well-known/apple-developer-merchantid-domain-association</nowiki></tt>.
# To instruct Stripe to register the domain with Apple, go to the '''[https://dashboard.stripe.com/account/apple_pay Apple Pay]''' tab in '''Account Settings''' in the Stripe Dashboard.

==== Google Pay ====

Google Pay allows customers to make payments using any credit or debit card on their Google account, including Google Play, YouTube™, Chrome™, or an Android™ device.

==== Microsoft Pay ====

Microsoft Pay allows customers to make payments using any credit or debit card on their Microsoft account.

=== Test Mode ===

This module does not support test mode.

== Payment Workflow ==

[[File:stripe_checkout.png|thumb|The Stripe module on Checkout]]

The Stripe payment workflow supports automated recurring and on-demand billing.

Customers can choose between previously-stored cards or entering new ones during payment, and they can update their credit cards at any time in the Client Area. Admins can also update credit card information in the WHMCS Admin Area.

During checkout, clients never leave WHMCS. Personal card information goes directly to Stripe and is never stored within WHMCS. The Stripe API handles all refunds and obtains transaction information.

In WHMCS 7.8 and later, WHMCS uses the Stripe Elements implementation method. When performing checkout, if customer authorisation is required, the system will prompt the user automatically to approve the payment. This process is also commonly referred to as 3D Secure. Use of 3D Secure depends on the card type and issuer.

<div class="docs-alert-info">
WHMCS 8.3 and higher includes support for disputes for Stripe and PayPal® transactions at '''Billing > [[Disputes]]'''.
</div>

===Recurring Payments===

Automated recurring payments use stored tokens. If a client card requires SCA, the system will deny the payment attempt and the client must log in to WHMCS manually to process the payment.

== Payment Gateway Balances ==

In WHMCS 8.2 and later, you can view payment gateway balances directly within the WHMCS Admin Area, with native support for Stripe balances.

At '''Billing > [[Transactions]]''', you can view balances in the transaction list and in the transaction details for individual transactions. For more information, see [[Payment Gateway Balances and Transactions]].

This requires you to enable '''View Gateway Balances''' for the desired administrator role at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Administrator Roles]]'''.

<div class="docs-alert-warning">
In the Admin Area [[Admin_Dashboard|Dashboard]], you can view your Stripe balances through the '''Stripe Balance''' widget. However, this widget does not use the <tt>WHMCS\Module\Gateway\Balance</tt> and <tt>WHMCS\Module\Gateway\BalanceCollection</tt> classes to display balances. For more information, see [[Stripe Balance Widget]].
</div>

== Migrating to Stripe ==

The Stripe payment gateway module supports migrating locally-stored credit card details to Stripe's tokenized storage. This is useful when you transition from another non-tokenized merchant gateway provider to Stripe.

For an existing client with a locally-stored credit card, the first time that the system attempts to capture payment for an invoice using Stripe, the system will submit the credit card details to Stripe and create and store a token. Then, the system will remove the local copy of the card details.

To migrate to Stripe and ensure all future credit card processing uses it:

# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.6 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[Apps and Integrations|Apps & Integrations]]'''.
#* For WHMCS 8.0 to 8.6, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > Payment Gateways''' and choose '''All Payment Gateways'''.
# Activate the Stripe module.
# Click '''Deactivate''' for your previous merchant gateway provider.
# Select Stripe as the replacement gateway to switch users of the previous gateway module to.
# Click '''OK'''.

=== Migrating from a 3rd Party Stripe Module ===

The WHMCS Stripe module uses the Stripe <tt>cus_</tt> reference to capture payments (for example, <tt>cus_9MvIb7UlgJfJTn</tt>). The WHMCS Stripe module can replace any third-party module that uses this.

To check whether your current Stripe module uses the <tt>cus_</tt> reference, navigate to a client that you know has an active Stripe token and click on one of the pay methods in the '''Summary''' tab of the client's profile. Verify that the listed token includes the <tt>cus_</tt> prefix.

To start using the WHMCS Stripe module:

# Note the internal name of the previous Stripe module, which you can find by looking in the gateway column in the <tt>tblpaymentgateways</tt> database table.
# Activate our official Stripe module.
# Deactivate the previous Stripe module.
# Check one of the Stripe pay methods on a client. If the token contains <tt>cus{_}</tt>, you can use it with our module but it will require a manual database edit first. To allow that, run the following SQL query using phpMyAdmin or another tool, replacing "example" with the name of the previous module: <source lang="sql">UPDATE tblpaymethods SET gateway_name = 'stripe' WHERE gateway_name = 'example'; </source>
# Remove any third-party files and template customisations for the previous Stripe module.

==Troubleshooting==

===Remote Transaction Failure. Please Contact Support===

This issue has multiple causes. This may also display as '''Error'''.

# Begin by going to Billing > Gateway Log.
# Look at the Result and Debug Data columns.
# At the time of the payment attempt this should display an error message or code. Refer to the Stripe documentation for more information:
* https://stripe.com/docs/error-codes
* https://stripe.com/docs/declines/codes

Other common causes of this error are explained below.

====Payment Blocked By Stripe====

This indicates that a rule in your Stripe account may be blocking payment.

To resolve this:
# Log in to your [https://dashboard.stripe.com/ Stripe Dashboard].
# Go to '''Developers > Logs'''.
# Find the log entries from the time at which the payment was attempted. The details of the log will show whether the payment was blocked (for example, with a '''The zip code you supplied failed validation''' error).
# Adjust the rules in your Stripe account for the error. For help, contact [https://support.stripe.com/ Stripe support].

====Customisations====

This issue may also present itself as '''"No Stripe Details Found for Update"''' in the Gateway Log.

This issue can occur due to interference from a third-party Stripe module. Using the official Stripe module requires the full uninstallation and removal of any custom or third-party Stripe integrations. This includes removal of all files and template modifications.

For example, these issues may trigger this error:

* A hook file in <tt>/includes/hooks/stripe.php</tt>. Remove this file when switching to the WHMCS Stripe module.
* Template customisations in your active order form template files.
* The payment method is set to a module other than Stripe. In this case, perform one of the following actions:
** Change the client's '''Payment Method''' setting in the client's '''Profile''' tab to the Stripe module.
** Make Stripe the system default payment gateway at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.

====Out Of Date Template Files====

The error indicates that you have out-of-date template files. Make certain that your client theme and order form templates are fully compatible with your version of WHMCS. The [[Release Notes]] for each version of WHMCS provide links to template changes.

====Network Analyser Tool====

Another method to diagnose this error is to use your browser's network analyser tool. Please see the section '''Another Error Type''' in [https://help.whmcs.com/m/troubleshooting/l/1312423-an-error-occurred-while-communicating-with-the-server-please-try-again this help article]. Whilst the article is for another issue, it describes how to use your browser's network analyser tool to help identify underlying errors.

===No Stripe Customer Details Found===
The system logs this error in the debug data section of '''Billing > [[Gateway Log]]'''. It indicates that the client does not have a payment method in WHMCS. You can confirm this in the '''[[Pay Methods]]''' section of the client's '''[[Clients:Summary Tab|Summary]]''' tab.

To resolve this, ask the client to log in to the Client Area, go to the unpaid invoice, and click '''Pay Now''' to make a payment via Stripe. This will create a payment method to use for future automatic payments.

==="You must provide a value for 'cvc'===

If you see at '''Billing > [[Gateway Log]]''' for a failed payment attempt by an admin or the cron job, this indicates that the customer is in an European country or has a European billing address. Stripe's API requires that they make at least one manual payment to get added to their system.

To resolve this, ask the client to log in to the Client Area, go to the unpaid invoice, and click '''Pay Now''' to make a payment via Stripe.

For more information, see [https://stripe.com/docs/api?lang=python#create_card_token Stripe's documentation] (click '''show child parameters''').

When you do this, the system displays the following data:

cvc
usually required
Card security code. Highly recommended to always include this value, but it's only required for accounts based in European countries.

After the customer makes a manual payment, the system adds them to Stripe and any future attempts (automatic or manual) will work normally.

===Network error [errno 35]: Unsupported SSL protocol version===
This error indicates a server configuration issue. The server is attempting a secure connection to Stripe using an outdated SSL protocol. Most providers now require connections via TLS for security purposes. For more information, see [https://stripe.com/docs/security#tls Stripe TLS Documentation].

To resolve this issue, work with your system administrator or hosting provider to ensure that remote cURL connections use TLS by default. You may also need to update your OpenSSL version.

===You passed an empty string for 'statement_descriptor'===
This indicates an empty '''Statement Descriptor''' field in the payment gateway configuration. Make certain that you set your entire [[#Setup|gateway configuration]].

===Bad Request===
This error may appear in the Client Area when a client attempts to pay for an invoice or order using an existing stored payment method. It indicates that the customer or the token in WHMCS do not exist in Stripe. To ensure that the pay method is correctly stored in Stripe, delete the stored payment method from the Admin Area via the client's profile's '''[[Clients:Summary Tab|Summary]]''' tab (which may display a more-informative error to administrators). Then, add the payment method again.

Customised or outdated system themes or order form templates can also cause this error. To troubleshoot this:

# Go to the '''[[General Tab|General]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
# Select ''Six'' or ''Twenty-One'' for '''System Theme'''.
# Go to the '''[[Ordering Tab|Ordering]]''' tab.
# Select a '''[[Standard_Order_Form_Templates|Default Order Form Template]]'''.
# Click '''Save Changes'''.
# Return to the Client Area and refresh the page.

<div class="docs-alert-warning">
<span class="title">Client Area System Themes</span><br />
We introduced Twenty-One in WHMCS 8.1. We plan to remove Six in a future version.
</div>

===An unexpected error - No Stripe Payment Method found from token===
This error indicates that the system could not transmit some of the required data to Stripe. This is usually due to outdated order form templates. Check this issue using the Twenty-One or Six system theme and the Standard Cart order form template.

<div class="docs-alert-warning">
<span class="title">Client Area System Themes</span><br />
We introduced Twenty-One in WHMCS 8.1. We plan to remove Six in a future version.
</div>

This can also be caused by a JavaScript error from custom code (for example, template changes, hooks, or addons) preventing the standard Stripe JavaScript from running correctly. Your browser console will show whether a JavaScript error is occurring.
* If one is, the custom JavaScript will need to be corrected.
* If the JavaScript error is coming from a third-party customisation, contact the developer for assistance.

If the issue persists, contact our [https://www.whmcs.com/submit-a-ticket/ support team].

===Error Updating Remote Pay Method: Remote Storage Failed===
You can find information about this error at '''Billing > [[Gateway Log]]'''.

===Stripe India Accounts===
India-based Stripe accounts require the following additional conditions for a successful payment capture:

* The client's address and billing contact must use a valid Indian postal address.
* The payment card must be from an Indian bank.
* The invoice must use INR as the currency.

To automatically convert invoice totals into other currencies upon payment in WHMCS:

# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Currencies'''.
# Add <tt>INR</tt> as an [[Currencies#Adding.2FEditing_a_Currency|additional currency]].
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''.
# Set '''Convert To For Processing''' on the Stripe gateway to ''INR''.

For more information about the additional Stripe requirements for Indian Stripe accounts, see [https://support.stripe.com/questions/requirements-for-india-export-charges Stripe's documentation].

{{modules}}

Enom

2022-09-12T07:04:22Z

AlexN:

== About this Module ==

The Enom module allows you to register and manage domains with Enom.
{{registrar
| register = yes
| transfer = yes
| renew = yes
| lock = yes
| dns = yes
| whois = yes
| getepp = yes
| regns = yes
| dnsmanagement = yes
| emailforwarding = yes
| domainsync = yes
| premium = yes
| transferout = yes
| TLD Pricing Sync = yes
}}
==Activation==

<div class="docs-alert-success">
You must create an [https://www.whmcs.com/partners/enom/ Enom account].
</div>

To activate and begin using the Enom registrar module:

# Log in to your account on the [https://www.enom.com/apitokens/default.aspx Enom website].
# Enter an identifying name in the textbox (for example, <tt>WHMCS</tt>).
# Click '''Generate New API Token'''.
# Copy the generated API token.
# Log in to the WHMCS Admin Area.
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Domain Registrars]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Domain Registrars'''.
# Find '''Enom''' in the list.
# Click '''Activate'''.
# Enter your Enom username.
# Paste in the API token.
# Check '''Disable IRTP''' to prevent WHMCS from displaying contact information verification notices.
# Check '''Use Default Nameservers''' to use Enom's default nameservers for new registrations, overriding the nameservers in WHMCS.
# Click '''Save Changes'''.
# In your Enom account, go to '''Resellers > Manage > API''' and add your server's IP address.
#* You can find this address in WHMCS at '''Help > [[License Information]]'''.
#* If you do not do this, you will see a '''Registrar Error Invalid Client IP''' error.

<html><a href="http://www.youtube.com/watch?v=0Sz9mkBzLN0&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>
<div class="docs-alert-warning">Before you can begin using the Enom API with your account. you must authorize your server IP address for access to your account. See below for steps to do this.</div>

=== Test Mode ===

You can use test mode to simulate domain registration and management function without registering a domain or incurring charges. This can be useful to test WHMCS configurations.

Before you enable '''Test Mode''' in WHMCS, you must register on Enom's Reseller Test environment:

# Log in to [https://resellertest.enom.com/resellers/reseller-testaccount.aspx Enom's Reseller Test Account].
# Click all three links under '''Test Interface Options''' to configure the test account.
# [https://resellertest.enom.com/apitokens/default.aspx Generate a test API token.]

When you place domain registration orders in WHMCS with test mode active, the domains will appear on your demo Enom account (<tt>http://resellertest.enom.com</tt>) but no domain will actually be registered and you will not be charged.

=== .ca Registrations ===

<tt>.ca</tt> registrations require additional fields. The <tt>Invalid registrant information</tt> error is due to problems with the location field.

Instead of entering the full place name, use one of the following province abbreviations:

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

== Transfer Pricing ==

Enom does not allow a domain's registration term to be defined when transferring a domain name.

When configuring pricing for TLDs to transfer using Enom, only configure a one year transfer price. Set all other transfer prices to <tt>-1.00</tt>.

== Automatic Registration ==

WHMCS allows you to set up automatic domain registration on a per-extension basis, enabling you to use different registrars for different TLDs.

To enable automatic registration, see [[Domain Pricing]].

== Automatic Domain Synchronization ==

This module supports automatic domain synchronization for syncing expiry dates and status changes for incoming transfers.

To use this, enable '''Domain Sync Enabled''' in the '''[[Domains_Tab|Domains]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. You must also make certain to configure the '''[[Crons#Domain_Sync_Cron|Domain Sync Cron]]'''.

== Troubleshooting ==

=== 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]]. This must be done via the Enom website 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; e.g. 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. Make certain that your server is able to make cURL calls to the following URLs:

Demo Mode: <tt>resellertest.enom.com</tt>
Live Mode: <tt>reseller.enom.com</tt>

=== Domain name not found ===

This error occurs when the domain does not exist in your Enom account. This message will be displayed when a domain transfer is in progress but will automatically disappear when the transfer is complete.

{{modules}}