WHMCS Documentation - User contributions [en]

Stripe ACH

2024-04-14T12:22:23Z

JuanR: /* The Plaid Client ID, Public Key, and Secret combination is rejected. */

== About this Module ==

<div class="docs-alert-success">
- We added this module in WHMCS 7.9.
- In WHMCS 8.9, we updated this module to use Stripe's <tt>PaymentIntents</tt> API instead of the deprecated Stripe API.
</div>

The Stripe ACH payment gateway module is available in WHMCS.
{{gateways
| type = token
| recurring = yes
| onetime = yes
| refunds = yes
| deletecc = yes
}}

== Adding the Stripe ACH Payment Gateway ==

<div class="docs-alert-warning">
We removed support for Plaid in this module in WHMCS 8.9.
</div>

To set up the Stripe ACH payment gateway in WHMCS:

# If you use WHMCS 8.8 or earlier, activate Plaid support:
## Make certain that you have [https://plaid.com/docs/stripe/#step1 activated ACH in your Stripe account].
## If you have not already, [https://dashboard.plaid.com/signup create a Plaid account].
## Log in to the [https://dashboard.plaid.com/team/integrations Plaid control panel].
## Go to '''Team Settings > Integrations'''.
## Click '''Enable''' next to the Stripe integration and follow the on-screen instructions.
# Log in to the WHMCS Admin Area.
# 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 '''Stripe ACH'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Stripe credentials.
#* If you currently also use the [[Stripe]] payment gateway, you can check '''Use Stripe Configuration''' to use your existing API keys.
#* You can find your credentials in [https://dashboard.stripe.com/account/apikeys the Stripe portal]. [[File:stripe-ach-configuration.png|thumb|Stripe ACH Configuration in WHMCS 8.9 and later.]]
#* Do not enter a value for the '''Webhook Secret Key'''. The system generates this automatically.
#** The Stripe ACH module requires a valid webhook and secret key in order for payments to be recognized and automatically applied to invoices.
#** If you modify the secret key for the webhook at Stripe, you must also update it in WHMCS.
#* If you use WHMCS 8.0 or earlier, contact Plaid support and ask them to enable <tt>public_key</tt> on your Plaid account.
# Click '''Save Changes'''.

=== Test Mode ===

This module does not support test mode.

== Transaction Fees ==

Stripe returns transaction fees in the default currency of the Stripe account. If you have a different default currency in WHMCS, you must ensure you have configured the currency of your Stripe account in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, ''Setup > Payments > Currencies'' along with a valid exchange rate to allow WHMCS to be able to convert the fee into your other currencies.</div>

==Payment Workflow==

This module supports automated recurring and on-demand billing.

ACH payments can take up to 5 days to process. The invoice will be placed in '''Payment Pending''' until the payment has cleared.

When making a payment, customers are able to select to use a previously stored bank account or enter a new one. Customers never leave your WHMCS installation during checkout or adding or removing a new bank account. Personal bank information is submitted directly and the system never stores it in your local WHMCS installation.

The system uses the Stripe API for refunds and obtaining transaction information.

==Troubleshooting==

===error===

A simple message '''error''' when attempting to make payment indicates invalid credentials or incomplete Plaid configuration.

To resolve it, check for the following potential problems:

==== The Plaid Client ID, Public Key, and Secret combination is rejected. ====

Ensure that the API keys have copied correctly from your [https://dashboard.plaid.com/account/keys|Plaid account] into 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>) > System Settings > [[Payment Gateways]]'''.
* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.

See the [[#Getting Started|Getting Started]] steps above to ensure all the configuration is complete.

==== The Sandbox/Development Secret is being used in a live move or vice versa. ====

Plaid issues individual Secrets for use with the Sandbox, Developer, and Live environments. Ensure that the Plaid Secret you entered correctly corresponds to the Plaid Environment setting.

To use Plaid in production mode to process real payments:

# Log in to your [https://dashboard.plaid.com/account/keys Plaid account] and go to '''Team Settings > Keys'''.
# Copy the '''Production Secret'''.
# 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>) > System Settings > [[Payment Gateways]]'''.
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
# Select '''Production''' for '''Plaid Environment'''.
# Paste it into '''Plaid Secret'''.
# Click '''Save Changes'''.

See the [[#Getting Started|Getting Started]] steps above to ensure all the configuration has been fully completed.

==== The Stripe integration is not enabled in your Plaid account. ====

To use Stripe ACH in WHMCS 8.8 or earlier, you must link Plaid to your Stripe account.

For steps to activate the Stripe integration with your Plaid account, see [https://plaid.com/docs/stripe/#step1 Stripe's documentation]].

See the [[#Getting Started|Getting Started]] steps above to ensure all the configuration has been fully completed.

===Invalid Remote Token For Gateway: ===

A '''Invalid Remote Token For Gateway''' error at '''Billing > [[Gateway Log]]''' indicates that the invoice's associated client does not currently have a valid Stripe ACH pay method available.

You cannot use local bank account pay methods to make a capture attempt. Instead, Stripe ACH requires storing the bank details in their system and then WHMCS stores a remote token for them. This has the added benefit of reducing your liabilities because you do not need to store a client's full bank account details.

To resolve this error:

# Go to the '''[[Clients:Summary Tab|Summary]]''' tab of the client's profile.
# Delete the local bank account pay method.
# Ask the customer to log in to the Client Area and pay the invoice by clicking '''Pay Invoice'''.

This will initiate the payment via Stripe ACH and create the necessary tokens for accepting future automated payments.

{{modules}}

Stripe ACH

2024-04-14T12:21:20Z

JuanR: /* The Sandbox/Development Secret is being used in a live move or vice versa. */

== About this Module ==

<div class="docs-alert-success">
- We added this module in WHMCS 7.9.
- In WHMCS 8.9, we updated this module to use Stripe's <tt>PaymentIntents</tt> API instead of the deprecated Stripe API.
</div>

The Stripe ACH payment gateway module is available in WHMCS.
{{gateways
| type = token
| recurring = yes
| onetime = yes
| refunds = yes
| deletecc = yes
}}

== Adding the Stripe ACH Payment Gateway ==

<div class="docs-alert-warning">
We removed support for Plaid in this module in WHMCS 8.9.
</div>

To set up the Stripe ACH payment gateway in WHMCS:

# If you use WHMCS 8.8 or earlier, activate Plaid support:
## Make certain that you have [https://plaid.com/docs/stripe/#step1 activated ACH in your Stripe account].
## If you have not already, [https://dashboard.plaid.com/signup create a Plaid account].
## Log in to the [https://dashboard.plaid.com/team/integrations Plaid control panel].
## Go to '''Team Settings > Integrations'''.
## Click '''Enable''' next to the Stripe integration and follow the on-screen instructions.
# Log in to the WHMCS Admin Area.
# 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 '''Stripe ACH'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Enter your Stripe credentials.
#* If you currently also use the [[Stripe]] payment gateway, you can check '''Use Stripe Configuration''' to use your existing API keys.
#* You can find your credentials in [https://dashboard.stripe.com/account/apikeys the Stripe portal]. [[File:stripe-ach-configuration.png|thumb|Stripe ACH Configuration in WHMCS 8.9 and later.]]
#* Do not enter a value for the '''Webhook Secret Key'''. The system generates this automatically.
#** The Stripe ACH module requires a valid webhook and secret key in order for payments to be recognized and automatically applied to invoices.
#** If you modify the secret key for the webhook at Stripe, you must also update it in WHMCS.
#* If you use WHMCS 8.0 or earlier, contact Plaid support and ask them to enable <tt>public_key</tt> on your Plaid account.
# Click '''Save Changes'''.

=== Test Mode ===

This module does not support test mode.

== Transaction Fees ==

Stripe returns transaction fees in the default currency of the Stripe account. If you have a different default currency in WHMCS, you must ensure you have configured the currency of your Stripe account in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, ''Setup > Payments > Currencies'' along with a valid exchange rate to allow WHMCS to be able to convert the fee into your other currencies.</div>

==Payment Workflow==

This module supports automated recurring and on-demand billing.

ACH payments can take up to 5 days to process. The invoice will be placed in '''Payment Pending''' until the payment has cleared.

When making a payment, customers are able to select to use a previously stored bank account or enter a new one. Customers never leave your WHMCS installation during checkout or adding or removing a new bank account. Personal bank information is submitted directly and the system never stores it in your local WHMCS installation.

The system uses the Stripe API for refunds and obtaining transaction information.

==Troubleshooting==

===error===

A simple message '''error''' when attempting to make payment indicates invalid credentials or incomplete Plaid configuration.

To resolve it, check for the following potential problems:

==== The Plaid Client ID, Public Key, and Secret combination is rejected. ====

Ensure that the API keys have copied correctly from your [https://dashboard.plaid.com/account/keys|Plaid account] into WHMCS in the '''Manage Existing Gateways''' tab 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'''.

See the [[#Getting Started|Getting Started]] steps above to ensure all the configuration is complete.

==== The Sandbox/Development Secret is being used in a live move or vice versa. ====

Plaid issues individual Secrets for use with the Sandbox, Developer, and Live environments. Ensure that the Plaid Secret you entered correctly corresponds to the Plaid Environment setting.

To use Plaid in production mode to process real payments:

# Log in to your [https://dashboard.plaid.com/account/keys Plaid account] and go to '''Team Settings > Keys'''.
# Copy the '''Production Secret'''.
# 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>) > System Settings > [[Payment Gateways]]'''.
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
# Select '''Production''' for '''Plaid Environment'''.
# Paste it into '''Plaid Secret'''.
# Click '''Save Changes'''.

See the [[#Getting Started|Getting Started]] steps above to ensure all the configuration has been fully completed.

==== The Stripe integration is not enabled in your Plaid account. ====

To use Stripe ACH in WHMCS 8.8 or earlier, you must link Plaid to your Stripe account.

For steps to activate the Stripe integration with your Plaid account, see [https://plaid.com/docs/stripe/#step1 Stripe's documentation]].

See the [[#Getting Started|Getting Started]] steps above to ensure all the configuration has been fully completed.

===Invalid Remote Token For Gateway: ===

A '''Invalid Remote Token For Gateway''' error at '''Billing > [[Gateway Log]]''' indicates that the invoice's associated client does not currently have a valid Stripe ACH pay method available.

You cannot use local bank account pay methods to make a capture attempt. Instead, Stripe ACH requires storing the bank details in their system and then WHMCS stores a remote token for them. This has the added benefit of reducing your liabilities because you do not need to store a client's full bank account details.

To resolve this error:

# Go to the '''[[Clients:Summary Tab|Summary]]''' tab of the client's profile.
# Delete the local bank account pay method.
# Ask the customer to log in to the Client Area and pay the invoice by clicking '''Pay Invoice'''.

This will initiate the payment via Stripe ACH and create the necessary tokens for accepting future automated payments.

{{modules}}

Converting Invoices to a New Currency

2024-04-14T12:19:15Z

JuanR: /* Convert invoice amounts into a different currency */

It is possible that not every gateway you use will accept all the currencies you offer on your site. Many gateway modules support a '''Convert To For Processing''' option so WHMCS can transparently convert the payment amount into a different currency before sending the client to the payment gateway.

==Convert invoice amounts into a different currency==

By configuring multi-currency in WHMCS, you can offer prices in multiple currencies even if your chosen payment gateway only operates in one currency.

For example, you could use a gateway that only operates in USD but use this feature to also offer prices in USD, GBP and EUR. When a client places an order and chooses that gateway, the system would automatically convert the amount to the gateway's currency before processing. Without this feature, the client would not be able to use that gateway.

<div class="docs-alert-info">
<span class="title">Note</span><br />
The system performs the currency conversion using the '''Base Conversion Rate''' in your WHMCS installation at the time of payment.
</div>

To configure this feature:
# Configure at least two currencies at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, '''Setup > Payments > Currencies'''. <div class="docs-alert-info">The required '''Convert to For Processing''' setting for payment gateways only displays if you have configured at least two currencies.</div>
# 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>) > System Settings > [[Payment Gateways]]'''.
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
# Set '''Convert to For Processing''' to your desired currency (the currency the gateway requires).
# Click '''Save Changes'''.

The system will send all payments to this gateway in the chosen currency, regardless of which currency the client selected on the order form.

GoCardless

2024-04-14T12:18:33Z

JuanR: /* Importing Existing Mandates */

== About this Module ==

<div class="docs-alert-success">
We added this payment gateway in WHMCS 7.7.
</div>

[https://gocardless.com GoCardless] is a payment gateway which allows for direct debit payments to be automated electronically.

<div class="docs-alert-info">
<span class="title">Important</span><br />
Due to GoCardless API restrictions, you must contact GoCardless support to enable the feature.
</div>
{{gateways
| onetime = yes
| recurring = yes
| reversals = yes
}}
== Adding the GoCardless Payment Gateway ==

To set up the GoCardless 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 '''GoCardless'''. A GoCardless login page will appear.
# Either sign up for a new account or log in to your existing account. The system will automatically configure GoCardless for you.
# Optionally, enter a custom name for the gateway for each of your supported currencies.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
#In WHMCS 8.0 and later, enabling '''Charge Date Preference''' will allow the automation system to omit passing a <tt>charge_date</tt> value to GoCardless when the automation system triggers a payment attempt. This results in GoCardless starting the transaction as soon as possible.
# Click '''Save Changes'''.

===Charge Date Preference===

 '''Charge Date Preference''' will determine if WHMCS passes a transaction charge date to GoCardless advising when to initiate the payment.

* Disabling the option will pass through either the '''Next Due Date''' from the service or the <tt>next_possible_charge_date</tt> that GoCardless sets using the <tt>charge_date</tt> function depending on which date is later.

* If you enable the option, the system will not pass a <tt>charge_date</tt> value to GoCardless and this will result in GoCardless beginning the payment process as soon as possible.  In both scenarios, the payment attempt call to GoCardless will not occur until an invoice meets the invoice and payment capture attempt criteria that you set at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]'''.

To process the payment prior to the '''Next Due Date''' date and according to the '''Process Days Before Due''' date at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''', enable this setting. If you do not, the system may attempt the payment on or after the '''Next Due Date''' date.

=== Supported Currencies ===

GoCardless only support the following currencies:

* AUD
* CAD
* DKK
* EUR
* GBP
* NZD
* SEK
* USD <div class="docs-alert-info">We added support for USD in WHMCS 7.9.</div>

Clients who do not use one of these currencies cannot make payments using GoCardless.

=== Test Mode ===

You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.

==Payment Workflow==

When the first payment is made, a mandate is set up with the client's bank. This typically takes a few days, so the invoice will change from '''Unpaid''' to '''Payment Pending''' status. At this point, you can view the mandate details and expected payment completion date by viewing the invoice. As soon as the mandate is set up and the first payment has cleared, the invoice's status will change to '''Paid''' and the service will be provisioned by WHMCS automatically.

When the renewal invoice is generated for a recurring service, a capture attempt will be made against the mandate in accordance with '''Process Days Before Due''' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''. As it can take a few days for the payment to complete, we recommend a setting of '''3'''. This way, 3 days before the invoice '''Due Date''', the payment process will be initiated by the cron and the invoice status updated from '''Unpaid''' to '''Payment Pending'''. Payment should then complete on the invoice '''Due Date''' and the invoice will be marked '''Paid''' once the payment has cleared.

After you create a mandate, WHMCS can process renewal payments for any other services associated with the client, as long as they also use the GoCardless gateway.

The system redirects clients to GoCardless to enter their bank details when setting up a mandate. Then, GoCardless returns them to WHMCS after the setup is complete. The system submits personal bank information directly to GoCardless and never stores it in your local WHMCS installation.

==Reversed Payments==

The Direct Debit Guarantee scheme allows the payee to file a claim for any payment taken in error. WHMCS will monitor for ''charged_back'' events from GoCardless and will automatically process these as appropriate.

To learn more, visit [[Payment Reversals]]

==Refunding Payments==

While refunds with GoCardless are not directly supported from within WHMCS, they can still be processed directly with GoCardless on a case-by-case basis through their review and approval process.

Please refer to the [https://support.gocardless.com/hc/en-ca/articles/210536269-Refunding-payments refunding payments] section of the GoCardless documentation.

== Mandates ==

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

=== Reinstating Mandates ===

<div class="docs-alert-warning">
Reinstating mandates requires specific permission from GoCardless.
</div>

When a mandate has been accidentally cancelled, WHMCS can initiate steps to reinstate the mandate without having the client set it up again.

To do this:

# 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>) > System Settings > [[Payment Gateways]]'''.
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
# Click '''Manage Cancelled Mandates'''.
# Follow the instructions in the modal that appears to reinstate a cancelled mandate.

=== Importing Existing Mandates ===

<div class="docs-alert-info">
You must disable any automatically-charged mandates that you import in order to prevent possible duplicate charges.
</div>

You can import mandates that you set up outside of WHMCS and associate them with a client.

To do this:

# 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>) > System Settings > [[Payment Gateways]]'''.
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
# Click '''Import Existing Mandates'''.
# Follow the instructions in the modal that appears to import a active mandate to a specific client.

=== Removing Mandates ===

You can remove mandates by deleting the client's GoCardless [[Pay_Methods|pay method]].

To do this:

# Click on the pay method in the '''[[Clients:Summary_Tab|Summary]]''' tab of the client profile.
# Click '''Delete''' to [[Clients:Summary_Tab#Removing_Card_Details|remove the pay method]] and any associated mandates.

== Reconfiguring Callbacks ==

After moving WHMCS, you must perform the following steps:

# 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'''.
# Click '''Configure GoCardless Account Connection'''.
# Log in again using the same details.

This ensures that GoCardless stores and uses the new system URL and gateway callback file URL.

== Troubleshooting ==

===Access token not active===

You can only connect each GoCardless account to a single WHMCS at a time. If you connected the GoCardless Account to multiple WHMCS installations, only the last installation that you connected will function correctly. Previously-connected WHMCS installations will show an <tt>Access token not active</tt> error at '''Billing > [[Gateway Log]]'''.

To resolve this error, you will need to reconnect WHMCS to GoCardless by [[#Reconfiguring_Callbacks|reconfiguring callbacks]].

===Remote Storage "create" action did NOT provide token===
This error indicates that the GoCardless account does not have access to the required API endpoint. Due to GoCardless API restrictions, you must contact GoCardless support to enable the feature for your account.

{{modules}}

GoCardless

2024-04-14T12:17:52Z

JuanR: /* Reinstating Mandates */

== About this Module ==

<div class="docs-alert-success">
We added this payment gateway in WHMCS 7.7.
</div>

[https://gocardless.com GoCardless] is a payment gateway which allows for direct debit payments to be automated electronically.

<div class="docs-alert-info">
<span class="title">Important</span><br />
Due to GoCardless API restrictions, you must contact GoCardless support to enable the feature.
</div>
{{gateways
| onetime = yes
| recurring = yes
| reversals = yes
}}
== Adding the GoCardless Payment Gateway ==

To set up the GoCardless 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 '''GoCardless'''. A GoCardless login page will appear.
# Either sign up for a new account or log in to your existing account. The system will automatically configure GoCardless for you.
# Optionally, enter a custom name for the gateway for each of your supported currencies.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
#In WHMCS 8.0 and later, enabling '''Charge Date Preference''' will allow the automation system to omit passing a <tt>charge_date</tt> value to GoCardless when the automation system triggers a payment attempt. This results in GoCardless starting the transaction as soon as possible.
# Click '''Save Changes'''.

===Charge Date Preference===

 '''Charge Date Preference''' will determine if WHMCS passes a transaction charge date to GoCardless advising when to initiate the payment.

* Disabling the option will pass through either the '''Next Due Date''' from the service or the <tt>next_possible_charge_date</tt> that GoCardless sets using the <tt>charge_date</tt> function depending on which date is later.

* If you enable the option, the system will not pass a <tt>charge_date</tt> value to GoCardless and this will result in GoCardless beginning the payment process as soon as possible.  In both scenarios, the payment attempt call to GoCardless will not occur until an invoice meets the invoice and payment capture attempt criteria that you set at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]'''.

To process the payment prior to the '''Next Due Date''' date and according to the '''Process Days Before Due''' date at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''', enable this setting. If you do not, the system may attempt the payment on or after the '''Next Due Date''' date.

=== Supported Currencies ===

GoCardless only support the following currencies:

* AUD
* CAD
* DKK
* EUR
* GBP
* NZD
* SEK
* USD <div class="docs-alert-info">We added support for USD in WHMCS 7.9.</div>

Clients who do not use one of these currencies cannot make payments using GoCardless.

=== Test Mode ===

You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.

==Payment Workflow==

When the first payment is made, a mandate is set up with the client's bank. This typically takes a few days, so the invoice will change from '''Unpaid''' to '''Payment Pending''' status. At this point, you can view the mandate details and expected payment completion date by viewing the invoice. As soon as the mandate is set up and the first payment has cleared, the invoice's status will change to '''Paid''' and the service will be provisioned by WHMCS automatically.

When the renewal invoice is generated for a recurring service, a capture attempt will be made against the mandate in accordance with '''Process Days Before Due''' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''. As it can take a few days for the payment to complete, we recommend a setting of '''3'''. This way, 3 days before the invoice '''Due Date''', the payment process will be initiated by the cron and the invoice status updated from '''Unpaid''' to '''Payment Pending'''. Payment should then complete on the invoice '''Due Date''' and the invoice will be marked '''Paid''' once the payment has cleared.

After you create a mandate, WHMCS can process renewal payments for any other services associated with the client, as long as they also use the GoCardless gateway.

The system redirects clients to GoCardless to enter their bank details when setting up a mandate. Then, GoCardless returns them to WHMCS after the setup is complete. The system submits personal bank information directly to GoCardless and never stores it in your local WHMCS installation.

==Reversed Payments==

The Direct Debit Guarantee scheme allows the payee to file a claim for any payment taken in error. WHMCS will monitor for ''charged_back'' events from GoCardless and will automatically process these as appropriate.

To learn more, visit [[Payment Reversals]]

==Refunding Payments==

While refunds with GoCardless are not directly supported from within WHMCS, they can still be processed directly with GoCardless on a case-by-case basis through their review and approval process.

Please refer to the [https://support.gocardless.com/hc/en-ca/articles/210536269-Refunding-payments refunding payments] section of the GoCardless documentation.

== Mandates ==

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

=== Reinstating Mandates ===

<div class="docs-alert-warning">
Reinstating mandates requires specific permission from GoCardless.
</div>

When a mandate has been accidentally cancelled, WHMCS can initiate steps to reinstate the mandate without having the client set it up again.

To do this:

# 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>) > System Settings > [[Payment Gateways]]'''.
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
# Click '''Manage Cancelled Mandates'''.
# Follow the instructions in the modal that appears to reinstate a cancelled mandate.

=== Importing Existing Mandates ===

<div class="docs-alert-info">
You must disable any automatically-charged mandates that you import in order to prevent possible duplicate charges.
</div>

You can import mandates that you set up outside of WHMCS and associate them with a client.

To do this:

# 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'''.
# Click the '''Manage Existing Gateways''' tab.
# Click '''Import Existing Mandates'''.
# Follow the instructions in the modal that appears to import a active mandate to a specific client.

=== Removing Mandates ===

You can remove mandates by deleting the client's GoCardless [[Pay_Methods|pay method]].

To do this:

# Click on the pay method in the '''[[Clients:Summary_Tab|Summary]]''' tab of the client profile.
# Click '''Delete''' to [[Clients:Summary_Tab#Removing_Card_Details|remove the pay method]] and any associated mandates.

== Reconfiguring Callbacks ==

After moving WHMCS, you must perform the following steps:

# 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'''.
# Click '''Configure GoCardless Account Connection'''.
# Log in again using the same details.

This ensures that GoCardless stores and uses the new system URL and gateway callback file URL.

== Troubleshooting ==

===Access token not active===

You can only connect each GoCardless account to a single WHMCS at a time. If you connected the GoCardless Account to multiple WHMCS installations, only the last installation that you connected will function correctly. Previously-connected WHMCS installations will show an <tt>Access token not active</tt> error at '''Billing > [[Gateway Log]]'''.

To resolve this error, you will need to reconnect WHMCS to GoCardless by [[#Reconfiguring_Callbacks|reconfiguring callbacks]].

===Remote Storage "create" action did NOT provide token===
This error indicates that the GoCardless account does not have access to the required API endpoint. Due to GoCardless API restrictions, you must contact GoCardless support to enable the feature for your account.

{{modules}}

EWAY

2024-04-14T12:17:06Z

JuanR: /* Migrating to eWAY from eWAY Rapid 3.1 */

<div class="docs-alert-info">We added this module in WHMCS 7.9. It supersedes the [[EWAY Rapid 3.1]] module.</div>

eWAY lets WHMCS users to accept online credit card payments easily and securely so they can grow their business fast. The Secure Fields solution allows merchants to securely and seamlessly process payments from their own website, without exposing the sensitive card data.

<div class="docs-alert-info">[https://my.eway.io/whmcs Create an eWAY Account]</div>

Further, the WHMCS integration takes advantage of Token Payments, allowing customers to securely store the card information within eWAY’s PCI DSS environment, and WHMCS uses the Token (which represent the saved card) to handle all future payments without the customer having to key in their details again.
{{gateways
| type = token
| onetime = yes
| recurring = yes
| refunds = yes
| updatecc = yes
}}

== Adding the EWAY Payment Gateway ==

To set up the EWAY 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 '''EWAY'''.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
# Create and enter your EWAY credentials:
## Create an [https://my.eway.io/whmcs eWay account].
## Log in to the [https://my.eway.io MYeWAY Dashboard].
## Go to '''My Account > API Key'''.
## Copy and paste your API key and password into WHMCS. For information on setting up your API key and password, see the [https://go.eway.io/s/article/How-do-I-setup-my-Live-eWAY-API-Key-and-Password eWAY Knowledge base.].
## Copy and paste your public API key ('''Pay Now Button Public API key''') into WHMCS. For information on obtaining your Public API Key, see [https://go.eway.io/s/article/How-do-I-find-my-Public-API-Key Finding my Public API Key]
# Click '''Save Changes'''.

===Test Mode===

You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.

===Migrating to eWAY from eWAY Rapid 3.1===

The eWAY Rapid 3.1 module included in previous versions of WHMCS can be easily replaced with the eWAY module.
If the WHMCS installation has existing tokens stored from the previous module, a button will be shown on the Payment Gateways configuration page to swiftly migrate the tokens to the new module.

#Obtain the Public API Key from eWAY (see above).
#Log in to the WHMCS Admin Area.
# 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>) > System Settings > [[Payment Gateways]]'''.
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
#Click on the eWAY Rapid Module.
#Click on the '''Migrate to eWAY Module''' button.
#Enter the Public API Key where prompted and press the '''Migrate''' button
#The page will save and reload showing the eWAY module is active and the eWAY Rapid Module disabled
#Update any configuration on the newly activated module as required.

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> The Migrate to eWAY Module will only show if the WHMCS installation has Payment Methods associated with the eWAY Rapid Payments module.</div>

==Troubleshooting==
===Card Fields are Not Displayed===
The '''Card Number''', '''Expiry Date''' and '''CVV Number''' fields may not display on the shopping cart or the Manage Pay Methods page in the shopping cart, at '''Hello, User! > Payment Methods''' in the Client Area, or when you click '''Add Credit Card''' in the '''[[Clients:Summary_Tab|Summary]]''' tab in the client profile.

This indicates that eWAY is rejecting the eWAY API key in the configuration at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]. This might occur if you entered the API key incorrectly, it has expired, or eWAY revoked it.

To resolve the error, perform steps 4 and 5 from [[#Adding_the_EWAY_Payment_Gateway|Adding the EWAY Payment Gateway]] above.

{{modules}}

Working with Tokenization

2024-04-14T12:16:03Z

JuanR: /* Enforcing Tokenization */

Tokenization is a process in which sensitive payment details are stored remotely by a payment gateway processor. This is intended to reduce the security burden and limit the liability on you as a business. Examples of payment gateways that support tokenization include Authorize.net, Stripe, Quantum Gateway, etc...

When a tokenization payment gateway is in use, the details for a Pay Method are stored remotely by a given payment gateway and therefore the Pay Method is restricted for use only by the given payment gateway.

In such scenarios, the ability to use a given Pay Method with other payment gateways will be restricted. This will become apparent during checkout when switching between payment methods (also referred to as payment gateways) and the list of available Pay Methods changing. For example, a Stripe Pay Method cannot be used to pay an invoice assigned to Authorize.net and vice-versa.

===Tokenization Migration===

If you have previously used a Payment Gateway that stores credit cards locally and wish to switch to a Tokenized Payment Gateway solution, the following considerations apply:

# Activating a Tokenization Payment Gateway module in addition to a non-tokenized Merchant Gateway module will still allow credit cards to be stored locally by both Admin and Client Users.
# Activating a Tokenization Payment Gateway does not remove existing locally stored credit cards from the database. To do this, please refer to the ''Related Settings'' above.
# To enforce use of a tokenization Payment Gateway for Clients, please see the ''Enforcing Tokenization'' section below.
# In many cases, WHMCS can convert locally stored credit cards to tokenized cards upon the next automated recurring payment attempt automatically. With some tokenized Payment Gateways this may not be possible due to technical restrictions imposed by the Payment Gateway. Please refer to the documentation for your specific [[Payment Gateways|Payment Gateway]] for further information.

===Enforcing Tokenization===

To enforce the use of a Tokenization Payment Gateway and prevent new credit cards from being stored locally, you simply need to hide all non-tokenization Payment Gateways from the order form.

To do this, 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>) > System Settings > [[Payment Gateways]]'''.
* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''Manage Existing Gateways'''.
Then, ensure the '''Show on Order Form''' checkbox is deselected for all non-tokenization Merchant Gateway Modules.

<div class="docs-alert-info">Note that doing this does not delete existing credit cards stored locally in the database. If you wish to do this, an option is available in the '''[[Security Tab|Security]]''' 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'''. Please refer to the ''Related Settings'' for more information.</div>

Licensing

2024-01-11T12:56:00Z

JuanR: /* Moving WHMCS */

When you move your WHMCS system, if the domain, IP address, or directory you use it in is changing, you must update your license.

<div class="docs-alert-info">
* For information on checking your license key information and forcing license updates, see [[License Information]].
* For information on troubleshooting common licensing errors, see [[License Troubleshooting]].
</div>

== Methods to Use ==

The method to use to do this depends on your license type:

=== Purchased Directly from WHMCS ===

If you purchased your license from us directly, you can reissue your license from [https://www.whmcs.com/members our client area] without any manual intervention from us.

To do this:

# Log in to the [https://www.whmcs.com/members WHMCS Members Area].
# Go to '''Services > My Licenses'''.
# Select your license key.
# Click '''Reissue''' under the '''Management Actions''' tab.
# Visit your WHMCS installation in the new location. The system will save the new valid access details.

=== Purchased from Your Web Host ===

If you received your license from your hosting provider, you can't reissue your license from our client area. This is because the domain and IP address cannot change. Contact your hosting provider to have them update the license for use at the new location.

If you are moving to a different hosting provider, you cannot move your license key with you and you will require a new license key for use at the new location.

== Moving WHMCS ==

To move WHMCS:

# Disable or remove the WHMCS cron jobs from the old server. This prevents automation from running and making changes.
# Create a backup of your database [[Backups#Manual_Database_Backup|following these instructions]].
# Make sure the new server meets the [[System_Requirements|system requirements]].
# Transfer the files to the new server.
# [[Maintenance#Restoring_a_Database_Backup|Restore the database]] via phpMyAdmin on the new server and make any changes to the database settings in <tt>configuration.php</tt>.
# Use the appropriate method above to reissue your license for the new location.
# In the WHMCS Admin Area, update the system URLs at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
# Check whether the system properly modified your cron jobs, payment gateway callbacks, and email forwarders.
# Update your [[Further Security Steps#Secure_the_Writeable_Directories|custom directory locations]].
# Update your [[Moving_Storage_Locations|storage locations]].
# Update your redirect URIs for any [[Sign-In_Integrations | sign-in integrations]], [[Mail_Tab#Mail_Type_or_Mail_Provider | mail providers]], or [[Payment_Gateways#Supported_Gateway_Modules | payment gateways]] that redirect users to WHMCS.
# Delete the WHMCS files from the old location.

<html><a href="https://www.whmcs.com/services/#transfer?utm_medium=docs" class="docs-video-tutorial"><em><small>Transfer Services: Have our team transfer your WHMCS installation.</small></em><span class="button">Services</span></a></html>

== Licensing While Offline ==

Licensing continues to function when WHMCS is offline. WHMCS uses a local key licensing system with periodic remote verification checks. Once every seven days, your WHMCS system will contact our server to ensure it is being run in the correct location and that the license is still valid. Whether your WHMCS system is online is not dependant on our server being online during the time the local key is valid.

If our licensing server is unavailable on the day of your next verification check, the system will allow up to three days to make a connection. If, after this time, the system still can't verify your license with our licensing server, your WHMCS Admin Area will become inactive until WHMCS can contact our server again.

The WHMCS Client Area will always remain online, even if you have an invalid or expired license, to ensure your clients have uninterrupted access.

System Environment Guide

2024-01-03T13:48:51Z

JuanR: /* Database Privileges */

WHMCS is compatible with most web server environments. Installing WHMCS in your web environment is usually straight forward. As well, WHMCS is continually providing updates which can seamlessly support environment updates from the upstream providers. However, as new technologies emerge and your current system's environment has access to new updates, it's important that you are aware of how they might affect your WHMCS deployment. This guide is designed help you and your system administrator prepare and manage your environment.

<div class="toclimit-2">__TOC__</div>

== Overview ==
WHMCS is designed for a traditional LAMP (Linux, Apache, MySQL, PHP) environment. The minimum requirements and basic version compatibility related to those sub-systems are provided in our [[System Requirements]].

The development of WHMCS is such that alternative technologies may be viable, however they are not tested and assistance from our Support Team will be limited. For example, if you wish to use NGINX instead of Apache, it may be technically possible. However, our Support will have limited knowledge about how to properly configure NGINX or debug behaviors that are specific to NGINX.

If you require the use of something other than Linux, Apache, or MySQL please consult with your system administrator to evaluate the immediate possibilities for (in)compatibility and long-term viability so that your environment management strategy accommodates for your specific requirements.

== Operating System ==
WHMCS is designed to run in a standard Linux operating/file system. WHMCS relies on PHP for interaction with the file system. In some operating systems (such as Windows) or environments (such as jails or chroots) the file system may have restrictions or inherent behaviors which may be hard to detect or uncommon. When possible, WHMCS provides notices that indicates incompatibility. If you require a different operating/file system, please discuss with your system administrator. Our Support Team is available to provide limited assistance to your system administrator for your custom environment.

Also of note, WHMCS relies heavily on the Linux Cron sub-system to trigger background tasks and perform periodic automation tasks such as deferred provisioning, service synchronization, invoice generation, billing, and more. You may learn more at the [[Crons| crons documentation]].

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>Please note, the command line PHP used to invoke the cron will need to meet the same requirements as the [[#PHP| PHP]] binary used by your web server. This includes ini settings and enabled extensions.</div>

== Web Server ==
WHMCS is designed to work with the Apache web server version 2.x. While there are no special Apache configurations required for WHMCS, there are some advantages available to you and your WHMCS deployment that you may wish to consider.

=== Extensions ===

;mod_rewrite
:The Apache mod_rewrite module allows Apache to inspect and modify URLs and redirects through the use of .htaccess files within your web server docroot. WHMCS can create and manage a .htaccess file, and thus generate and consume friendly URLs in various parts of the product. This feature is described in more detail at [[Friendly URLs]].

=== Handler ===
The web server is responsible for all web applications on the server, and thus the Unix permissions granted to the php process (php handler) that operate with your web application are important. Some PHP handlers will execute all php code on the system as the same Unix user (server wide handlers like CGI & mod_php) while other handlers execute the PHP process as a specific user based on domain name (per vhost handlers like suphp, mod_ruid2). Both options are viable for WHMCS. However, as a matter of security, you need to ensure that no other applications on the server, outside your control, executes as the same Unix user. Your system administrator should be able to configure the web server so that this minimum level of security is met, or more conservatively, that the WHMCS web application process is executed by a user that is wholly unique amongst any other application on the server (even those within your control).

=== Directives ===

WHMCS uses configuration directives to alter the web server configuration on a per-directory basis. As Apache is the recommended web server software platform to run WHMCS on, these directives are included via the following .htaccess files.

; ~/.htaccess
: This file contains the mod_rewrite directives responsible for sending routable paths through the index.php file. This in turn allows the internal routing system to function, and furnishes WHMCS with the ability to create consumer friendly URLs. More information can be found on the [[Friendly URLs]] documentation page.

; ~/vendor/.htaccess
: This file prevents access to the ~/vendor directory. This ensures that the web server is not serving file requests directly from this location, and that WHMCS is still capable of accessing the libraries it needs to function. More information can be found on the [[Further_Security_Steps#Vendor_Directory|Further Security Steps]] documentation page.

While other web server technologies are not officially supported, we understand that some users do wish to run WHMCS in environments other than Apache. For those that do, you must ensure that the functionality offered by the aforementioned directives has been implemented by your web server configuration.

How this is achieved depends on the web server itself. If uncertain, then you should consult with your server administrator. As an example, you can find a guide detailing how to secure the vendor directory on the NGINX web server on the [[Nginx Directory Access Restriction]] documentation page.

== Database ==
WHMCS is designed to work with the MySQL database. Binary compatible alternatives (such as MariaDB) should be suitable, however their default configurations and optimizations are likely to be different and you should consult with your system administrator or database administrator.

=== Version Compatibility ===
{{:MySQL Version Support Matrix}}

=== Database Privileges ===
When installing or updating WHMCS, activating or deactivating modules, or resetting the '''Module Log''' entries at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''', you must grant the following privileges:
* ALTER
* CREATE
* DROP
* INDEX

For day to day use, only the following database privileges are required. All others may be disabled.
* DELETE
* INSERT
* SELECT
* UPDATE
* LOCK TABLES

If you choose to restrict the privileges for day to day use, don't forget to grant the former privileges so database schema changes and optimizations can be performed by the update process.

=== Database Interaction ===
WHMCS internals utilize the PDO database API. If the PHP environment is v5.6, both a PDO based connection and a MySQL handle will be used for compatibility with legacy code.

If you are developing code for the WHMCS platform, it is recommended that you interact with the database via the [https://developers.whmcs.com/api/internal-api/ Local API], [https://developers.whmcs.com/advanced/db-interaction/ DBAL & ORM], or [[Using Models|Models]]. All three methods will abstract database connection details and system compatibility for you and will be supported by WHMCS for the foreseeable future. The [https://docs.whmcs.com/SQL_Helper_Functions?redirect=no SQL Helper Functions] are still present, although deprecated. Due to their ubiquitous usage, we anticipate supporting them as long as possible but recommend that you use one of the other methods above. You can learn more at [https://developers.whmcs.com/advanced/db-interaction/ Interacting with the Database] on our developer's site.

=== Encrypted Database Connections ===

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

Support for encrypted MySQL connections uses the following configuration variables in the <tt>configuration.php</tt> file:

* <tt>db_tls_ca</tt> — The path to the CA <tt>.pem</tt> file (for example, <tt>/var/www/html/whmcs/ca.pem</tt>).
* <tt>db_tls_ca_path</tt> — The path to the directory that contains the CA certificate files.
* <tt>db_tls_cert</tt> — The path to the client's certificate.
* <tt>db_tls_cipher</tt> — A list of one or more ciphers to use for SSL encryption, in an OpenSSL-compatible format.
* <tt>db_tls_key</tt> — The path to the client's key.
* <tt>db_tls_verify_cert</tt> — Disable (<tt>0</tt>) or enable (<tt>1</tt>) the server certificate.

You can configure these variables before, during, or after installation using the [[Install On The Command Line|command-line installation method]] or after installation using the [[Installing WHMCS|browser-based installation method]]. For steps, see [https://help.whmcs.com/m/installation/l/1706785-enabling-encrypted-mysql-connections Enabling Encrypted MySQL Connections].

<div class="docs-alert-info">
* For more information about the required MySQL configuration and variables, see [https://dev.mysql.com/doc/refman/8.0/en/using-encrypted-connections.html Using Encrypted Connections] and [https://dev.mysql.com/doc/refman/8.0/en/server-status-variables.html#statvar_Current_tls_ca Server State Variables].
* For steps to configure encrypted MySQL connections on cPanel & WHM servers, see [https://docs.cpanel.net/knowledge-base/security/how-to-configure-mysql-ssl-connections/ cPanel's How to Configure MySQL SSL Connections Documentation].
</div>

== PHP ==
WHMCS is written in PHP. Your environment's PHP will need to be a version supported by the version of WHMCS you are using. In general, this will be one of the PHP versions that is either under active development or is receiving security fixes from the upstream PHP maintainers.

Whenever possible, it is usually preferable to utilize a version of PHP that is under active development. Unfortunately, there can be a number of circumstances that may complicate the viability of using the latest stable release of PHP. These can range from a lack of control panel build support to incompatibility for other web applications on your server to backwards breaking behavior in PHP that inhibit ionCube Loader® support. Regardless, WHMCS always provides support for a security-monitored PHP version available from the PHP maintainers and we are continually prioritizing compatibility with their releases.

<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>Our [[PHP Upgrade Guide]] outlines the essential steps you can follow in preparation for a PHP upgrade. In WHMCS 7.5 we also provide the [[PHP_Version_Compatibility_Assessment| PHP Version Compatibility Assessment Utility]] designed to scan your WHMCS for any encoded files that may not be compatible for your desired PHP version.</div>

=== Version Compatibility ===
{{:PHP Version Support Matrix}}

=== Extensions ===

WHMCS requires most of the default compiled extensions (for example, PDO, mysqlnd, JSON, libxml, DOM, or Fileinfo). We assume that you will not intentionally disable them in the environment.

You must also compile and enable the following additional extensions:

==== Required ====
; cURL with SSL Support
: cURL is used when interacting with APIs of external systems such as the WHMCS Licensing & Update servers, payment gateways, servers that host your products, etc. cURL's SSL support must be enabled so that verified and encrypted communication is possible.
<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>WHMCS will check for Curl version 7.36 or above.</div>
; GD2
: GD2 Image Library is used when performing graphic manipulation, such as image thumbnails and PDFs.
; IMAP**
: **IMAP is only required if you are utilizing support departments which access mailboxes.
; ionCube Loader
: See the [[#ionCube| ionCube Loader]] section below for more detail.
; JSON
: JSON exchanges data in the UI (for example, displaying success messages after completing an action like changing a password on a service).
; MYSQL**
: ** The original MySQL extension is required if, and only if, your environment uses PHP v5.6.
; PDO_MYSQL
: While the basic PDO API extension is compiled by default in PHP, you must also have the PDO MySQL driver enabled so that PDO can communicate with your MySQL database server.
;Reflection
: Reflection adds the ability to examine and identify classes, interfaces, functions, methods, and extensions within your application. As part of this, the extension can check also for and retrieve documented comments within the same classes, interfaces, functions, and methods.
; SOAP**
: **SOAP is only required by some specific, but possibly important, modules. It is used when interacting with their corresponding external services, such as EU VAT, OpenSRS, eWay Tokens, etc.
; XML
: WHMCS uses the SimpleXML extension that PHP compiles by default. It is highly used for communication with remote systems, such as registrars, payment gateways, and servers.

==== Recommended ====
; BC Math
: The functions provided by BC Math are used when available. They provide performance improvements for when generating cryptographic data.
; Fileinfo
: The functions provided by Fileinfo are used when available. They provide functionalities to aid in determining the content type and encoding of uploaded files.
; GMP
: The functions provided by GMP are used when available. They provide significant performance improvements for when generating cryptographic data.
; iconv
: The iconv extension is for character set conversion, i.e. managing different non-latin characters. If available, this extension provides significant performance improvements and is highly recommended.
; Intl
: Intl performs character inspection and transformation, such as in IDN to perform Punycode conversions and transliterations. While we provide a third party dependency to compensate for the absence of Intl, it is much more performant to have the actual extension in the environment.
; mbstring
: The mbstring extension is for multi-byte character support, i.e managing non-Latin characters and glyphs. If available, this extension provides significant performance, allows for broader support of characters and glyphs common throughout digital communications, and is highly recommended.
; OpenSSL
: OpenSSL is for secure communications and random number generation. If available, this extension will be used and provide significant performance improvements for cryptographic routines.

=== PHP INI Settings ===
; allow_url_fopen
: allow_url_fopen must be enabled for the WHMCS Updater.

<div id="IonCube_Version"> </div>

== ionCube ==

ionCube is a set of encoding and decoding tools that provide obfuscation and performance for PHP software. The decoder tool is a "loader" in the server environment. The encoder tool, an "encoder," is part of PHP developers' publication processes.

WHMCS is encoded with ionCube and requires that you install and enable the ionCube Loader extension in your server environment. We recommend running the latest version of the ionCube Loader for your PHP version. Our [[ioncube Installation Tutorial|ionCube Installation Tutorial]] provides an overview for installing this extension in your environment.

Usually, ionCube will publish a complementing loader several weeks following a new PHP version.

Using this latest loader will afford you two benefits:
* You have the potential for running previously-encoded files using a new base PHP version and running unencoded (raw) PHP code that is compatible with the base PHP version.
* You can run newly-encoded files from a new ionCube Encoder (if one was published).

The ionCube Encoder requires the developer to itemize the PHP versions to support. This helps to mitigate the limitations for supporting certain PHP versions concurrently: it is common for PHP applications to not support the latest PHP version on the initial PHP release date. Applications may also have further requirements about the oldest supported PHP version and the required loader.

Each WHMCS version has always supported at least two PHP versions. Each new version of WHMCS has always supported at least one of the PHP versions supported in the previous WHMCS publication. This perpetual overlap of PHP version support across WHMCS publications means that you always have a path to upgrade your PHP environment without having to update the WHMCS software at the same time. As well, it allows the WHMCS Updater to safely automate updates for your current environment. Providing this overlap is integral to enabling your environment maintenance strategy, giving you the best balance of security, stability and forward compatibility as soon as possible.

=== Version Compatibility ===
{{:IonCube Loader Version Matrix}}

Troubleshooting Module Problems

2024-01-03T13:45:06Z

JuanR: /* Enable Logging */

You can use this module debugging tool to identify and resolve problems communicating with remote API systems. It will record and display the raw API data going to and from the remote system.

== Enable Logging ==

<div class="docs-alert-info">
Only enable logging for this tool for testing purposes. At all other times, make certain that you set '''Module Logging''' to '''Off'''.
</div>

If you are experiencing a technical issue with a module, enable logging.

To do this:

# Make sure your [[Administrator Roles|administrator role]] has the '''View Module Debug Log''' permission.
# Go to the '''Module Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs'''.
# Set '''Module Logging''' to '''On'''.<br/><br/>[[File:turn-on-module-log-2.png|800px]]
# Reproduce the issue.
# Return to the module log page.

The details of the interaction between WHMCS and the module will display onscreen for your own analysis. You can forward these details to the provider's technical support team if necessary.

<div class="docs-alert-info">
To use the '''Reset Module Debug Log''' option, temporarily grant the <tt>DROP</tt> privilege to the WHMCS database user. For more information, see [[System_Environment_Guide#Database_Privileges|Database Privileges]].
</div>

== Unknown Errors ==

Sometimes a third-party system or module will provide a response that WHMCS is unable to recognise and interpret. This can result in the display of an '''Unknown Error''' message.

In these cases, you can use the '''System Module Debug Log''' to obtain the raw response, which will typically help identify the problem.

Pay Methods

2023-12-19T12:55:03Z

JuanR:

In WHMCS, a Pay Method is a payment method that belongs to a client. It can represent a credit card or a bank account. Clients can choose any of their available payment methods during checkout for new orders and for payment of invoices. Each individual payment method has an associated '''[[Payment Gateways|Payment Gateway]]''' and can also have a different associated billing address.

<div class="docs-alert-info">
The following settings in the '''[[Security Tab|Security]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' affect payment method behavior:

* '''Allow Client Pay Method Removal'''
* '''Delete Encrypted Credit Card Data'''
* '''Delete Encrypted Bank Account Data'''
</div>

==Default Pay Method==

Clients must always have a default payment method. This is the payment method that all new automatic recurring payment attempts use by default.

In some scenarios, the default payment method may not be valid for a specific invoice (for example, when the default payment method is tokenized with a specific payment gateway and the invoice's payment method uses a different payment gateway). If this occurs, the system uses the client's first applicable payment method.

<div class="docs-alert-warning">
* You cannot set a different default payment method on a per-service basis.
* Changing the default payment method will not change the payment method that existing unpaid invoices use.
</div>

==Managing Pay Methods==

===Admin Area===

You can manage client payment methods from the '''[[Clients:Summary_Tab|Summary]]''' tab of the client profile.

[[File:Paymethod-admin-area-v3.png]]

===Client Area===

Clients can view and manage payment method at '''Billing > Payment Methods''' in the Client Area.

[[File:payment-methods.png|400px]]

Clients can view all of their saved payment methods, update their descriptions and expiry dates, delete them (if you enable this), and change the default payment method for automated recurring payment attempts.

<div class="docs-alert-warning">
If you use tokenized and non-tokenized payment gateways, customers can choose the desired payment method when adding one via the Client Area. This determines whether to store the card locally, encrypted in the WHMCS database, or remotely with the tokenized payment gateway.
</div>

==Processing Payments==

The system attempts recurring charges for capture automatically using the client's default payment method. If no payment method exist for a client, the client will receive an email informing them that the system could not attempt an automated payment and that they must log in and pay the invoice manually.

=== Changing Payment Methods ===

To use a different card, clients can log in to the Client Area and pay the unpaid invoice manually.

=== Capturing Payment Using a Stored Payment Method ===

Admins can also attempt to capture payment at any time using a stored payment method.

To do this:

# Go to the desired invoice in the [[Admin Area]].
# Click '''Attempt Capture'''. If '''Attempt Capture''' does not appear or is disabled, check the invoice's assigned payment method in the '''Options''' tab.
# Choose the desired payment method to use.
# Optionally, enter the CVV number for the card.
# Click '''Attempt Capture''' to attempt the payment.

GoCardless

2023-12-19T12:52:49Z

JuanR: /* Payment Workflow */

== About this Module ==

<div class="docs-alert-success">
We added this payment gateway in WHMCS 7.7.
</div>

[https://gocardless.com GoCardless] is a payment gateway which allows for direct debit payments to be automated electronically.

<div class="docs-alert-info">
<span class="title">Important</span><br />
Due to GoCardless API restrictions, you must have a GoCardless Pro or GoCardless Enterprise account to use this module.
</div>
{{gateways
| onetime = yes
| recurring = yes
| reversals = yes
}}
== Adding the GoCardless Payment Gateway ==

To set up the GoCardless 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 '''GoCardless'''. A GoCardless login page will appear.
# Either sign up for a new account or log in to your existing account. The system will automatically configure GoCardless for you.
# Optionally, enter a custom name for the gateway for each of your supported currencies.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
#In WHMCS 8.0 and later, enabling '''Charge Date Preference''' will allow the automation system to omit passing a <tt>charge_date</tt> value to GoCardless when the automation system triggers a payment attempt. This results in GoCardless starting the transaction as soon as possible.
# Click '''Save Changes'''.

===Charge Date Preference===

 '''Charge Date Preference''' will determine if WHMCS passes a transaction charge date to GoCardless advising when to initiate the payment.

* Disabling the option will pass through either the '''Next Due Date''' from the service or the <tt>next_possible_charge_date</tt> that GoCardless sets using the <tt>charge_date</tt> function depending on which date is later.

* If you enable the option, the system will not pass a <tt>charge_date</tt> value to GoCardless and this will result in GoCardless beginning the payment process as soon as possible.  In both scenarios, the payment attempt call to GoCardless will not occur until an invoice meets the invoice and payment capture attempt criteria that you set at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]'''.

To process the payment prior to the '''Next Due Date''' date and according to the '''Process Days Before Due''' date at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''', enable this setting. If you do not, the system may attempt the payment on or after the '''Next Due Date''' date.

=== Supported Currencies ===

GoCardless only support the following currencies:

* AUD
* CAD
* DKK
* EUR
* GBP
* NZD
* SEK
* USD <div class="docs-alert-info">We added support for USD in WHMCS 7.9.</div>

Clients who do not use one of these currencies cannot make payments using GoCardless.

=== Test Mode ===

You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.

==Payment Workflow==

When the first payment is made, a mandate is set up with the client's bank. This typically takes a few days, so the invoice will change from '''Unpaid''' to '''Payment Pending''' status. At this point, you can view the mandate details and expected payment completion date by viewing the invoice. As soon as the mandate is set up and the first payment has cleared, the invoice's status will change to '''Paid''' and the service will be provisioned by WHMCS automatically.

When the renewal invoice is generated for a recurring service, a capture attempt will be made against the mandate in accordance with '''Process Days Before Due''' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''. As it can take a few days for the payment to complete, we recommend a setting of '''3'''. This way, 3 days before the invoice '''Due Date''', the payment process will be initiated by the cron and the invoice status updated from '''Unpaid''' to '''Payment Pending'''. Payment should then complete on the invoice '''Due Date''' and the invoice will be marked '''Paid''' once the payment has cleared.

After you create a mandate, WHMCS can process renewal payments for any other services associated with the client, as long as they also use the GoCardless gateway.

The system redirects clients to GoCardless to enter their bank details when setting up a mandate. Then, GoCardless returns them to WHMCS after the setup is complete. The system submits personal bank information directly to GoCardless and never stores it in your local WHMCS installation.

==Reversed Payments==

The Direct Debit Guarantee scheme allows the payee to file a claim for any payment taken in error. WHMCS will monitor for ''charged_back'' events from GoCardless and will automatically process these as appropriate.

To learn more, visit [[Payment Reversals]]

==Refunding Payments==

While refunds with GoCardless are not directly supported from within WHMCS, they can still be processed directly with GoCardless on a case-by-case basis through their review and approval process.

Please refer to the [https://support.gocardless.com/hc/en-ca/articles/210536269-Refunding-payments refunding payments] section of the GoCardless documentation.

== Mandates ==

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

=== Reinstating Mandates ===

<div class="docs-alert-warning">
Reinstating mandates requires specific permission from GoCardless.
</div>

When a mandate has been accidentally cancelled, WHMCS can initiate steps to reinstate the mandate without having the client set it up again.

To do this:

# 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'''.
# Click the '''Manage Existing Gateways''' tab.
# Click '''Manage Cancelled Mandates'''.
# Follow the instructions in the modal that appears to reinstate a cancelled mandate.

=== Importing Existing Mandates ===

<div class="docs-alert-info">
You must disable any automatically-charged mandates that you import in order to prevent possible duplicate charges.
</div>

You can import mandates that you set up outside of WHMCS and associate them with a client.

To do this:

# 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'''.
# Click the '''Manage Existing Gateways''' tab.
# Click '''Import Existing Mandates'''.
# Follow the instructions in the modal that appears to import a active mandate to a specific client.

=== Removing Mandates ===

You can remove mandates by deleting the client's GoCardless [[Pay_Methods|pay method]].

To do this:

# Click on the pay method in the '''[[Clients:Summary_Tab|Summary]]''' tab of the client profile.
# Click '''Delete''' to [[Clients:Summary_Tab#Removing_Card_Details|remove the pay method]] and any associated mandates.

== Reconfiguring Callbacks ==

After moving WHMCS, you must perform the following steps:

# 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'''.
# Click '''Configure GoCardless Account Connection'''.
# Log in again using the same details.

This ensures that GoCardless stores and uses the new system URL and gateway callback file URL.

== Troubleshooting ==

===Access token not active===

You can only connect each GoCardless account to a single WHMCS at a time. If you connected the GoCardless Account to multiple WHMCS installations, only the last installation that you connected will function correctly. Previously-connected WHMCS installations will show an <tt>Access token not active</tt> error at '''Billing > [[Gateway Log]]'''.

To resolve this error, you will need to reconnect WHMCS to GoCardless by [[#Reconfiguring_Callbacks|reconfiguring callbacks]].

===Remote Storage "create" action did NOT provide token===
This error indicates the GoCardless account does not have access to the required API endpoint. Due to GoCardless API restrictions, you must have a GoCardless Pro or GoCardless Enterprise account to use this module. For more information, see the [https://developer.gocardless.com/api-reference/#mandates-create-a-mandate GoCardless API documentation].

{{modules}}

Addon Modules

2023-09-27T12:01:53Z

JuanR: /* Enable and Configure an Addon */

Addon modules allow developers to extend the functionality of WHMCS further including new pages in the admin or client areas. You can enable, disable, and manage them in the WHMCS Admin Area.

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

You can find addons to download and install in the [https://marketplace.whmcs.com WHMCS Marketplace].

==Enable and Configure an Addon==

<div class="docs-alert-warning">
<span class="title">Uploading Addons</span><br />
Before you can configure an addon, you must upload the addon to your WHMCS installation. To do this, unzip and upload the addon files to your installation's <tt>/modules/addons</tt> directory. Ensure that the module directory's POSIX permissions are <tt>755</tt> and individual file permissions are <tt>644</tt>.
</div>

To activate and configure an addon:
# Click '''Activate''' for the addon you wish to enable.
# Click '''Configure'''.
# If the addon has includes module-specific settings, configure them.
# Select the administrator roles to allow to access the addon in the '''Access Control''' section.
# Click '''Save Changes'''.

The addon will now appear in the '''Addons''' menu.

==Removing An Addon==

<div class="docs-alert-danger">
<span class="title">Warning</span><br />
Disabling an Addon Module may delete data relevant to the addon from the database.
</div>

To remove an addon, click '''Deactivate''' for that addon.

After you deactivate the addon, you can delete the directory for the addon from the <tt>/modules/addons</tt> directory.

==Troubleshooting==

===Oops Error===

An Oops Error Message when you view the list of addon modules can be caused by an incompatible module. For help to resolve this error, see [https://help.whmcs.com/m/troubleshooting/l/678235-troubleshooting-a-blank-page-oops-error-message Troubleshooting A Blank Page Oops Error Message].

The error will reference the addon module that is causing the failure. Once you know the affected addon, you can remove the addon files from '''/modules/addons''' or obtain an updated version of the addon from the developer.

===Addon does not appear in menu===

Ensure that you have selected the administrator roles during [[Addon Modules|addon configuration]].

Project Management

2023-08-06T19:27:51Z

JuanR: /* Change Log */

== About this Addon Module ==

The '''Project Management''' addon can help you organise jobs and tasks by linking support tickets and invoices with to-do items to create projects. You can then work with these in a single interface and track internal discussions, share files, and track (and optionally bill for) time spent on individual tasks.

You can access the add-on at '''Addons > Project Management'''.

For more information, see the [https://www.whmcs.com/project-management/ WHMCS Project Management] website.

<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;">Project Management</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;">N/A</td>
<td style="border:1px #AAA solid;padding:0.2em;color:darkgreen;">Yes</td>
</tr>
</table>

== Activating Project Management ==

Because this addon ships with WHMCS by default, you do not need to download files before you activate the addon through the [[Admin Area]].

To do this:

# If you have not already, [http://www.whmcs.com/addons/project-management/ purchase the addon].
# 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'''.
# Click '''Activate''' for '''Project Management'''.
# Click '''Configure'''.
# Select the [[Administrator Roles|admin role groups]] who will have access to this addon.
# Select the [[Administrator Users|admin users]] who can configure Project Management settings within the addon.
# Click '''Save Changes'''.

== Project Management ==

The '''Project Management Overview''' lists all of your projects by default, in ascending order of due date. The list includes the title, assigned staff member, status, creation date, due date, number of days left or overdue, and the last updated date for the project.

From this page you can also review the most recent 10 [[System Logs|activity log]] entries and search for projects.

=== Projects Tab ===

This tab displays a list of projects. You can search by project title or associated ticket numbers. If there is only one match for your entered search term, the system will direct you to the project view for that project.

You can apply several filters to the list of projects:

*'''Incomplete''' — View all incomplete projects.
*'''My Incomplete''' — View your assigned incomplete projects.
*'''View All''' — View all complete and incomplete projects.
*'''Assigned To Me''' — View all projects assigned to you, including completed ones
*'''Due Within 7 Days''' — View all projects that are overdue or are due within one week.
*'''Closed''' — View only completed projects.

==== Accessing Projects via Tickets ====

When you view a ticket that is associated with a project, the project's title, due date, and status will display within the support ticket itself.

==== Accessing Projects via Clients ====

In a client's profile's '''[[Clients:Summary Tab|Summary]]''' tab, you can click '''View Projects''' under '''Other Actions''' to go to the project list at '''Addons > Project Management''' with the list already filtered by client.

=== Tasks Tab ===

This tab lists tasks for all of your projects and includes the filters that you can also use in the '''[[#Projects_Tab|Projects]]''' tab.

=== Reports Tab ===

This tab lists reports on your projects, time, and invoice amounts. You can filter them by [[Date_Range_Picker|date range]] and by admin.

== Projects ==

Everything in the Project Management addon, including tasks, tickets, invoices, attachments, and messages, requires a project.

[[File:Projectmanagementview.png|800px]]

When you access a project, all of the project's information will display in a single interface page.

At the top of the page, you can click the pencil icon to edit the project title and details.

* This includes the creation and due dates, the assigned admin, the associated client, and the project's status.
* Click '''Save''' to save your changes.
* You can search for the associated client using [[Intelligent Search]].

Use the buttons next to the project title to perform additional actions:

* Start tracking time when you work on a project ('''[[#Tracking_Time|Start Timer]]''') or stop tracking ('''End Timer''').
* Add a private staff-only note ('''Add Comment''').
* Upload a file to the project ('''Upload File''').
* Send an email using a template under the '''General Messages''' [[Email Templates|email template]] type ('''Send Email''').
* Enable or disable email notifications about the project (toggle '''Watching''' to '''On''' or '''Off''').

<div class="docs-alert-info">
The system will also send email notifications to admins who are assigned to the project or task.
</div>

The top of the page also displays basic information about the project, including the creation date, a color-coded due date, the assigned admin, the client, the status, and the date of the last update to the project.

=== Creating Your First Project ===

To create a project:

# Click '''+ New Project''' in the top right corner.
# Enter the title of the project, associated ticket number, assigned admin, associated client, the creation date, and the due date.
# Click '''Create'''.

You can also create a project directly from within a support ticket by clicking the '''Create New Project''' tab. This option only appears in tickets if the ticket is not already associated with a project.

=== Tasks ===

To add a new task to a project:

# Enter the task name in '''Add new task'''.
# Select an admin to assign to the new task.
# Set the desired due date.
# Click '''Add Task'''.

To mark a task as complete, click the checkmark icon on the left of the list.

To edit a task, click the pencil icon, make the desired changes, and click '''Save'''.

To delete a task, click the trashcan icon. You can also click the pencil icon and then click '''Delete'''.

=== Messages ===

The '''Messages''' tab allows you to add notes and other messages that all admins can see when they view the project. Clients cannot view these messages.

To add a message, enter it in the text box and click '''Post Reply'''. You can also browse for and attach files.

=== Time Tracking ===

You can start the timer to track the time spent on tasks by clicking '''Start Timer'''.

* This creates a timer entry in the '''Time Tracking''' tab. It includes the admin and the start time.
* Click '''End Timer''' to end the timer.

To assign the timer record entry to a specific task:

# Go to the '''Time Tracking''' tab.
# Click the ''Edit'' pencil icon.
# Select the relevant task from the menu.
# Optionally, adjust the admin user, start time, and end time.
# Click '''Save'''.

The system then calculates the total time for each task and for the project as a whole.

=== Tickets ===

To associate [[Support Tickets|support tickets]] with a project:

# Go to the '''Tickets''' tab.
# Click '''Associate Ticket'''.
# Optionally, search for the desired ticket number or keywords from the ticket name.
# Select tickets by checking '''Select''' for each desired ticket.
# Click '''Save'''.

A single ticket can be assigned to multiple projects, and a single project can have multiple tickets assigned to it. If a project does not have an associated client and you assign a client's ticket to that project, that client will automatically be associated with the project too.

You can create a new ticket to associate with the project by clicking '''Open New Ticket'''.

=== Billing ===

Associating invoices with projects allows you to view their status from within the project itself.

The system will automatically associate invoices using the following methods:

* Invoices with a line item including <tt>Ticket #xxxxxx</tt> followed by any associated ticket number.
* Invoices with a line item including <tt>Project #XXX</tt> followed by the ID number for the project.
* Invoices that you generated from within the project using either the '''Quick Invoice''' or '''Bill for Task Time Entries''' features.

To de-associate an invoice from a project, you must update or remove the line item description to remove the ticket or project reference.

=== Files ===

The attachments section allows you to upload files to the project without posting a message.

All attachments, both uploaded here and as attachments in messages posted on the staff messageboard, are stored under the attachments directory, in a folder structure of /projects/xxx/ where xxx is the Project ID number, so projects can be easily accessed by FTP if needed, and cleaned up.

=== Log ===

The '''Log''' tab lists a full history of each action in that project, the date and time, and the associated admin.

=== Task Templates ===

Task Templates are predefined lists of tasks to add to a project.

* You can save and import task templates from within individual projects.
* You can view a list of task templates and delete them by going to '''Settings > Task Templates''' in the top-right corner of any '''Project Management''' page.

==== Save Task List ====

To save all of the tasks in the current project as a new task template:

# Click '''Save Task List'''.
# Enter a name for the new task list.
# Click '''Save'''.

You can now replicate this task list in this or other projects.

==== Import Tasks ====

To import tasks from an existing task template:

# Click '''Import Tasks'''.
# Select the desired task template from the menu or enter text to search for a template and select it.
# Click '''Import'''.

This will import a new copy of all of the task template's tasks into your project.

== Settings ==

You can configure several '''Project Management''' settings as well as configuring permissions for related actions. To do this, click '''Settings''' in the top-right corner of any '''Project Management''' addon page.

You can configure the following settings in the '''General''' tab:

*'''Default Hourly Rate''' — Set the standard hourly rate to charge in automatic time-based billing calculations. You can override this rate on a per-case basis when generating invoices for time-based logs.
*'''Project Statuses''' — Set the available statuses for projects as a comma-separated list.
*'''Completed Statuses''' — Select the statuses to treat as completed (not incomplete or awaiting work). This defaults to '''Abandoned''' and '''Completed'''.

You can configure the following settings in the '''Client Area''' tab:

* '''Enable/Disable''' — Check to enable or uncheck to disable Client Area project access. [[File:Pma_clientarea_overview.png|thumb]]
*'''Allow Access To''' — Check the sections of the Client Area in which clients can view the status and details of their projects. To access this, add the following line to your Client Area URL: <tt>/index.php?m=project_management</tt>
[[File:Pma_clientarea_projectview.png|800px]]

You can view a list of task templates and delete them in the '''Task Templates''' tab.

You can set admin role access by checking and unchecking individual permissions in the '''Permissions''' tab.

== Homepage Widget ==

The addon also includes an [[Admin Dashboard|Admin Area Dashboard]] widget, which you can activate for your admin role group in the normal way in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[Administrator Roles|Manage Admins]]''' or, prior to WHMCS 8.0, '''Setup > Staff Management > Administrator Roles'''.

The widget allows you to see an overview of projects, including title, due date, days left, status, and recent activity.

== API ==

A range of API commands are available for the addon to facilitate project management from remote systems:

*[https://developers.whmcs.com/api-reference/addprojectmessage/ AddProjectMessage]
*[https://developers.whmcs.com/api-reference/addprojecttask/ AddProjectTask]
*[https://developers.whmcs.com/api-reference/createproject/ CreateProject]
*[https://developers.whmcs.com/api-reference/deleteprojecttask/ DeleteProjectTask]
*[https://developers.whmcs.com/api-reference/endtasktimer/ EndTaskTimer]
*[https://developers.whmcs.com/api-reference/getproject/ GetProject]
*[https://developers.whmcs.com/api-reference/getprojects/ GetProjects]
*[https://developers.whmcs.com/api-reference/starttasktimer/ StartTaskTimer]
*[https://developers.whmcs.com/api-reference/updateproject UpdateProject]
*[https://developers.whmcs.com/api-reference/updateprojecttask UpdateProjectTask]

For more information, see our [https://developers.whmcs.com/api/api-index/ API documentation].

== Upgrading ==

To apply a manual update to the '''Project Management''' addon, download the update from our website, unzip the files, and upload them to the root WHMCS directory.

The files are in the appropriate sub-directories to ensure correct upload.

== Uninstalling ==

To uninstall the module and completely remove all associated data (projects, logs, tasks, task templates, and attachments), see [[Addon Modules]].

== Troubleshooting ==

''N/A''

== Change Log ==

See the [https://marketplace.whmcs.com/product/26-project-management-addon#changelog Project Management] Marketplace listing.

VentraIP Wholesale

2023-06-07T12:24:40Z

JuanR: /* Automatic Domain Synchronization */

== About this Module ==

<div class="docs-alert-danger">
We deprecated this Ventraip module in 2018. Instead, use the newer module in the [https://marketplace.whmcs.com/product/3757 WHMCS Marketplace].
</div>

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

To activate and begin using the Ventraip registrar module:

# Open a ticket with VentraIP Wholesale and request server IP address access.
#* VentraIP Wholesale's API is IP address-restricted.
#* You can find the IP address to whitelist at '''Help > [[License Information]]''' in the WHMCS Admin Area.
#* If you do not obtain access before proceeding, you will receive a <tt>SoapFault exception: [HTTP] Forbidden</tt> error.
# 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 '''Ventraip''' in the list.
# Click '''Activate'''.
# Enter your Ventraip API credentials.
# Click '''Save Changes'''.
# In the API Information section of the Wholesale System, check whether you are using the latest version of the WHMCS method.

=== Wholesale System Configuration Options ===

Before configuring the module inside of WHMCS, you will need to add your server’s IP address to the '''Allowed IP Addresses''' section in the Wholesale System via '''Your Account > API Information'''.

* For information on the IP address that your WHMCS installation will use to connect to the Wholesale System, contact your hosting provider.
* Alternatively, the IP address that your WHMCS installation is using to connect to the Wholesale System is shown under the '''Configure''' options of the WHMCS module:

[[File:Vent_2.png]]

For security reasons, there is a 5 to 10 minute delay before the allowed IP address is updated in the Wholesale System.

[[File:Vent_1.png]]

=== Configuration through WHMCS ===

After you have verified you are running the latest version of the WHMCS module, and applied the configuration changes required in the Wholesale System, you will need to configure and enable the module through WHMCS.

In WHMCS, begin by going 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'''. Scroll down the page until you find '''Ventraip''', click '''Activate''', and then click '''Configure''' to modify the settings in the module.

You will need to insert your '''Reseller ID''' and '''API Key''', which can be found in the Wholesale System at '''Your Account > API Information'''. You will also be presented with an option that will allow you to control how AU domain name transfers and renewals are handled. More information on this function is included below.

=== Renewal on Transfer (.AU) ===

When configuring the module via WHMCS, you will be presented with an option to control how AU domain name transfers & renewals are handled.

If you leave the '''Renewal of Transfer (.AU)''' box unticked, when a .AU domain name is submitted for transfer it will not be renewed irrespective of the expiration date of the domain. If the box is checked (and the option enabled), when a .AU domain is submitted for transfer that is within 90 days of expiration, it will be submitted as a transfer and renewal (and the amount will be deducted from your Wholesale System balance).

[[File:Vent_3.png]]

This will not charge your customers through WHMCS for the renewal. It will submit the domain for a transfer and renewal. You will be able to view your Transaction history through the Wholesale System at '''Finance > Transactions''' to see any domain transfer and renewals, which you can retrospectively bill your clients for.

=== DNS Management & Email Forwarding ===

Before your clients will be able to use the DNS Management or Email Forwarding services through the WHMCS Client Area, you’ll need to enable the option (on a per domain basis) via '''Wholesale System > Manage > Name Servers > Click Email/URL Forwarding or DNS Hosting''' (depending on what you require).

This will change the name servers on the domain to use the VentraIP Wholesale Email/URL Forwarding and DNS Hosting cluster, but you will be able to manage the records via the WHMCS Client Area upon making those changes. If you have not successfully made the required changes, you will be presented with an error message upon accessing those sections in the WHMCS Client Area.

== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

==Troubleshooting==

===SoapFault exception: [HTTP] Forbidden in /../modules/registrars/ventraip/ventraip.php:957===

Port 957 is being blocked by user's firewall, preventing connections to Ventraip API, server admin/hosting provider must open it.

Server IP address has not been added to 'Allowed IP Addresses' list in the Wholesale System control panel under '''Your Account > API Information'''.

===Unable to retrieve domain id===

Domain does not exist in the Wholesale System. It could be that a transfer is in process, the error will disappear once the transfer is completed.

===Unable to update name servers on domain name===

The new nameservers being submitted are being rejected by the system. Most likely they are invalid and not registered. Please confirm you have entered valid nameservers and try again.

{{modules}}

Stargate

2023-06-07T12:23:51Z

JuanR: /* Automatic Domain Synchronization */

== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

== Troubleshooting ==

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

{{modules}}

ResellOne

2023-06-07T12:23:21Z

JuanR: /* Automatic Domain Synchronization */

== About this Module ==

<div class="docs-alert-danger">
We deprecated and removed this module in WHMCS 7.7.
</div>

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

To activate and begin using the ResellOne registrar module:

# Make certain that your WHMCS installation includes the necessary third-party classes (for example, PEAR).
#* The module cannot operate without these classes.
#* Download the files [http://www.whmcs.com/members/dl.php?type=d&id=29 from the WHMCS member portal] and upload them to the <tt>/modules/registrars/opensrs/</tt> directory.
# Log in to the WHMCS Admin Area.
# Go to '''Setup > Products/Services > [[Domain Registrars]]'''.
# Find '''ResellOne''' in the list.
# Click '''Activate'''.
# Enter your ResellOne credentials.
# Click '''Save Changes'''.

=== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

== Troubleshooting ==

=== Unable to establish socket: (110) Connection timed out ===

This response means you may have a firewall blocking the connection. Ensure ports 52443 (SSL) and/or 52000 (Non-SSL) are open.

{{modules}}

ResellerClub

2023-06-07T12:23:02Z

JuanR: /* Automatic Domain Synchronization */

== 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]].

=== Terms and Conditions ===

ResellerClub requires that clients agree to their terms and conditions when registering a domain. To do this, it adds an additional checkbox to the registration process.

To translate the checkbox name, use <tt>tnc</tt> as the <tt>LangVar</tt> key in the appropriate language file in the <tt>lang/overrides/</tt> directory:

<source lang="php">
$_LANG['tnc'] = 'I agree to the ResellerClub terms and conditions.';
</source>

For more information, see [[Additional_Domain_Fields#Translate_a_field_name|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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

==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}}

ResellerCamp

2023-06-07T12:22:36Z

JuanR: /* Automatic Domain Synchronization */

== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

==Troubleshooting==

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

{{modules}}

OpenSRS

2023-06-07T12:21:31Z

JuanR: /* Automatic Domain Synchronization */

== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

== 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}}

OnlineNIC

2023-06-07T12:21:01Z

JuanR: /* Automatic Domain Synchronization */

== About this Module ==

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

To activate and begin using the OnlineNIC 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 '''OnlineNIC''' in the list.
# Click '''Activate'''.
# Enter your OnlineNIC credentials.
# Click '''Save Changes'''.

=== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

== Troubleshooting ==

=== Ports ===

If you use a firewall that blocks port <tt>20001</tt>, it may block communication with the OnlineNIC API and cause connection issues.

=== Other Errors ===

For a list of error codes for the OnlineNIC API, see [https://wiki.onlinenic.com/#!Addendum.md OnlineNIC Response_Parameters].

{{modules}}

Nominet

2023-06-07T12:20:34Z

JuanR: /* Automatic Domain Synchronization */

== About this Module ==

The Nominet module allows you to register and manage domains with Nominet.
{{registrar
| register = yes
| renew = yes
| dns = yes
| whois = yes
| domainrelease = yes
| domainsync = yes
}}
== Activation ==

To activate and use the Nominet 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 '''Nominet''' in the list.
# Click '''Activate'''.
# Enter your Nominet credentials.
# Click '''Save Changes'''.
# [https://www.nominet.uk/ Open a ticket] with Nominet to request access to use your Nominet account via EPP using your server's IP address.
#* You can find the IP address in WHMCS at '''Help > [[License Information]]'''.
#* If you don't do this, you will see a '''Error Connecting to ...''' 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

== Troubleshooting ==

=== Unable to find the socket transport "ssl" ===
This error indicates that SSL communication support is missing from the PHP build on your server. Recompile PHP with OpenSSL.

=== Command syntax error ===

Nominet has specific requirements for client data formats. This error usually indicates a problem with client details in the '''[[Clients:Profile Tab|Profile]]''' or '''[[Clients:Contacts Tab|Contacts]]''' tabs. Make certain that the postcode and phone number are correctly formatted.

=== Error Connecting to ssl://epp.nominet.org.uk on port 700 ===

This error indicates that either a firewall rule is blocking connections on port <tt>700</tt> or that your server's IP address has not been authorized to access your Nominet account.

{{modules}}

NetEarthOne

2023-06-07T12:20:06Z

JuanR: /* Automatic Domain Synchronization */

== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

== Troubleshooting ==

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

{{modules}}

Namecheap

2023-06-07T12:19:48Z

JuanR: /* Automatic Domain Synchronization */

== About this Module ==

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

To activate and begin using the Namecheap 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 '''Namecheap''' in the list.
# Click '''Activate'''.
# Enter your Namecheap credentials.
# Click '''Save Changes'''.
# Whitelist your server's IP address using the steps in the [https://www.namecheap.com/support/api/intro/ Namecheap documentation]. You can find this IP address in WHMCS at '''Help > [[License Information]]'''.

=== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

== Troubleshooting ==

=== Registrar Error Invalid Request IP ===

Seeing this error indicates that your Server IP has not been whitelisted for API access (see above).

===Unable to obtain Nameservers for an unregistered domain===

This error occurs when the domain does not exist in your Namecheap account. This message will display when a domain transfer is in progress but will automatically disappear when the transfer is complete.

{{modules}}

IPMirror

2023-06-07T12:19:13Z

JuanR: /* Automatic Domain Synchronization */

== About this Module ==

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

To activate and begin using the Ipmirror 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 '''Ipmirror''' in the list.
# Click '''Activate'''.
# Enter your IPMirror credentials using the [[#Configuration|configuration]] below.
# Click '''Save Changes'''.

===Requirements===

The Ipmirror module connects WHMCS with the ccTLD Box Registrar Application Interface (RAPI). This allows WHMCS to pass certain domain operations (for example, domain registrations) to IPMirror’s ccTLD Box in real time without manual intervention.

To access ccTLD Box through RAPI, you must:

* Obtain valid ccTLD Box partner account with IPMirror.
* Update IPMirror's firewall configuration with the IP address of the WHMCS server(s) you plan to use.
* Find your partner-specific URL to the ccTLD Box RAPI.

===Configuration===

{| class="wikitable"
!colspan="2"|Setting Name: DebugMode
|-
|colspan="2"|The IPMirror username to access your ccTLD Box.
|-
!colspan="2"|Setting Name: Password
|-
|colspan="2"|The password to access your ccTLD Box.
|-
!colspan="2"|Setting Name: ccTLDBoxUrl
|-
|colspan="2"|The URL to access your ccTLD Box RAPI. This generally uses the <tt><nowiki>https://</nowiki><partnerdomain>/RAPI/</tt> format, where <tt><partnerdomain></tt> is the domain for your ccTLD Box.
|-
!colspan="2"|Setting Name: AllowAdminContactChange
|-
|colspan="2"|If you enable this, a client logged in to the WHMCS Client Area can see and modify the administrative information and contacts for a domain. WHMCS administrators can always see and modify all contacts. We do not recommend this for contacts with a specified contact ID.
|-
!colspan="2"|Setting Name: DefaultRegContactId
|-
|colspan="2"|If this is a valid, existing ccTLD Box contact ID, this contact will always be the registrant contact for new domains. Usually, you should disable this in order to have a separate registrant contact for each domain.
|-
!Setting Name: ConnectionTimeout
!Recommended Value: 20 (seconds)
|-
|colspan="2"|Time in seconds for the interface to wait to connect to ccTLD Box.
|-
!Setting Name: ExecutionTimeout
!Recommended Value: 60 (seconds)
|-
|colspan="2"|Time in seconds for the interface to wait for ccTLD Box to execute a command.
|-
!Setting Name: DebugMode
!Recommended Value: Off
|-
|colspan="2"|Enable this to output debug information like parameters or function calls onscreen, with the synchronization script outputting the information to the console. This only works for users with admin privileges. Only use this option to provide debugging information to IPMirror, and disable it immediately afterwards.
|}

== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

==Troubleshooting==

''N/A''

{{modules}}

HEXONET

2023-06-07T12:18:21Z

JuanR: /* Automatic Domain Synchronization */

== About this Module ==

<div class="docs-alert-success">
We added this module in WHMCS 7.7.
</div>

The HEXONET module allows you to register and manage domains with HEXONET.
{{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
}}
==Activation==

To activate and begin using the HEXONET 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 '''HEXONET''' in the list.
# Click '''Activate'''.
# Enter your HEXONET credentials and configuration.
#* For help with using a proxy server, see [https://wiki.hexonet.net/wiki/HighPerformanceProxySetup HEXONET's documentation].
#* By default, the HEXONET API converts domains to IDN format (recommended). Change this to PHP to make use of the <tt>idn_to_ascii</tt> function (deprecated). This function [http://php.net/manual/en/function.idn-to-ascii.php must be compiled] in your <tt>php.ini</tt> file.
#* Check '''DNSSEC''' to display the DNSSEC configuration interface in the Client Area domain details page. This feature allows your customer to add DS and KEY records and set the <tt>maxSigLife</tt> setting.
#* Check '''TRANSFERLOCK''' to automatically apply the transfer lock to new domain registrations.
# Click '''Save Changes'''.
# Log in to the HEXONET control panel. [[File:Hexonet renewal mode.png|thumb|Renewal Mode Setting]]
# Go to '''Products > Domain Name Settings'''. Click '''+ More''' and search for it if you do not see it in the list.
# For '''Renewal Mode For New Domains''', select '''Expire Domain'''. If you do not do this, domains might be renewed without payment from the client.
# Click '''Save'''.

===IP Registration===

HEXONET's API is '''not''' IP address-restricted by default. However, you can configure this restriction in the control panel to improve security.

To do this:

# Log in to HEXONET.
# Click on your username in the upper-right corner.
# Navigate to '''Settings > Security > IP Restrictions'''.
# Enter your server's IP address.
# Click '''Save Changes'''.

You can find the IP address to whitelist at '''Help > [[License Information]]''' in the WHMCS Admin Area.

===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.

To use Test Mode, you must create a [https://www.hexonet.net/signup-ote HEXONET test account].

== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

== Troubleshooting ==

===Disconnected / Authorization Failed===

Common causes for a ''Disconnected'' or ''Authorization Failed'' error are:
* An incorrect password or username in the registrar module settings 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'''.
* Two-Factor authentication is enabled for the user in your HEXONET account. This can be resolved by deactivating it for your HEXONET user or creating a restricted user role and new user that WHMCS will use to connect to HEXONET's API.
* IP address restriction settings in your HEXONET account do not allow your WHMCS server to connect to the HEXONET API.
* Your server firewall is blocking the connection.
* You are connecting to the test environment using your HEXONET production account or vice versa. The HEXONET OTE API uses a different set of login credentials than the production environment.

===Empty response from API===
This can occur when the API endpoint is unreachable. You can test this by running the <tt>ping api.ispapi.net</tt> command from the WHMCS server's command line.

The module uses ports <tt>80</tt> and <tt>443</tt> to connect to HEXONET over HTTP. Make sure that these ports are whitelisted in your server firewall.

{{modules}}

Heart Internet Domains

2023-06-07T12:17:22Z

JuanR: /* Automatic Domain Synchronization */

== About this Module ==

<div class="docs-alert-info">
For documentation for the Heart Internet provisioning module, see [[Heart Internet]].
</div>

The Heart Internet Domains module allows you to register and manage domains with Heart Internet.
{{registrar
| notitle = yes
| register = yes
| transfer = yes
| renew = yes
| dns = yes
| domainsync = yes
}}
===Activation===

To activate and begin using the Heart Internet 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 '''Heart Internet''' in the list.
# Click '''Activate'''.
# Enter your Heart Internet credentials. You can find them when you log in [https://customer.heartinternet.co.uk/manage/api/ here].
# Click '''Save Changes'''.

=== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

==Troubleshooting==

=== Caught exception: Communication failure ===

This error indicates that your firewall is blocking connections to HeartInternet. Make certain that the following ports are open for outbound connections from your WHMCS server:

* 700(live)
* 1701(test).

GoDaddy

2023-06-07T12:16:56Z

JuanR: /* Domain Sync */

GoDaddy is the world's largest domain name registrar with over 77 million domain names under management.

With the GoDaddy Domain Reseller Module for WHMCS, now you too can leverage GoDaddy's Wholesale Domain Reseller program with WHMCS for automated domain reselling to your customers.

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

==Creating a GoDaddy Reseller Account==

To signup for a GoDaddy reseller account, visit the URL below.

https://reseller.godaddy.com/whmcs

==Setup/Activation==

To activate and begin using the GoDaddy registrar module, after installing the module, follow the steps below:

# Log in to your WHMCS Admin Area.
# Navigate 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''',
# Locate GoDaddy in the list of available modules.
# Click '''Activate'''.
# Enter your GoDaddy API credentials. If you do not currently have API credentials, you can generate them by visiting https://reseller.godaddy.com/setup-api and logging into your GoDaddy Reseller Account.
# Once you have entered the required API credentials, click '''Save Changes''' to complete the process.

==Configuring Automatic Registration==
WHMCS allows you to setup automatic domain registration on a per extension basis enabling you to use different registrars for different TLDs to give you the flexibility to offer more extensions and always get the best value.

To enable automatic registration, please refer to [[Domain Pricing|Configuring Automatic Registration]]

==Domain Sync==
The GoDaddy module supports the automatic syncing of expiry dates for registered domain names and status changes for incoming domain name transfers.

To use this, enable '''Domain Sync Enabled''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

==Troubleshooting==
===Request body doesn't fulfill schema, see details in fields===
====New Registration/Transfer====
The client's profile data is missing required data. Review the client's Profile and Contacts tab (if applicable) to ensure the listed fields in the error message are completed (first name, last name, email address, address, city, state, country, phone number).
====Managing Existing Domain====
The domain was registered through GoDaddy's retail system. Only domains registered via the [[#Creating a GoDaddy Reseller Account|GoDaddy API Reseller platform]] can be managed via the WHMCS module.

===Further Help/Support===

Need help with creating your GoDaddy account? Call GoDaddy @ 480-505-8877. <br>
Need help with creating your Key/Secret? Email api@godaddy.com.<br>
For all other support with the GoDaddy Module please contact the WHMCS support team.

Enom

2023-06-07T12:15:36Z

JuanR: /* Automatic Domain Synchronization */

== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

== Troubleshooting ==

=== User not permitted from this IP address ===

This error message indicates that you haven't yet allowed your server's IP to [[#Activation|access your Enom account via the API]] as described in step 14 above. 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 display when a domain transfer is in progress but will automatically disappear when the transfer is complete.

{{modules}}

TPP Wholesale

2023-06-07T12:14:40Z

JuanR: /* Automatic Domain Synchronization */

== About this Module ==

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

To activate and begin using the TPP Wholesale 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 '''TPP Wholesale''' in the list.
# Click '''Activate'''.
# Enter your TPP Wholesale credentials. You can find these in your TPP Wholesale account at '''Reseller Settings > API Preferences'''.
# Enter the desired '''DefaultAccount''' values, or leave this blank if you want WHMCS to create client accounts on the TPP Wholesale systems and group registrations within them.
# Click '''Save Changes'''.

== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

== Troubleshooting ==

=== Error Codes ===

For information about TPP Wholesale error codes, see [https://support.tppwholesale.com.au/hc/en-gb/articles/360007326597-API-WHMCS-Error-Codes the TPP Wholesale website].

{{modules}}

CentralNic Reseller

2023-06-07T12:13:41Z

JuanR: /* Automatic Domain Synchronization */

== About this Module ==

<div class="docs-alert-success">
We added this module in WHMCS 8.7.
</div>

The CentralNic Reseller module allows you to register and manage domains with resellers from the CentralNic group. Currently, this module supports registrations via RRP Proxy.

<div class="docs-alert-warning">
This module replaces the previous '''[[RRPProxy]]''' module. It provides the latest and most feature-complete integration for RRP Proxy (now CentralNic Reseller) services.
</div>
{{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==

To activate and begin using the CentralNic Reseller 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]]'''.
# Find '''CentralNic Reseller''' in the list.
# Click '''Activate'''.
# Enter your CentralNic Reseller credentials and configuration. For more information, see below.
# Click '''Save Changes'''.

===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.

To use Test Mode, you must create a test account and enter that password in '''Test Password'''.

===Proxy Server===

This setting allows you to specify the proxy server for incoming requests via the cURL <tt>[https://curl.se/libcurl/c/CURLOPT_PROXY.html CURLOPT_PROXY]</tt> option. Using a proxy server can improve HTTP communication performance by keeping connections open longer.

This setting is '''optional'''.

===DNSSEC===

This setting allows you to choose whether users can configure [https://www.icann.org/resources/pages/dnssec-what-is-it-why-important-2019-03-05-en Domain Name System Security Extensions (DNSSEC)] in the WHMCS Client Area. If you enable this, '''DNSSEC Management''' will display as an option in the Client Area sidebar menu when managing a domain.

====What is DNSSEC?====

DNSSEC is a set of IETF specifications for securing information within the DNS system. They provide authentication for the origins of DNS data and denial of existence as well as ensuring data integrity. They do not, however, provide authentication of availability or confidentiality.

====Key Data to DS Data Conversion====

If CentralNic requires DS Data but receives Key Data, it will convert the Key Data into DS Data. The conversion uses SHA-256 and DSData digest type 2. This conversion ensures compliance with the relevant industry standards.

The module sends the following parameters:

<table class="table table-striped table-condensed">
<tr><th>Parameter</th><th>Description</th></tr>
<tr><td><tt>Flags</tt></td><td><tt>256</tt> (zone signing key) or <tt>257</tt> (key signing key)</td></tr>
<tr><td><tt>Protocol</tt></td><td><tt>3</tt> (DNSSEC)</td></tr>
<tr><td><tt>Algorithm</tt></td><td><ul><li><tt>8</tt> (<tt>RSA/SHA256</tt>)</li><li><tt>10</tt> (<tt>RSA/SHA512</tt>)</li><li><tt>12</tt> (<tt>GOST R 34.10-2001</tt>)</li><li><tt>13</tt> (<tt>ECDSA/SHA-256</tt>)</li><li><tt>14</tt> (<tt>ECDSA/SHA-384</tt>)</li><li><tt>15</tt> (<tt>Ed25519</tt>)</li><li><tt>16</tt> (<tt>Ed448</tt>)</li></ul><div class="docs-alert-warning">While other [https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml DNSSEC algorithms] exist, CentralNic Reseller cannot support them because it does not support SHA-1. For more information, see [http://tools.ietf.org/html/rfc4034#appendix-A.1 RFC 4034].</div></td></tr>
<tr><td><tt>Pubkey</tt></td><td>The public key.</td></tr>
</table>

For more information about CentralNic's data conversion process, see [https://kb.centralnicreseller.com/dns/dnssec CentralNic Reseller's DNSSEC documentation] and the [https://nic.cam/static/doc/OperationsManual-v3.2.14.pdf CentralNic Registry Registrar Operations Manual].

== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

== Troubleshooting ==

===Entity reference not found===
This error occurs when the domain does not exist in your CentralNic Reseller account. This message will display when a domain transfer is in progress but will automatically disappear when the transfer is complete.

{{modules}}

101Domain

2023-06-07T12:11:53Z

JuanR: /* Automatic Domain Synchronization */

== About this Module ==

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

To activate and begin using the 101Domain 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 '''101 Domain''' in the list.
# Click '''Activate'''.
# Enter your 101Domain credentials.
# Click '''Save Changes'''.

== 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''' and [[Domain_Synchronisation#Configuration|configure the domain sync task]] at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

==Troubleshooting==

''N/A''

{{modules}}

Maximising Performance

2023-06-04T12:41:18Z

JuanR: /* Software Related */

If you grow to have a large client base, page loads may become slower. This is because the more data you have, the larger the database becomes, and so calculating and looping through the data will naturally take longer.

The following steps can help you maintain faster speeds:

==Software Related==

=== Disable Ticket Counts ===

When you have a lot of tickets, calculating the number of tickets per status to display each time you open a ticket can slow things down.

To avoid that, disable the ticket counts by adding the following line to your WHMCS <tt>configuration.php</tt> file:

<div class="source-cli">
$disable_admin_ticket_page_counts = true;
</div>

=== Disable Client List Services Count ===

If you have a large number of services, calculating the number of services for each client might increase the load time when you visit '''Clients > View/Search Clients'''.

To avoid this, add the following line to your <tt>configuration.php</tt> file:

<div class="source-cli">
$disable_clients_list_services_summary = true;
</div>

=== Logging ===

In WHMCS, you can enable logging for, for example, SQL errors, hooks loading, or module commands.

The following settings control debug logging:

* '''SQL Error Reporting''' 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'''.
* '''Hooks Debug''' 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'''.
* '''Module Debug Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs > Module Debug Log'''.

Make sure to disable these when you are not actively debugging an issue, since they can and will increase the database size exponentially.

=== Customizations ===

Third party customizations can slow the performance of WHMCS. Ensure that any customization (for example, hooks and addons) that you are using is up-to-date and works with the version of WHMCS you are running.

=== Database Backups ===

The database backup process can be CPU, memory, and disk intensive while the entire database is exported, compressed, and uploaded or emailed. If performance issues are observed at the same time every day during the database backup process, this could be a potential cause.

For more information, see [[Backups#Limitations|Backups]].

==Server Related==

=== Email Provider ===

Long loading times when performing an action involving sending an email (for example, placing an order, opening or replying to a support ticket, or publishing an invoice) are often caused by connection issues to the chosen email provider.

To diagnose and resolve this, see [https://help.whmcs.com/m/troubleshooting/l/1261469-troubleshooting-email-sending-problems Troubleshooting Email Problems].

Consider switching to an external mail provider such as MailGun, SendGrid or SparkPost, as these are often more performant than SMTP systems. For further information see [[Mail_Tab#Configuring_a_Mail_Provider_in_WHMCS_8.0_and_later|Configuring a Mail Provider]].

=== MySQL® ===

WHMCS performance is largely dependent on a correct MySQL® configuration, especially for larger databases. Make any changes to the server's <tt>my.cnf</tt> file under the <tt>mysqld</tt> section, usually in <tt>/etc/my.cnf</tt> (cPanel servers and most others).

* As a starting point, set <tt>max_connections</tt> to a low value like <tt>50</tt> and increase based on the available RAM.
* When you are configuring this and the following other important settings, restart MySQL and let it run for 48 hours:
** <tt>wait_timeout</tt> (at least 300, so MySQL doesn't drop connections too soon)
** <tt>sort_buffer_size</tt> (2–4 MB)
** <tt>read_buffer_size</tt> (2–4 MB)
** <tt>max_allowed_packet</tt> (16 MB)

=== System Tweaks ===

WHMCS is a PHP MySQL script, and so the more RAM or SWAP memory and raw processing power you have at your disposal, the better the performance from your installation.

* For more information, see [[System Requirements]].
* We recommend using the higher set values and modules under the '''Recommended Settings''' for best results.

Users and Accounts

2023-04-04T14:10:59Z

JuanR: /* In the Activity Log */

In WHMCS 8.0 and later, the user management system allows a single user to access multiple client accounts in order to separate authentication and authorization from services, billing, and support. It also allows customers to manage their accounts and grant access to it to other users.

==Users and Accounts==

This user management system includes two different entities: accounts and users.

* Accounts (or client accounts) own products and services. They represent a billable party, like a business, and associated users can access and manage them.
* Users can access and manage one or more of their associated accounts. Separate controls manage user access to each account.

When a new customer or an admin creates a new account, this also creates a new user based on the account profile. This becomes the account owner, with each account only having a single account owner. Account owners have all of the possible permissions that a user can possess. They are also the only user who can send invitations from the account to new or existing users.

<div class="docs-alert-info">
If an authenticated user chooses to create a new account for the items in the cart during checkout, that existing authenticated user would become the account owner.
</div>

For example, each of a web designer's customers could represent a distinct account. The web designer could log in as a user and access each of these accounts using a single set of credentials. However, the accounts themselves would not be connected.

==Creating and Managing Users and Accounts==

Account owners can manage users and their permissions from the '''User Management''' section of the Client Area. For more information, see [https://help.whmcs.com/m/managing/l/1275668-adding-and-managing-users Adding and Managing Users].

[[File:CreateAccountInCheckout.png|300px|thumb|right|Creating an account during checkout.]]

When client registration is enabled, new visitors can create an account through the Client Area. Client registration is enabled by default.

===Create an Account===

Unauthenticated users must either log in with as their user and select an existing account or create a new account in order to log in to the Client Area.

====In the Client Area====

Anyone can create an account through the Client Area. To do this:

# Click '''Account''' in the top-right corner.
# Select '''Register'''.
# Fill out the form.
# Click '''Submit'''.

This creates an account and an associated user who is the account owner.

====During Checkout====

Authenticated users can choose to create a new account for the items in the cart during checkout. In this case, the system will assign account ownership for the new account to the logged-in user.

To do this:
# Select ''Create a New Account'' under '''Choose Account''' during the checkout process.
# Fill out the form that appears.
# Continue with the usual checkout process.

===Invitations===

[[File:UserInvitation.png|300px|thumb|right|Invitations]]

<div class="docs-alert-warning">
Invitations expire after 7 days.
</div>

To connect a user to multiple accounts at any time, send invitations from each account to that user or email address. The invitee will receive an email and must click the included link.

* If you send an invitation to an email address for an existing account, they can access the client account using their existing login credentials.
* If the email address does not correspond to an existing account, they can create one.

<div class="docs-alert-warning">
While invitations go to the specified email address, the recipient can complete the invitation process using this link with any email address they choose. Because of this, accepting an invitation is not equivalent to user email verification, which is a separate feature.
</div>

====In the Client Area====

Account owners can send invitations from the '''User Management''' section of the Client Area.

[[File:UserManagementInvite.png|300px|thumb|right|Inviting New Users]]

To do this:

# Go to '''Hello, Name! > User Management'''.
# Enter an email address under '''Invite New User'''.
# Choose '''All Permissions''' to grant all available permissions, or choose '''Choose Permissions''' and select the desired permissions.
# Click '''Send Invite'''.

We recommend this method for [[#Invitations|inviting users to existing accounts]].

====In the Admin Area====

Admins can send invitations from the '''[[Clients:Users_Tab|Users]]''' tab of the client profile in the Admin Area. For more information, see [https://help.whmcs.com/m/managing/l/1275668-adding-and-managing-users Adding and Managing Users].

<div class="docs-alert-warning">
'''Disable Client Area User Management''' in
'''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' in the '''[[Other Tab|Other]]''' tab can disable user management for account owners and prevent them from inviting new users.
</div>

===Managing Accounts and Users in the Client Area===

Account owners can manage users and their permissions from the '''User Management''' section of the Client Area. We recommend this method for [[#Invitations|inviting users to existing accounts]].

[[File:UserManagementClient.png|300px|thumb|right|Managing Users in the Client Area]]

To do this:

# Go to '''Hello, Name! > User Management'''.
# Find the desired user in the list.
# Click '''Manage Permissions'''.
# Select the desired permissions.
# Click '''Save Changes'''.

<div class="docs-alert-warning">
Account owners cannot edit their own permissions.
</div>

===Managing Accounts and Users in the Admin Area===

Admins can view information about and manage individual accounts and their associated users, including resetting passwords, in the '''[[Clients:Users_Tab|Users]]''' tab of an account's client profile.

<div class="docs-alert-warning">
Account ownership can only be transferred between users through the Admin Area.
</div>

[[File:UsersTab.png|350px|thumb|right|Managing Users in the Admin Area]]

<div class="docs-alert-warning">
'''Disable Client Area User Management''' in
'''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' in the '''[[Other Tab|Other]]''' tab can disable user management for account owners and prevent them from inviting new users.
</div>

===Users and Orders===

In WHMCS 8.2 and later, each order is associated with a specific user account.

If the user placed the order through the Client Area, it is associated with the logged-in user that placed the order. If an admin creates the order through the Admin Area, the account owner's user is associated with the order. This determines which user requires verification if you use [[User Identity Verification]].

==Deleting Users==

<div class="docs-alert-warning">
User deletion is permanent, and you cannot delete users who are associated with multiple accounts. You also can't delete account owners unless you're also deleting that account.
</div>

You can delete users in the WHMCS Admin Area through two methods:

* Go to '''Clients > [[Manage Users]]''' and click '''Manage User''' for the desired user. Then, click '''Permanently Delete'''.
* Toggle '''Delete users who are only associated with this client''' to '''YES''' when you delete a client from the '''[[Clients:Summary Tab|Summary]]''' tab of the client profile.

===Deleting Users with Inactive Accounts===

If you use the '''Data Retention Pruning''' setting to delete clients after closure or a period of inactivity, you can also choose to automatically delete the account's associated users.

To do this:

# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]'''.
# Go to '''Automatically Delete Inactive Clients'''.
# Set the toggle to '''YES'''.

<div class="docs-alert-warning">
When you enable this, the system will only delete users that are not associated with any other client accounts.
</div>

==Logging In==

When a user who is only associated with one account logs in, their login session will automatically be associated with that account.

When a user with more than one account logs in, the '''Choose Account''' page will display. The user must select an account so that only information relevant to that account displays.

[[File:ChooseAccountOnLogin.png|300px|thumb|right|Click an Account When Logging In]]

Click on the desired account name to log in to that account. You can change your account at any time by going to '''Hello, Name!''', clicking '''Switch Account''', and clicking an account name again.

==In Support Tickets==

If they have the '''View & Open Support Tickets''' permission, all of the users for an account can view and reply to the account's support tickets.

In the Admin Area, each reply on a ticket includes a badge based on the correspondent's email address, the associated account for the ticket, and the WHMCS system. For example, these badges include '''Owner''' for the account owner, '''Operator''', '''Authorized User''', '''Registered User''', and '''Guest'''. '''Sub-account''' appears when a reply is received from an address that's in the account's list of contacts. For an explanation of each badge's meaning, see [[Support Tickets]].

==In the Activity Log==

[[File:SystemActivityLogUsers.png|200px|thumb|left|Entries For The Same User in the System Activity Log]]

The '''Activity Log''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' in the Admin Area lists information about events in WHMCS, attributing each event to its associated entity.

* Automation events are attributed to '''System'''.
* Admin actions that operate on the system are attributed to that admin. All other admin actions are attributed to that admin '''and''' list the associated client account.
* The system attributes user actions to the user that performed the action. User actions list information about the user '''and''' the associated client account that the user performed the action on.

==Upgrading to WHMCS 8.0==

In the upgrade to WHMCS 8.0, items like passwords, security questions, and two-factor authentication move from client accounts to the associated users. The primary client account will become a user who is the account owner. Additionally, sub-accounts are automatically converted to users during the WHMCS 8.0 upgrade process. Contacts will remain associated with their respective accounts.

The upgrade will '''not''' automatically combine or associate any users or accounts beyond what's discussed in this document. Use invitations, as described above, to associate users with accounts.

Licensing

2023-03-09T12:37:03Z

JuanR: /* Moving WHMCS */

When you move your WHMCS system, if the domain, IP address, or directory you use it in is changing, you must update your license.

<div class="docs-alert-info">
* For information on checking your license key information and forcing license updates, see [[License Information]].
* For information on troubleshooting common licensing errors, see [[License Troubleshooting]].
</div>

== Methods to Use ==

The method to use to do this depends on your license type:

=== Purchased Directly from WHMCS ===

If you purchased your license from us directly, you can reissue your license from [https://www.whmcs.com/members our client area] without any manual intervention from us.

To do this:

# Log in to the [https://www.whmcs.com/members WHMCS Members Area].
# Go to '''Services > My Licenses'''.
# Select your license key.
# Click '''Reissue''' under the '''Management Actions''' tab.
# Visit your WHMCS installation in the new location. The system will save the new valid access details.

=== Purchased from Your Web Host ===

If you received your license from your hosting provider, you can't reissue your license from our client area. This is because the domain and IP address cannot change. Contact your hosting provider to have them update the license for use at the new location.

If you are moving to a different hosting provider, you cannot move your license key with you and you will require a new license key for use at the new location.

== Moving WHMCS ==

To move WHMCS:

# Disable or remove the WHMCS cron jobs from the old server. This prevents automation from running and making changes.
# Create a backup of your database [[Backups#Manual_Database_Backup|following these instructions]].
# Make sure the new server meets the [[System_Requirements|system requirements]].
# Transfer the files to the new server.
# [[Maintenance#Restoring_a_Database_Backup|Restore the database]] via phpMyAdmin on the new server and make any changes to the database settings in <tt>configuration.php</tt>.
# Use the appropriate method above to reissue your license for the new location.
# In the WHMCS Admin Area, update the system URLs at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
# Check whether the system properly modified your cron jobs, payment gateway callbacks, and email forwarders.
# Update your [[Further Security Steps#Secure_the_Writeable_Directories|custom directory locations]].
# Update your [[Moving_Storage_Locations|storage locations]].
# Update your redirect URIs for any [[Sign-In_Integrations | sign-in integrations]], [[Mail_Tab#Mail_Type_or_Mail_Provider | mail providers]], or [[Payment_Gateways#Supported_Gateway_Modules | payment gateways]] that redirect users to WHMCS.
# Delete the WHMCS files from the old location.

<html><a href="https://www.whmcs.com/services#installation?utm_medium=docs" class="docs-video-tutorial"><em><small>Transfer Services: Have our team transfer your WHMCS installation.</small></em><span class="button">Services</span></a></html>

== Licensing While Offline ==

Licensing continues to function when WHMCS is offline. WHMCS uses a local key licensing system with periodic remote verification checks. Once every seven days, your WHMCS system will contact our server to ensure it is being run in the correct location and that the license is still valid. Whether your WHMCS system is online is not dependant on our server being online during the time the local key is valid.

If our licensing server is unavailable on the day of your next verification check, the system will allow up to three days to make a connection. If, after this time, the system still can't verify your license with our licensing server, your WHMCS Admin Area will become inactive until WHMCS can contact our server again.

The WHMCS Client Area will always remain online, even if you have an invalid or expired license, to ensure your clients have uninterrupted access.

Troubleshooting Sign-In using Google

2023-02-21T12:44:02Z

JuanR: /* Google Sign-In is unavailable at this time. Please try again later. Error: Not a valid origin for the client: http://example.com has not been whitelisted for client ID xxxxx */

===Invalid details not saved. Please verify your details and try again===

You may receive the above error message when attempting to configure your Google API credentials. It indicates that the credentials cannot successfully authenticate with the Google API.

If you receive this message, check your API key and secret and try again.

You should also check the Authorized Javascript Origins configuration.

To properly configure your Authorized Javascript Origin:

# Retrieve the '''WHMCS System URL''' value from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. For example: <div class="source-cli"><nowiki>https://demo.whmcs.com/billing/</nowiki></div>
* Remove the WHMCS installation directory from the end. For example: <div class="source-cli"><nowiki>https://demo.whmcs.com/</nowiki></div>
* Remove the trailing slash from the end. For example: <div class="source-cli"><nowiki>https://demo.whmcs.com</nowiki></div>
* Add this as an Authorised Javascript Origin.

===Google Sign-In is unavailable at this time. Please try again later===

Receiving this error when attempting to sign in using Google indicates that either the '''Authorized JavaScript origins''' and '''Authorized redirect URIs''' settings in your Google app are no longer valid or Google did not access WHMCS from the '''[[General_Tab#WHMCS_System_URL|System URL]]'''. A valid URI must begin with <tt>https://</tt> and use an active SSL certificate.

For instructions to set the URL for your Google API app, see [[Configuring Sign-In using Google]].

===Google Sign-In is unavailable at this time. Please try again later. Error: Not a valid origin for the client: <nowiki>http://example.com</nowiki> has not been whitelisted for client ID xxxxx===

Receiving this error when attempting to sign in using Google indicates that the '''Authorized JavaScript origins''' and '''Authorized redirect URIs''' in your Google app are no longer valid.

For more information, see [[Configuring Sign-In using Google]].

You will only receive this error message when you are logged in as an admin and are attempting to use the Client Area Google sign in option. To verify the cause of the error, we recommend attempting to log in while authenticated as a user.

===Remote account linking via Google has failed. Please make sure that the system clock is set properly===

In order for the authentication function to operate, your server time must be within 30 seconds of Google's server time. This error indicates the difference between the two server clocks is outside the acceptable tolerance level (timezones differences do not cause this error).

To resolve this it is necessary to sync your server clock with a NTP server to ensure it is completely accurate. You can use any NTP server of your choice, but Google do offer their own. This can be done from the server command line and typically requires root access:

<div class="source-cli"><nowiki>
ntpdate time.google.com
</nowiki></div>

Instructions for server administrators are located at https://developers.google.com/time/guides

===Verification for current settings failed===

A '''Verification for current settings failed validationResponse: {valid:false}''' error may display in the Admin Area when you attempt to activate the Google Sign-In Integration by entering valid '''Client Id''' and '''Client Secret''' credentials and clicking '''Save & Activate'''.

This error occurrs when:

* The Authorized Javascript origin or Authorised redirect URI settings are incorrect.
* The WHMCS installation is configured to use an insecure http:// connection. A secure and properly configured https:// connection is required to successfully use the Sign-In Integrations feature.

To resolve this error:

# Check the steps in [[#Invalid details not saved. Please verify your details and try again]] above.
# Ensure that an SSL certificate is properly installed on your website
# 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'''.
# Adjust the '''System URL''' value so the URL begins with <tt>https://</tt>.
# Click '''Save Changes'''.
# Return 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''' to complete the activation process

Google Sign-In Integrations will now be activated successfully.

Troubleshooting Sign-In using Google

2023-02-21T12:43:06Z

JuanR: /* Google Sign-In is unavailable at this time. Please try again later */

===Invalid details not saved. Please verify your details and try again===

You may receive the above error message when attempting to configure your Google API credentials. It indicates that the credentials cannot successfully authenticate with the Google API.

If you receive this message, check your API key and secret and try again.

You should also check the Authorized Javascript Origins configuration.

To properly configure your Authorized Javascript Origin:

# Retrieve the '''WHMCS System URL''' value from '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' or, prior to WHMCS 8.0, '''Setup > General Settings'''. For example: <div class="source-cli"><nowiki>https://demo.whmcs.com/billing/</nowiki></div>
* Remove the WHMCS installation directory from the end. For example: <div class="source-cli"><nowiki>https://demo.whmcs.com/</nowiki></div>
* Remove the trailing slash from the end. For example: <div class="source-cli"><nowiki>https://demo.whmcs.com</nowiki></div>
* Add this as an Authorised Javascript Origin.

===Google Sign-In is unavailable at this time. Please try again later===

Receiving this error when attempting to sign in using Google indicates that either the '''Authorized JavaScript origins''' and '''Authorized redirect URIs''' settings in your Google app are no longer valid or Google did not access WHMCS from the '''[[General_Tab#WHMCS_System_URL|System URL]]'''. A valid URI must begin with <tt>https://</tt> and use an active SSL certificate.

For instructions to set the URL for your Google API app, see [[Configuring Sign-In using Google]].

===Google Sign-In is unavailable at this time. Please try again later. Error: Not a valid origin for the client: http://example.com has not been whitelisted for client ID xxxxx===

Receiving this error when attempting to sign in using Google indicates that the '''Authorized Javascript Origins''' and '''Authorized redirect URIs''' in your Google app are no longer valid.

For more information, see [[Configuring Sign-In using Google]].

You will only receive this error message when you are logged in as an admin and are attempting to use the Client Area Google sign in option. To verify the cause of the error, we recommend attempting to log in while authenticated as a user.

===Remote account linking via Google has failed. Please make sure that the system clock is set properly===

In order for the authentication function to operate, your server time must be within 30 seconds of Google's server time. This error indicates the difference between the two server clocks is outside the acceptable tolerance level (timezones differences do not cause this error).

To resolve this it is necessary to sync your server clock with a NTP server to ensure it is completely accurate. You can use any NTP server of your choice, but Google do offer their own. This can be done from the server command line and typically requires root access:

<div class="source-cli"><nowiki>
ntpdate time.google.com
</nowiki></div>

Instructions for server administrators are located at https://developers.google.com/time/guides

===Verification for current settings failed===

A '''Verification for current settings failed validationResponse: {valid:false}''' error may display in the Admin Area when you attempt to activate the Google Sign-In Integration by entering valid '''Client Id''' and '''Client Secret''' credentials and clicking '''Save & Activate'''.

This error occurrs when:

* The Authorized Javascript origin or Authorised redirect URI settings are incorrect.
* The WHMCS installation is configured to use an insecure http:// connection. A secure and properly configured https:// connection is required to successfully use the Sign-In Integrations feature.

To resolve this error:

# Check the steps in [[#Invalid details not saved. Please verify your details and try again]] above.
# Ensure that an SSL certificate is properly installed on your website
# 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'''.
# Adjust the '''System URL''' value so the URL begins with <tt>https://</tt>.
# Click '''Save Changes'''.
# Return 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''' to complete the activation process

Google Sign-In Integrations will now be activated successfully.

Stripe

2023-01-26T17:51:25Z

JuanR: /* Adding the Stripe Payment Gateway */

== 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.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 '''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 API Keys. <div class="docs-alert-info"><i class="fa fa-info-circle"></i> To test Stripe, enter your [https://stripe.com/docs/keys#obtain-api-keys Stripe Test Mode API Keys].</div>
# 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'''.

To resolve this issue:

# Go to '''Billing > Gateway Log'''.
# Check the '''Result''' and '''Debug Data''' columns for error messages or codes from the time of the payment attempt.
# Perform the appropriate steps in Stripe's [https://stripe.com/docs/error-codes Error Codes] and [https://stripe.com/docs/declines/codes Declines Codes] documentation.

See below for other common causes of this error:

====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}}

Virtualizor

2023-01-24T16:31:24Z

JuanR: /* About this Module */

== About this Module ==

[https://www.virtualizor.com/ Virtualizor] is a web based VPS Control Panel by Softaculous, Ltd. It supports OpenVZ, Xen PV, Xen HVM and Linux KVM virtualization and allows you to perform fully-automated VPS creation and management from within WHMCS.

For more information, setup instructions, and the module download, see [https://www.virtualizor.com/docs/billing/whmcs-module/#download the Virtualizor website].
{{Provisioning_Module
| changepackage = Yes
| changepw = Yes
| clientarealink = Yes
| usageupdates = Yes
| port = 4085
| additional = Start, Reboot, Poweroff and Stop VPS and Launch VNC}}

== Features ==

[[File:Admininformation.gif|thumb|Admin Area VPS Info & Management]] [[File:Vpsmanagement.gif|thumb|Client Area Management Functions]] [[File:Vpsinformation.gif|thumb|Client Area VPS Information]]

*Create VPS '''(Admin Only)'''
*Destroy VPS '''(Admin Only)'''
*Suspend VPS '''(Admin Only)'''
*Unsuspend VPS '''(Admin Only)'''

*Start VPS
*Stop VPS
*Restart VPS
*Launch VNC
*View CPU Information
*View RAM Information
*View Disk Information

*View Bandwidth Information

*View VPS Performance

*View VPS Processes
*View VPS Services
*Change Hostname
*Change Root Password
*Change VNC Password
*Re-Install OS

{{modules}}

Pay Methods

2023-01-24T16:28:02Z

JuanR: /* Default Pay Method */

In WHMCS, a Pay Method is a method of payment that belongs to a client. A Pay Method can represent a credit card or a bank account.

Clients can choose any of their available Pay Methods during checkout for new orders and for payment of invoices. Each Pay Method can also have a different associated billing address.

==Default Pay Method==

Clients must always have a default Pay Method. This is the Pay Method that all new automatic recurring payment attempts use by default.

In certain conditions, the default Pay Method may not be usable for a given invoice (for example, when the default Pay Method is tokenized with a specific payment gateway and the invoice's payment method is a different gateway). If this occurs, the system uses the first applicable Pay Method for the user in the displayed order.

Changing the default Pay Method will not change the Pay Method that existing unpaid invoices use.

<div class="docs-alert-info">
You cannot set a different default Pay Method on a per-service basis.
</div>

==Managing Pay Methods==

===Admin Area===

You can manage client pay methods from the '''[[Clients:Summary_Tab|Summary]]''' tab of the client profile.

[[File:Paymethod-admin-area-v3.png]]

===Client Area===

Clients can view and manage Pay Methods at '''Billing > Payment Methods''' in the Client Area.

[[File:payment-methods.png|400px]]

Clients can view all of their saved Pay Methods, update their descriptions and expiry dates, delete them (if you enable this) and change the default Pay Method for automated recurring payment attempts.

<div class="docs-alert-warning">
If you use a mix of both tokenized and non-tokenized payment gateways, customers can choose the desired payment method when adding one via the Client Area. This determines whether to store the card locally encrypted in the WHMCS database or remotely with the tokenized payment gateway.
</div>

==Processing Payments==

The system will attempt automated recurring charges for capture automatically using the default Pay Method for a given client.

If no Pay Methods exist for a client, the client will receive an email informing them that the system could not attempt an automated payment and that they must log in and pay the invoice manually.

To use a different card, clients can log in and pay an unpaid invoice manually at any time via the Client Area.

Admins can also attempt to capture payment at any time using any stored Pay Method. To do this:

# Go to the desired invoice in the [[Admin Area]].
# Click '''Attempt Capture'''. If '''Attempt Capture''' does not appear or is disabled, check the invoice's assigned Payment Method in the '''Options''' tab.
# Choose the desired Pay Method to use.
# Optionally, enter the CVV number for the card.
# Click '''Attempt Capture''' to attempt the payment.

==Related Settings==

The '''Allow Client Pay Method Removal''', '''Delete Encrypted Credit Card Data''', and '''Delete Encrypted Bank Account Data''' settings affect the behaviour of Pay Method functionality.

You can configure these settings in the '''[[Security Tab|Security]]''' 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'''.

Usage Billing

2022-11-28T14:41:57Z

JuanR: /* Usage Data Collection */

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

Usage billing in WHMCS allows you to set up products that contain variable-priced items whose price is determined at the time of invoicing based on usage data provided to WHMCS.

The following are some example use cases for Usage Billing:

* A hosting company charges for bandwidth usage
* A hosting company charges a fixed amount per Addon Domain that is added
* A hosting company offers a hosting package with 10GB of bandwidth included and charges $1.00 per GB used over that
* A hosting company offers reseller hosting that allows you to create 10 cPanel Accounts as standard, but charges you $0.20 per account after that

== Usage Formats ==

Usage can be reported in one of two formats:

* '''Snapshot''' — The usage can be measured and billed for at any given point in time, but for which usage never resets.
* '''Time Based''' — The usage is measured over a given period of time and resets to 0 at the end of the billing period. Bandwidth is an example of a measurement that is typically measured by month, and resets to zero at the end of each month.

<div class="docs-alert-success">
<span class="title">Tip</span><br />
We recommend using the '''Snapshot''' Metric Type on products with a monthly billing cycle.
</div>

== Configuring Usage Billing and Metrics ==

Products associated with capable provisioning modules can capture metrics. These metrics can be can be priced and billed or simply enabled for display purposes.

You can enable metrics for a product in the '''Module Settings''' tab 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'''.

[[File:Usage-billing-module-settings-metric-config.png]]

If a metric is enabled, it will appear within the client's product details view of the client area. An admin will always see all metrics, enabled or disabled, within the admin area when viewing a service belonging to a product which reports metrics.

<div class="docs-alert-success">
<span class="title">More Information</span><br />
* Check out our blog article on Usage Billing for an in-depth look into how Usage Billing works [https://blog.whmcs.com/133590/usage-billing-in-depth here.]
* Check out our step-by-step guide to get started [https://help.whmcs.com/m/setup/l/1184631-billing-clients-for-their-usage here.]
</div>

=== Configuring Metric Pricing ===

To configure metric pricing, click '''Configure Pricing''' for that metric in the '''Module Settings''' tab 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'''.

[[File:Usage-billing-metric-pricing-config.png]]

Metric pricing can be configured using any of the following pricing schemes:

* '''Per Unit''' — Charge the same amount for each unit.
* '''Total Volume''' — Charge a per-unit price based on the total volume consumed.
* '''Graduated''' — Charge a per-unit price based on the consumption range. The total charge is the sum of the range calculations.

For '''Total Volume''' and '''Graduated''' pricing schemes, you '''must''' enter pricing in the text boxes.

You can create as many different pricing brackets as you wish.

The examples below illustrate how the price billed can vary using different schemes.

==== Per Unit Pricing ====

Per unit pricing is the simplest pricing mode we offer. Enter a cost per unit and you’re done.

In a per-unit pricing scheme, prices are defined as per-unit costs, and all units cost the same. Thus, only 1 price bracket may be defined. For example if you used Per Unit pricing for "Addon Domains" and defined a cost of $1/each/period and a customer buys 3, then a $3 charge would be added at the end of the period.

==== Total Volume Pricing ====

In the total volume pricing scheme, multiple price brackets define the prices at different quantity levels. The price per unit for all units is determined by the prevailing price for the total used quantity. An example can illustrate this the best. Say you allow your customers to use an unlimited number of MySQL Databases with a pricing structure defined as follows:

<table class="table table-striped table-condensed">
<tr><th>Starting Quantity</th><th>Price per Database</th></tr>
<tr><td>0</td><td>$2.00</td></tr>
<tr><td>10</td><td>$1.00</td></tr>
<tr><td>20</td><td>$0.50</td></tr>
</table>

If a customer uses 8 MySQL Databases, they will pay $2 per database, for a total of '''$16'''.<br>
If a customer uses 25 MySQL Databases, they will pay $0.50 per database, for a total of '''$12.50'''.

==== Graduated Pricing ====

In the graduated pricing scheme, multiple price brackets define the prices at different quantity levels, much like in the Total Volume scheme. However, unlike the total volume scheme, your customers will pay the defined price per unit for each allocated unit. Let's see how this changes the price a customer pays using the same pricing brackets as pictured above.

If a customer uses 8 MySQL Databases, they will pay $2 per database, for a total of '''$16'''.<br>
If a customer uses 25 MySQL Databases, they will pay $2 per database for the first 9 databases, plus $1 per database for the next 10 databases, plus $0.50 per database for the final 6 databases, for a total of '''$31''' (9 x $2 + 10 x $1 + 6 x $0.50).

==Admin Area==

Services that are associated with products which have metrics will display the latest available usage data collected for all metrics when a service is viewed within the admin area, regardless of the metric state.

The Enabled column provides an indication of whether the metric is enabled for billing at the product configuration level. A check indicates that the metric usage will be billed for periodically.

You can manually poll for the latest values at any time by clicking the "Refresh Now" button located in the bottom right of the Metric Statistics panel.

[[File:Usage-billing-admin-metric-view.png]]

==Client Area==

The product details view of services in the client area provides an information panel similar to that of the one found in client's service within the admin area.

The screenshot below shows how this information appears for a product assigned to the cPanel module.

The notable difference is any disabled metrics will not appear here. Only metrics that are enabled for billing will be displayed.

==Invoicing and Billing==

You can enable usage billing using the '''Enable Metric Usage Invoicing''' setting in the '''[[Invoice Tab|Invoice]]''' 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'''.

==Usage Data Collection==

Usage data is updated twice a day via the TenantUsageMetrics cron task.

This task will run before the CreateInvoices routine of the daily cron.

Custom cron invocations can use the option "--TenantUsageMetrics" to fire or suppress its execution.

<div class="docs-alert-info">
<span class="title">Server Timezones</span><br />
Your server's timezone must match the WHMCS server's timezone to prevent incorrect reporting. For more information, see [https://docs.cpanel.net/whm/server-configuration/server-time/ Server Time].
</div>

==Extensibility==

Module developers can define metrics and collection routines for metrics that are to be made available for display and usage billing by a provisioning module.

To learn more, see our [https://developers.whmcs.com/provisioning-modules/usage-metrics/ Provisioning Module documentation].

MaxMind

2022-11-17T14:44:31Z

JuanR: /* Custom Rules */

MaxMind is a leading provider of IP intelligence and online fraud prevention tools.

==Setup and Configuration==

To enable MaxMind integration in WHMCS 8.2 and later, follow the steps below:

* Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Fraud Protection]]'''.
* Click '''Activate''' for MaxMind.
* Check the checkbox to enable MaxMind.
* Enter your '''MaxMind User ID''' and the '''Licence Key'''. You can find these within the '''My License Key''' page inside the MaxMind online portal.
* Click '''Save'''.

To enable MaxMind integration in WHMCS 8.1 and earlier, follow the steps below:

* Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Fraud Protection''' or, prior to WHMCS 8.0, '''Setup > Fraud Protection'''.
* Choose '''MaxMind''' from the menu.
* Check the '''Enable''' checkbox.
* Enter your '''MaxMind User ID''' and the '''Licence Key'''. You can find these within the '''My License Key''' page inside the MaxMind online portal.
* Click '''Save'''.

==Configuration Options==

===Choosing a Service Type===

MaxMind offers three different levels of check at the time of writing:

* '''Score''' - minFraud score provides only a risk score in WHMCS. No other data is available when using this check type. MaxMind recommend this check type to build your own risk modelling.
* '''Insights''' - minFraud Insights provide a wide range of data to check the potential risk of an order. Information regarding the IP location, the country data and email address is provided with this check type. minFraud Insights is the most comparable offering to the older V1 API.
* '''Factors''' - minFraud Factors builds on the same data as Insights, and then provides additional scoring based on the order input. Check the comparison page for the subscores that can be provided.'''

Essentially, the higher the level, the more analytics and metrics feedback you will receive. The different service types each have differing costs associated with them. For more information, see MaxMind's [https://support.maxmind.com/hc/en-us/articles/4407833140123-Compare-the-minFraud-Services Compare the minFraud Services] documentation.

===MaxMind Fraud Risk Score===

Orders that receive a risk score higher than the value entered here will be marked as fraudulent and prevented from completing checkout.

The default value is 20. A value between 0.01 and 99.9 can be entered. This threshold can then be adjusted up or down depending upon results. For more information refer to [https://support.maxmind.com/what-is-the-riskscore/ What is the riskScore?]

Entering 0 in the Risk Score field will disable checking this option and is not recommended.

===Reject Free Email Service===

Ticking this option checks if the e-mail domain used by the customer is from a free e-mail provider and if so will flag the order as fraud. Examples of free e-mail providers include the following: Yahoo.com, Gmail.com, and MSN.com. The MaxMind system currently has categorised 31,000 free e-mail domain providers around the world.

===Reject Country Mismatch===

Select this option to mark an order as fraudulent if the billing address provided by a client is significantly different from the location of the IP Address used to place the order.

===Reject Anonymous Networks===

Select this option to mark an order as fraudulent if the order is placed via an anonymous network such as a proxy or VPN.

===Reject High Risk Country===

Select this option to mark an order as fraudulent if the transaction's billing address or IP address is located in a country that MaxMind has flagged as high risk.

===Custom Rules===

Custom Rules can be used to reject an orders based on a combination of rules you setup. Custom Rules can be created and managed from within your MaxMind account, more information is available in the [https://support.maxmind.com/hc/en-us/articles/4408801942811-Use-Custom-Rules-and-Dispositions Custom Rules documentation].<br/>
Accept Custom Rules have no effect on the order status.

==Upgrading from MaxMind V1.x to V2==

Your configuration will be automatically updated when upgrading a WHMCS installation from WHMCS 7.5 or earlier to WHMCS 7.6 or later. However, one additional configuration is required to allow fraud checking to continue. The new '''User ID''' configuration parameter must be set for API Authentication to succeed. Your MaxMind User ID can be found on the My License Key page in a MaxMind account.

==Legacy MaxMind Module==

If you are looking for documentation for the MaxMind module in WHMCS 7.5 or earlier, please see [[MaxMind_Legacy_Module]]

==Common Errors==
===MAX_REQUESTS_REACHED===
This means you have run out of MinFraud queries on your MaxMind account, you will need to purchase more queries via the MaxMind website.

===INVALID_LICENSE_KEY===
This error indicates that the license key you provided in your settings is incorrect. It can also indicate that your license key is not valid for the service you are attempting to access. You should first verify your license key has been properly entered at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Fraud Protection]]''' or, prior to WHMCS 8.0, '''Setup > Fraud Protection'''. If the license key is correct, you should contact MaxMind to inquire why your license key is returning as invalid.

===LICENSE_REQUIRED===
This error will be returned if no license key has been provided. Please check your license key setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Fraud Protection]]''' or, prior to WHMCS 8.0, '''Setup > Fraud Protection'''.

===USER_ID_REQUIRED===
This error will be returned if no User ID has been provided. Please check your license key setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Fraud Protection]]''' or, prior to WHMCS 8.0, '''Setup > Fraud Protection'''.

===PERMISSION_REQUIRED===
This is returned if you do not have permission to use the service. Please contact MaxMind for more information.

===IP_NOT_FOUND===
This error will be returned if the IP address is not valid, if it is not public, or if it is not in our GeoIP database.

===CITY_NOT_FOUND===
MaxMind maintain a list of valid cities, this city in the client's Profile at the time of ordering must match one of the cities on MaxMind's list, otherwise the order will be rejected with this error.

{{modules}}

SolusVM

2022-10-19T14:12:09Z

JuanR: /* About this Module */

== About this Module ==

[http://www.solusvm.com SolusVM] is a virtual server control panel from SolusLabs, Ltd. It supports OpenVZ virtualization (Linux), Xen virtualization (Linux, Windows, BSD), and KVM virtualization (Linux, Windows, BSD).

You can install two SolusVM modules:

* The '''Virtual Server Provisioning Module (Admin/Reseller)''' allows you to sell a range of virtual server products:
** You (the admin) can:
*** Create, destroy, suspend, unsuspend, upgrade, downgrade, reboot, boot, and shut down virtual servers.
*** Provision virtual servers in different locations.
** The client can:
*** Use functions and statistics from within the Client Area, including, reboot, boot, shut down, change passwords, change hostname, view resource usage and graphs, and use a serial console or VNC.
*** Order custom virtual servers.
* The '''Reseller Product Provisioning Module''' allows you to create a range of reseller resource products, allowing orders to auto-provison instantly on payment.

{{Provisioning_Module
| changepackage = Yes}}

== Adding a Virtual Server Provisioning Module (Admin/Reseller) Server ==

To set up a '''Virtual Server Provisioning Module (Admin/Reseller)''' server in WHMCS, you '''must''' [https://docs.solusvm.com/Installation%2Bof%2Bthe%2Bmodule.html download the module] and install it according to SolusVM's instructions.

After installation, you can add and configure servers at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.

== Adding a Reseller Product Provisioning Module Server ==

To set up a '''Reseller Product Provisioning Module''' server in WHMCS, you '''must''' [https://docs.solusvm.com/Installation%2Bof%2Bthe%2Bmodule.html download the module] and install it according to SolusVM's instructions.

After installation, you can add and configure servers at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.

== Creating a SolusVM Product ==

You can create a product that provisions accounts on your SolusVM server 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'''.

=== WHMCS Connect ===

This module does not support [[WHMCS Connect]].

==Troubleshooting==

''N/A''

{{modules}}

GoCardless

2022-09-28T14:26:25Z

JuanR: /* Mandates */

== About this Module ==

<div class="docs-alert-success">
We added this payment gateway in WHMCS 7.7.
</div>

[https://gocardless.com GoCardless] is a payment gateway which allows for direct debit payments to be automated electronically.
{{gateways
| onetime = yes
| recurring = yes
| reversals = yes
}}
== Adding the GoCardless Payment Gateway ==

To set up the GoCardless payment gateway in WHMCS:

# Make certain that your WHMCS installation uses an HTTPS-secured connection. If you do not, this payment gateway will not function. You can purchase an SSL certificate [https://www.whmcs.com/ssl-certificates here].
# Go to the appropriate location for your version of WHMCS:
#* For WHMCS 8.6 and later, go to '''Addons > [[Apps and Integrations|Apps & Integrations]]''' or '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > 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 '''GoCardless'''. A GoCardless login page will appear.
# Either sign up for a new account or log in to your existing account. The system will automatically configure GoCardless for you.
# Optionally, enter a custom name for the gateway for each of your supported currencies.
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
#In WHMCS 8.0 and later, enabling '''Charge Date Preference''' will allow the automation system to omit passing a <tt>charge_date</tt> value to GoCardless when the automation system triggers a payment attempt. This results in GoCardless starting the transaction as soon as possible.
# Click '''Save Changes'''.

===Change Date Prefrence===

 '''Change Date Preference''' will determine if WHMCS passes a transaction charge date to GoCardless advising when to initiate the payment.

* Disabling the option will pass through either the '''Next Due Date''' from the service or the <tt>next_possible_charge_date</tt> that GoCardless sets using the <tt>charge_date</tt> function depending on which date is later.

* If you enable the option, the system will not pass a <tt>charge_date</tt> value to GoCardless and this will result in GoCardless beginning the payment process as soon as possible.  In both scenarios, the payment attempt call to GoCardless will not occur until an invoice meets the invoice and payment capture attempt criteria that you set at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]'''.

To process the payment prior to the '''Next Due Date''' date and according to the '''Process Days Before Due''' date at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''', enable this setting. If you do not, the system may attempt the payment on or after the '''Next Due Date''' date.

=== Supported Currencies ===

GoCardless only support the following currencies:

* AUD
* CAD
* DKK
* EUR
* GBP
* NZD
* SEK
* USD <div class="docs-alert-info">We added support for USD in WHMCS 7.9.</div>

Clients who do not use one of these currencies cannot make payments using GoCardless.

=== Test Mode ===

You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.

==Payment Workflow==

When the first payment is made, a mandate is set up with the client's bank. This typically takes a few days, so the invoice will change from '''Unpaid''' to '''Payment Pending''' status. At this point, you can view the mandate details and expected payment completion date by viewing the invoice. As soon as the mandate is set up and the first payment has cleared, the invoice's status will change to '''Paid''' and the service will be provisioned by WHMCS automatically.

When the renewal invoice is generated for a recurring service, a capture attempt will be made against the mandate in accordance with '''Process Days Before Due''' in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''. As it can take a few days for the payment to complete, we recommend a setting of '''3'''. This way, 3 days before the invoice '''Due Date''', the payment process will be initiated by the cron and the invoice status updated from '''Unpaid''' to '''Payment Pending'''. Payment should then complete on the invoice '''Due Date''' and the invoice will be marked '''Paid''' once the payment has cleared.

Once a mandate has been created, WHMCS can use it for processing renewal payments for any other services associated with the client as long as they are set to the GoCardless gateway as well.

When making a manual payment, customers are able to select to use a previously stored bank account or enter a new one.

Customers never leave your WHMCS installation during checkout or adding/removing a new bank account. Personal bank information is submitted directly to GoCardless and is never stored in your local WHMCS installation.

==Reversed Payments==

The Direct Debit Guarantee scheme allows the payee to file a claim for any payment taken in error. WHMCS will monitor for ''charged_back'' events from GoCardless and will automatically process these as appropriate.

To learn more, visit [[Payment Reversals]]

==Refunding Payments==

While refunds with GoCardless are not directly supported from within WHMCS, they can still be processed directly with GoCardless on a case-by-case basis through their review and approval process.

Please refer to the [https://support.gocardless.com/hc/en-ca/articles/210536269-Refunding-payments refunding payments] section of the GoCardless documentation.

== Mandates ==

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

=== Reinstating Mandates ===

<div class="docs-alert-warning">
Reinstating mandates requires specific permission from GoCardless.
</div>

When a mandate has been accidentally cancelled, WHMCS can initiate steps to reinstate the mandate without having the client set it up again.

To do this:

# 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'''.
# Click the '''Manage Existing Gateways''' tab.
# Click '''Manage Cancelled Mandates'''.
# Follow the instructions in the modal that appears to reinstate a cancelled mandate.

=== Importing Existing Mandates ===

<div class="docs-alert-info">
You must disable any automatically-charged mandates that you import in order to prevent possible duplicate charges.
</div>

You can import mandates that you set up outside of WHMCS and associate them with a client.

To do this:

# 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'''.
# Click the '''Manage Existing Gateways''' tab.
# Click '''Import Existing Mandates'''.
# Follow the instructions in the modal that appears to import a active mandate to a specific client.

=== Removing Mandates ===

You can remove mandates by deleting the client's GoCardless [[Pay_Methods|pay method]].

To do this:

# Click on the pay method in the '''[[Clients:Summary_Tab|Summary]]''' tab of the client profile.
# Click '''Delete''' to [[Clients:Summary_Tab#Removing_Card_Details|remove the pay method]] and any associated mandates.

== Reconfiguring Callbacks ==

After moving WHMCS, you must perform the following steps:

# 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'''.
# Click '''Configure GoCardless Account Connection'''.
# Log in again using the same details.

This ensures that GoCardless stores and uses the new system URL and gateway callback file URL.

== Troubleshooting ==

''N/A''

{{modules}}

Mail Tab

2022-09-15T13:05:14Z

JuanR: /* Configuring a Mail Provider in WHMCS 8.0 and later */

{{General Settings}}<br/>

The '''Mail''' tab allows you to configure how [[Messages/Emails|emails and messages]] function in WHMCS.

You can access this 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'''.

===Mail Type or Mail Provider===

Use the '''Mail Type''' or '''Mail Provider''' settings, depending on your WHMCS version, to choose how your installation sends mail. The mail provider you choose can affect your mail deliverability and offers different levels of security through different providers.

====Configuring a Mail Provider in WHMCS 8.0 and later====

For WHMCS 8.0 and later, '''Mail Provider''' displays your selected mail provider. To change and configure it:

# Click '''Configure Mail Provider'''.
# Choose a '''Mail Provider''' from the menu.
# Enter the information for your chosen provider:
#* '''PHP Mail (default)''' — Choose an encoding type from '''Mail Encoding'''. We recommend the ''8bit'' encoding type unless you are experiencing character display issues with your [[Localisation_Tab#System_Charset | system character set]].
#* '''SMTP''' — Enter the indicated information:
#** Select a '''Mail Encoding''' type.
#** Select a service provider. If you choose ''Google'', see [https://help.whmcs.com/m/system/l/1277316-setting-up-google-as-your-mail-service-provider Setting Up Google As Your Mail Service Provider].
#** Enter an SMTP host. If you chose ''Google'' as your service provider, make certain to use <tt>smtp.google.com</tt>.
#** Enter the port on which your SMTP server operates. The port varies depending on the SSL type and your mail server configuration. Check with your mail server administrator for the appropriate port to use. These are the most commonly-used ports by SSL type:
#***None: 25 or 26
#***SSL: 465 or 587
#***TLS: 587
#** Select an authentication type. ''Oauth2'' is only available if you selected ''Google'' for '''Service Provider'''.
#** Enter your authentication information. This depends on your chosen service provider and authentication type.
#** Specify whether to use a secure connection when communicating with your mail server using the '''SMTP SSL Type''' menu. Changes to this option will usually also require changing the '''SMTP Port''' value.
#** Check '''Debugging''' if you want to log debugging output at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]'''.
#* '''MailGun''' — Select a region, and then enter your sending domain and MailGun API key.
#* '''Microsoft''' — Enter your authentication information.
#** In order to use Microsoft® email services, you '''must''' set '''Friendly URLs''' to ''Friendly index.php'' or ''Full Friendly Rewrite'' in the '''[[General Tab|General]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings'''.
#** For complete setup steps, see [https://help.whmcs.com/m/system/l/1600738-setting-up-microsoft-as-your-mail-service-provider Setting Up Microsoft As Your Mail Service Provider].
#** Check '''Debugging''' if you want to log debugging output at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]'''.
#** This mail provider is only available in WHMCS 8.6 and later.
#* '''SendGrid''' — Enter your API key.
#* '''SparkPost''' — Select a SparkPost account and enter a SparkPost API key. Check '''Use Sink Testing''' to allow you to check email sending without actually sending emails.
# Click '''Test Configuration'''. The system will send an email to test your configuration. If the test doesn't succeed, you will see an error.
# Click '''Save'''. The system will send an email to test your configuration, and it won't save your changes unless the test is successful.

====Configuring a Mail Type in WHMCS 7.x and earlier====

For version 7.x and earlier, use '''Mail Type''' to choose one of these options:

* Use '''PHP Mail''' to send emails from inside WHMCS. This requires no further configuration, but some email providers may treat email sent this way with increased suspicion.
* Use your SMTP server to send emails. The related '''SMTP''' fields are required.
** In '''SMTP Port''', specify the port on which your SMTP server operates.
*** This will usually vary depending on the SSL type and your particular mail server configuration.
*** Check with your mail server administrator for the appropriate port to use. These are the most commonly-used ports by SSL type:
****None: 25 or 26
****SSL: 465 or 587
****TLS: 587
** Use the '''SMTP SSL Type''' setting to specify whether a secure connection is used when communicating with your mail server. Changes to this option will usually also require changing the '''SMTP Port'''.

==== Mail Providers and Mail Types ====

WHMCS supports the following mail providers:

* PHP Mail
* SMTP (with OAuth2 authentication via Google in WHMCS 8.0 and later)
* MailGun (WHMCS 8.0 and later)
* Microsoft (WHMCS 8.6 and later)
* SendGrid (WHMCS 8.0 and later)
* SparkPost (WHMCS 8.0 and later)

===== PHP Mail =====

When you choose ''PHP Mail'', you won't need to configure any additional settings. PHP Mail is more likely to be considered spam by spam filtering applications.

===== SMTP =====

''SMTP'' uses an SMTP server to send email. You will need to retrieve the SMTP configuration information from your control panel or hosting provider or from Google. The requirements depend on the authentication type you choose.

WHMCS 8.0 and later includes support for Google email. This includes OAuth2 to authorize app or service access and is more secure than traditional username-and-password authentication.

<div class="docs-alert-info">
For steps to set up Google and the required Google app, see [https://help.whmcs.com/m/system/l/1277316-setting-up-google-as-your-mail-service-provider Setting Up Google As Your Mail Service Provider].
</div>

===== Microsoft =====

WHMCS 8.6 and later includes support for all Microsoft Azure® apps, like Hotmail®, Microsoft Outlook®, Microsoft 365®, Skype®, and several others. This includes OAuth2 to authorize app or service access and is more secure than traditional username-and-password authentication.

For steps to set up Microsoft and the required Microsoft Azure app, see [https://help.whmcs.com/m/system/l/1600738-setting-up-microsoft-as-your-mail-service-provider Setting Up Microsoft As Your Mail Service Provider].

===== MailGun, SendGrid, and SparkPost =====

[https://www.mailgun.com MailGun], [https://www.sendgrid.com SendGrid], and [https://www.sparkpost.com SparkPost] are email service providers that allow you access to tools for improved mail deliverability and email validation.

To set this up, enter your information from your email service provider, including the API key.

===== Custom Modules =====

You can extend the selection of mail providers with custom modules. For more information, consult our [https://developers.whmcs.com/mail-providers/ Mail Providers developer documentation].

===Disable Email Sending===

<div class="docs-alert-warning">
We added this setting in WHMCS 8.1.
</div>

Set the toggle to '''ON''' to stop WHMCS from sending any outgoing email. For more information, see [[Disabling Outgoing Mail]].

We recommend that you only enable this setting when you are testing updates or customizations on a development installation or while troubleshooting. The system creates a log entry at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > [[System Logs]]''' or, prior to WHMCS 8.0, '''Utilities > Logs''' whenever you enable or disable this setting.

===Disable RFC3834 Headers===

Set the toggle to '''ON''' to stop WHMCS from including [https://tools.ietf.org/html/rfc3834 RFC 3834] headers in outgoing support emails. These headers prevent circular responses when both the sender and destination are using autoresponders.

<div class="docs-alert-warning">
We added this setting in WHMCS 8.1. In WHMCS 8.1 and later, WHMCS sends support emails with RFC 3834-compliant headers by default.
</div>

Regardless of the option that you choose for this setting, email piping and email importing won't import email that contains the <tt>Auto-Submitted</tt> header.

===Global Email Signature===

Enter the text to be appended to all emails sent to customers by WHMCS containing the <tt>{$signature}</tt> merge field. HTML can be used here.

===Global Email CSS Styling===

Enter the CSS code to be used to format every email template sent to clients by WHMCS.

For more information and the default content, see [[Email Styling]].

===Global Email Header Content===

Content entered in this field will be displayed at the top of every email template sent to clients. HTML can be used here.

For more information and the default content, see [[Email Styling]].

===Global Email Footer Content===

Content entered in this field will be displayed at the bottom of every email template sent to clients. HTML can be used here.

For more information and the default content, see [[Email Styling]].

===System Emails From Name===

The sender name that will appear on all emails sent to staff by WHMCS.

For example, these emails include '''Cron Job Activity''', '''New Order Notification''', and '''Automation Success/Failure Notifications'''.

===System Emails From Email===

The email address that will appear on all emails sent to staff by WHMCS. This address does not necessarily have to exist (for example, <tt>noreply@yourcompany.com</tt>).

===BCC Messages===

An email address entered here will receive a blind carbon copy of all emails sent to customers by WHMCS.

===Presales Form Destination OR Presales Contact Form Email===

The department or email address that will receive messages sent via the pre-sales contact form.

Helm 4

2022-08-16T11:36:11Z

JuanR: /* About this Module */

== About this Module ==
<div class="docs-alert-info">
The Helm module is only compatible with the discontinued server control panel (not the Kubernetes® package manager).
</div>
<div class="docs-alert-success">
For our other Helm module, see [[Helm 3]].
</div>
The Helm 4 module allows you to add and manage Helm 4 servers in WHMCS.
{{Provisioning_Module
| changepackage = Yes
| clientarealink = Yes
| port = 8086}}

== Adding a Helm 4 Server ==

To set up a Helm 4 server in WHMCS:

# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
# Click '''Add New Server'''.
# Select ''Helm 4'' from the menu.
# Enter the hostname or IP address and your credentials.
# Click '''Continue'''.
# Enter the additional desired server details.
# If your server uses a different port, check '''Override with Custom Port''' and enter the correct port. For more information, see [[Server Port Overrides]].
# Click '''Save Changes'''.
# If this is the only ''Helm 4'' server that is currently in WHMCS, click on the name and ensure that it results in an asterisk (*) next to it. This indicates that it is the default to use when any other non-specific configuration doesn't apply.

=== Creating a Helm 4 Product ===

You can create a product that provisions accounts on your Helm 4 server 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'''.

To find your role ID:

# Log in to the Helm 4 server.
# Go to '''Account Settings > Customer Account Roles'''.
# Click the Excel download icon to get a list of roles and their IDs.[[Image:Helm1.jpg]][[Image:Helm2.jpg]]
# Enter the necessary role IDs in WHMCS.
# Go to '''Account Settings > My Plans'''.
# Click the Excel download icon to get a list of plans and their IDs. [[Image:Helm3.jpg]] [[Image:Helm4.jpg]]

=== WHMCS Connect ===

This module does not support [[WHMCS Connect]].

==Troubleshooting==

''N/A''

{{modules}}

Helm 3

2022-08-16T11:35:36Z

JuanR: /* About this Module */

Email Importing

2022-08-02T14:54:59Z

JuanR: /* Configuring Email Importing */

Email importing is distinct from email piping and requires a different configuration. We recommend using email importing instead of email piping if you use any control panel other than cPanel or if you want to import email from multiple domains.

Begin by first configuring your support ticket departments. You do this by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Support Departments]]''' or, prior to WHMCS 8.0, '''Setup > Support > Support Departments'''. Add each of your departments and the email address that you assigned to them.

<div class="docs-alert-info">
<strong>RFC 3834</strong><br />
In WHMCS 8.1 and later, the system sends support emails with RFC 3834-compliant headers by default.
* You can disable this at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' in the '''[[Mail Tab|Mail]]''' tab.
* Regardless of your settings, WHMCS will not accept email that contains the <tt>Auto-Submitted</tt> header via email piping or email importing.
</div>

==Email Importing with OAuth==

WHMCS 8.1 and higher introduces support for email importing using OAuth with Gmail. OAuth provides access to your mail provider, and is more secure than traditional username-and-password authentication. Some mail providers are requiring OAuth, or have announced a requirement for it in the future.

To use OAuth for Gmail with WHMCS, you will need to both configure Gmail as your mail service provider and create an app for it in the [https://console.cloud.google.com/getting-started Google Cloud console]. For more information, see [https://help.whmcs.com/m/support_tools/l/1328652-setting-up-pop3-importing-with-oauth-via-google Setting Up POP3 Importing with OAuth via Google].

==Configuring Email Importing==

[[File:Cron piping.png|thumb|The cron command]]

To configure email importing for a support department:

# Set up your email accounts:
#* For email importing with OAuth, configure Gmail as your mail service provider and create an app for it in the Google Cloud console. For help with this step, see our [https://help.whmcs.com/m/support_tools/l/1328652-setting-up-pop3-importing-with-oauth-via-google Setting Up Email Importing with OAuth via Google] documentation.
#* For non-OAuth email importing, create a unique email account on your mail server for each support department. This must be a full inbox; an alias is not sufficient.
# In WHMCS, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Support Departments]]''' or, prior to WHMCS 8.0, '''Setup > Support > Support Departments'''.
# Create a new department and enter the top section of information or, for existing departments, click '''Edit'''.
# Enter the email information for the department.
## Select a '''Service Provider'''. If you want to use OAuth via Gmail, select ''Google''. Otherwise, select ''POP3/IMAP''.
## Enter a '''Hostname''', or, if you selected ''Google'', make sure that <tt>pop.gmail.com</tt> is already set.
## Enter a '''Mail Server Port'''. Usually, this is <tt>995</tt>.
##:<div class="docs-alert-success"><span class="title">Mail Server Port Value</span><br />Entering a port number that requires SSL connectivity (for example, <tt>993</tt> or <tt>995</tt>) will allow the system to automatically attempt to connect using this method.</div>
## Select your '''Authentication''' type. If you want to use OAuth via Gmail, select ''OAuth2''. Otherwise, select ''Password''.
## Fill out the remainder of the form:
##* If you selected ''Password'' as your '''Authentication''' type, enter the email address and password for the email account that you created.
##* If you selected ''OAuth2'' as your '''Authentication''' type, enter your '''Email Address''' and the '''ClientID''' and '''Client Secret''' that you generated through Google. Then, click '''Connect'''.
# Set up a [[Crons#POP_Email_Import_Cron | cron job]] to run the <tt>pop.php</tt> file using the '''Ticket Importing using Mail Importing (POP3/IMAP)''' command at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Support Departments]]''' or, prior to WHMCS 8.0, '''Setup > Support > Support Departments''' every few minutes. We recommend that you set this to run every five minutes.
'''Sample Cron Command'''
<source lang="cli">
*/5 * * * * php -q /home/username/crons/pop.php
</source>

<div class="docs-alert-info">
The system will delete email in the source mailboxes upon successful import into WHMCS.
</div>

OpenSRS

2022-07-14T13:41:14Z

JuanR: /* Partially Loaded Page (Blank or Lost Formatting) */

== 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). [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.
# 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.

== 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}}