<noinclude>[[Version 8.10.0 Release Notes]]</noinclude>

== Implemented ==
FEATURE-3794 - Implement Automation Status Overview and Details for Invoice Auto Cancellations<br />

== Maintenance ==
CORE-19157 - Update WHOIS server listing for .sg TLD<br />
CORE-19163 - Add View Invoices as valid permission to download invoice PDFs<br />
CORE-19178 - Use current time for timestamps created by manual invoice payments<br />

== Modules ==
MODULE-8072 - Update detection of merchant account capabilities performed at onboarding due to changes at PayPal Payments<br />

Version 8.10 Release Notes

2024-04-24T13:56:02Z

SarahK:

Crons

2024-04-24T13:55:58Z

SarahK: /* Task Options for skip and do */

<div class="docs-alert-info">Need to troubleshoot the cron? Check out our [https://help.whmcs.com/m/automation/l/683269-advanced-cron-troubleshooting| Advanced Cron Troubleshooting Guide.]</div>

You must create cron tasks in order to automate tasks within WHMCS.

The cron is a system daemon used to execute tasks at designated times. WHMCS includes processes that must run on a periodic basis via the cron. All of these files are in the <tt>crons</tt> directory.

==Setting up the Cron Tasks==

===System Cron===

The system cron automates tasks within WHMCS. Configure this to use the appropriate frequencies:

<table class="table table-bordered">
<tr><th>Version</th><th>System Cron Frequency</th></tr>
<tr><td>WHMCS 6.3.x and earlier</td><td>Once per day.</td></tr>
<tr><td>WHMCS 7.0 and later</td><td>Every 5 minutes, or as frequently as your hosting provider allows (minimum once per hour).</td></tr>
</table>

'''Sample Cron Command'''
<source lang="cli">
*/5 * * * * php -q /home/username/crons/cron.php
</source>

You can find the correct command to copy-and-paste for your WHMCS installation by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' and clicking on the first badge. Prior to WHMCS 8.0, visit '''Setup > Automation Settings'''.

[[File:Cron-configuration-badge.png|border]]

<div class="docs-alert-success">Most hosting control panels provide a simple user interface for creating cron jobs. For more information, see [[Cron Configuration]].</div>

===Domain Sync Cron===
<div class="docs-alert-warning"><i class="fa fa-question-circle"></i>This cron task is only required in WHMCS 7.5 and earlier. Remove it in WHMCS 7.6 and later.</div>

This cron task monitors incoming domain transfers and synchronises expiry date changes made directly at a registrar. We only recommend running this every few days. More information is available at [[Domains_Tab#Domain_Sync_Enabled|Domain Sync Enabled]] and [[Domain Synchronisation]].

'''Sample Cron Command'''
<source lang="cli">
0 3 */2 * * php -q /home/username/crons/domainsync.php
</source>

The above example will run at 3 a.m. every two days.

===POP Email Import Cron===

This cron task is only required if you wish to import emails to the support queue via the POP3 protocol. (We recommend using [[Email Piping]] instead.) If you use this, configure it to run every five minutes.

'''Sample Cron Command'''
<source lang="cli">
*/5 * * * * php -q /home/username/crons/pop.php
</source>

The above example will run the POP3 email import task every five minutes.

===Change of Daily Cron Hour===

You can change the time at which the daily automated actions run using the '''Time of Day''' setting. For more information, see [[Automation Settings]].

WHMCS uses the PHP <tt>now()</tt> timestamp when the <tt>cron.php</tt> script runs. This determines the current '''Time of Day''' based on the value that the PHP configuration returns applied to the <tt>cron.php</tt> execution.

We recommend executing the cron task every 5 minutes. WHMCS will never perform a particular task more frequently than [[Crons#Task_Options_for_skip_.26_do Crons - Task Options for skip|they are listed here]]. You can set the <tt>cron.php</tt> file to run every 5 minutes without any duplication.

If you only want to execute <tt>cron.php</tt> at the "Time of Day" hour, ensure that WHMCS's configured time zone matches the server's time zone. For more information, see [[Changing_Timezone]].

<div class="docs-alert-warning">The cron must execute the <tt>cron.php</tt> file within the hour that you set in WHMCS's automation settings. If it does not, the daily automated tasks will not run.</div>

==Secure The crons Directory==

You can move the <tt>crons</tt> folder to any location above or below the document root.

<div class="docs-alert-warning">We recommend moving it to a private directory above your document root. This helps to prevent access by bad actors.</div>

For more information, see [https://help.whmcs.com/m/installation/l/1650302-moving-the-crons-directory Moving the Crons Directory].

==System Cron==

The system cron (<tt>crons/cron.php</tt>) automates tasks within WHMCS. This script can run with several optional values. This allows very specific control of the tasks that run and the script's output. Most WHMCS installations only require an entry that invokes the system cron script (<tt>crons/cron.php</tt>).

===Input===

The system cron script has the following argument input structure:

<source lang="cli">
cron.php [<argument> [options]]
</source>

The script also provides backwards capability for input options available prior to WHMCS 7.1:

<source lang="cli">
cron.php [legacy_option_flags]
</source>

Mixing legacy option flags with the current argument structure is '''not''' supported and will '''not''' work.

===Arguments===

The <tt>cron.php</tt> script includes three essential arguments:

* <tt>all</tt> — Attempt to perform all due automation tasks. If you do not provide input, this argument is applied by default.
* <tt>skip</tt> — Perform all tasks (in the same way as the <tt>all</tt> argument) but exclude tasks that you specify.
* <tt>do</tt> — Only perform the tasks that you specify.

There are two supporting arguments:

* <tt>help</tt> — Lists help and options for the argument you specify.
* <tt>list</tt> — Lists all possible arguments.

===Options===

Each argument has its own set of options, which you can view using <tt>help <argument></tt>.

====Additional Options====

* -F, --force
** Force the execution of tasks, regardless of "due" or "in progress" state
* -v, -vv, -vvv
** Verbosity of command line output
* --email-report=[1|0]
** Force send a digest report of work performed during execution. During the normal "daily" run, this is set to an implicit value of "1". In all other cases, the implicit value is "0"
* -V, --version
** Output the WHMCS version and exits
* --no-ansi
** Strip any non-printing command line markup (used for color output)
* -h, --help
** Print help for a command; same as the '''help''' command itself

===Output===

The System Cron will not generate any success console output by default. Use the verbosity options if you require progressive completion information while attending the manual execution of System Cron invocation.

The System Cron will, by default, generate a Digest Email Report when performing the "Daily" group of tasks. This report can be forcibly generated for any particular invocation with the ''--email-report=1'' report. The Digest Email Report will only contain information related to that execution and will not contain aggregate information from prior executions. Please visit the [[Automation Status]] page in your Admin area to get an overview of daily aggregated work.

===Tasks===

All routines of system cron (''cron.php'') are tasks. Most tasks are daily, and should only be run once a day. Some tasks benefit from running multiple times a day, such as ticket escalations or checking for WHMCS Updates. Other tasks should only run once a month, such as calculating overage usage and generating the respective invoices.

====Task Options for '''skip''' and '''do'''====

<div id="Option_Flags" style="visibility: hidden"></div>
When performing a '''skip''' or '''do''' command, you can itemize which tasks are excluded or included respectively.
Below is a table that itemizes these task options, as well as their normal frequency.

{| class="table"
|-
! scope="col" style="width:30%"| Option
! scope="col" style="width:20%"| Legacy Option
! scope="col" style="width:40%"| Description
! scope="col" style="width:10%"| Frequency
|-
| --AddLateFees
| latefees
| Apply Late Fees
| Daily
|-
| --AffiliateCommissions
| affcommissions
| Process Delayed Affiliate Commissions
| Daily
|-
| --AffiliateReports
| affreports
| Send Monthly Affiliate Reports
| Monthly
|-
| --AutoClientStatusSync
| clientstatussync
| Synchronise Client Status
| Daily
|-
| --AutoPruneTicketAttachments
| n/a
| Auto Remove Inactive Ticket Attachments. Batches of 1000
| Hourly
|-
| --AutoSuspensions
| suspensions
| Processing Overdue Suspensions
| Daily
|-
| --AutoTerminations
| terminations
| Process Overdue Terminations
| Daily
|-
| --CancellationRequests
| cancelrequests
| Process Cancellation Requests
| Daily
|-
| --CheckForWhmcsUpdate
| n/a
| Check for WHMCS Software Updates
| As soon as every 8 hours
|-
| --CloseInactiveTickets
| closetickets
| Auto Close Inactive Tickets
| Daily
|-
| --CreateInvoices
| invoices
| Generate Invoices
| Daily
|-
| --CreditCardExpiryNotices
| ccexpirynotices
| Sending Credit Card Expiry Reminders
| Monthly
|-
| --CurrencyUpdateExchangeRates
| updaterates
| Update Currency Exchange Rates
| Daily
|-
| --CurrencyUpdateProductPricing
| updatepricing
| Update Product Prices for Current Rates
| Daily
|-
| --DatabaseBackup
| backups
| Create a database backup and deliver via FTP or email
| Daily
|-
| --DataRetentionPruning
| n/a
| Process data retention pruning operation. 7.5+
| Daily
|-
| --DomainRenewalNotices
| domainrenewalnotices
| Processing Domain Renewal Notices
| Daily
|-
| --DomainStatusSync
| n/a
| Processing Domain Status Syncing for Active domains. Batches of 50. Known as DomainExpirySync in 7.7 and earlier
| As soon as every hour
|-
| --DomainTransferSync
| n/a
| Processing Domain Transfer Syncing for Pending Transfer domains
| As soon as every hour
|-
| --EmailCampaigns
| n/a
| Update the status of Email Campaigns and schedule emails. Batches of 50
| As soon as every 5 minutes
|-
| --EmailMarketer
| emailmarketing
| Process Email Marketer Rules
| Daily
|-
| --FixedTermTerminations
| fixedtermterminations
| Process Fixed Term Terminations
| Daily
|-
| --InvoiceAutoCancellation
| n/a
| Automatically cancel old overdue unpaid invoices. 8.10+
| Daily
|-
| --InvoiceReminders
| invoicereminders
| Generate daily reminders for unpaid and overdue invoice
| Daily
|-
| --OverageBilling
| overagesbilling
| Process Overage Billing Charges and Generate Invoices
| Monthly
|-
| --ProcessCreditCardPayments
| ccprocessing
| Process Credit Card Charges
| Daily
|-
| --ProcessEmailQueue
| n/a
| Process scheduled emails within Email Campaigns. Batches of 25
| As soon as every 5 minutes
|-
| --ServerRemoteMetaData
| n/a
| Auto Update Server Meta Data. Displayed on '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''. 7.8+
| Hourly
|-
| --ServerUsageCount
| n/a
| Auto Update Server Usage Count. Displayed on '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''. 7.8+
| Hourly
|-
| --SslReissues
| n/a
| Process MarketConnect SSL certificate reissuances. 8.5+
| Daily
|-
| --SslSync
| n/a
| Check validity of SSL Certificates on services and domains. Batches of 100. 7.7+
| Daily
|-
| --TenantUsageMetrics
| n/a
| Auto Update Service Usage Data. Displayed when viewing Service within Client Area. 7.9+
| Twice-daily
|-
| --TicketEscalations
| escalations
| Process and escalate tickets per any Escalation Rules
| As soon as every 3 minutes
|-
| --UpdateDomainExpiryStatus
| n/a
| Update Domain Expiry Status for domains with a past Expiry Date
| Daily
|-
| --UpdateServerUsage
| usagestats
| Updating Disk & Bandwidth Usage Stats
| Daily
|-
|}

====Types====

There are two types of tasks:
* '''Application''': Advances state of client data, such as orders, billing, and provisioning
* '''System''': Provides software related functionality, such as generating backups or performing database normalization.
** The "DatabaseBackup" task is the only task option of the '''System''' type which can be included/excluded from execution. All other '''System''' type task options will be performed explicitly as required by WHMCS and thus do not have option flags.

====Tasks & --force Option====

The "--force" option does exactly that...it will force execute ''any'' application tasks (respective of the command ['''all''', '''skip''', '''do''']) regardless if the task is suppose to run once a day, a month, or at a time other than now.

* The '''all''' command with the "--force" flag will execute all application tasks, as if each one were due exactly now.
* The '''skip''' command with the "--force" will first exclude the specified tasks (i.e., the ones provided as task option flags) and then operate on all other tasks as if each were due exactly now, similar to the '''all''' command.
* The '''do''' command is designed to only run the tasks specified (i.e., the ones provided as task option flags) and to run them immediately, thus the "--force" option is always implied and is not a valid option.
* The "--force" option has no effect on '''System''' type tasks (except "DatabaseBackup")
* The "--force" option has no effect on whether the Daily Digest Email Report is sent, that is controlled via the --email-report option.

<div class="docs-alert-info">Passing arguments to PHP scripts requires the <tt>register_argc_argv</tt> directive to be enabled.</div>

====Advanced Task Scheduling====

In some environments or use-cases, having fine-grained control of one or more tasks is important. This is possible through a combination of multiple '''do''' and '''skip''' crontab entries.
Tasks performed as part of a '''do''' command will not have their internal scheduling tracking modified. This is to ensure the integrity of a normal invocation of the System Cron.
If you want a particular task to only execute on a particular schedule, create a '''do''' command for that task and alter your main System Cron invocation to '''skip''' that task (all other non-itemized tasks will be performed on the WHMCS schedule in this '''skip''').
Likewise, if you never wish to have a particular task executed, alter your System Cron entry to be a '''skip''' command with the option for that particular task.

===Hook Points===

The System Cron has six hook events:

* PreCronJob
** Fires only during the daily cron run
** Is invoked before any tasks are executed
** Registered hooks receive no parameter arguments
* PreAutomationTask
** Is invoked before each Application task
** Registered hooks receive one parameter argument:
*** The task object that is about to be executed, which adheres to WHMCS\Scheduling\Task\TaskInterface
*** The return value of this hook is not inspected. However, if an exception is thrown, the task will not be executed, be marked as incomplete, and iteration to the next task will commence
* PostAutomationTask
** Is invoked after each Application task
** Registered hooks receive two parameter arguments:
*** The task object that was just executed, which adheres to WHMCS\Scheduling\Task\TaskInterface
*** The boolean state if the task executed without throwing an Exception
*** The return value of this hook is not inspected. Any Exception thrown will be discarded
* DailyCronJobEmail
** Fires during the daily cron run or when --email-report=1 is specified
** Is invoked after all Application tasks are executed, immediate prior to the DailyCronJob hook
** If a registered hook returns true, the digest email report will not be sent
** Registered hooks receive no parameter arguments
* DailyCronJob
** Fires only during the daily cron run
** Is invoked after all Application tasks are executed, immediate proceeding the DailyCronJobEmail hook
** Register hooks receive no parameter arguments
* AfterCronJob
** Fires each time cron is invoked
** Is invoked after all Application & System tasks are executed, just prior to script termination
** Registered hooks receive no parameter arguments

===Example Crontab Entries===

Below are examples that demonstrate the flexibility of the System Cron input options and how you could craft your crontab entry. For most WHMCS installation, you should just have one entry (Ex. 1).
If you wish to disable certain tasks entirely, consider looking at the related functionality's documentation first to understand how your may be able optimize your WHMCS settings from the administration area and potential avoid unnecessary crontab entries.

Ex 1. Standard System Cron entry:

<source lang="cli">
*/5 * * * * php -q /path/to/cron.php
</source>

Ex 2. Explicit entry to perform all scheduled task if they are due (will behave the same as Ex. 1):

<source lang="cli">
*/5 * * * * php -q /path/to/cron.php all
</source>

Ex 3. Always skip sending domain renewal notices, but perform all other tasks as normal if they are due:

<source lang="cli">
*/5 * * * * php -q /path/to/cron.php skip --DomainRenewalNotices
</source>

Ex 4. Always skip ticket escalations and auto suspensions. Process ticket escalations Monday-Friday during business hours, at the top of the hour, and auto suspension Monday-Friday at the start of business:

<source lang="cli">
*/5 * * * * php -q /path/to/cron.php skip --TicketEscalations --AutoSuspensions
0 9,10,11,12,13,14,15,16 * * 1-5 php -q /path/to/cron.php do --TicketEscalations
0 9 * * 1-5 php -q /path/to/cron.php do --AutoSuspensions
</source>

Ex 5. In some hosting environments, direct crontab entries are not permitted. The System Cron can be invoked through an HTTP request (provided the script is accessible within the docroot)
The follow demonstrates performing all tasks except DomainRenewalNotices and TicketEscalations

<source lang="cli">
GET http://www.example.com/admin/cron.php?command=skip&options=DomainRenewalNotices,TicketEscalations
</source>

==Legacy Cron File Locations==

Prior to WHMCS version 6, the automated task files were located across various directories. From WHMCS version 6 onwards all cron files are now located in the '''crons''' directory by default.

To aide in the transition process to their new locations, version 6.0 of WHMCS includes proxy files in the old locations that will allow all existing configured cron and piping commands to continue operating without any changes post-upgrade to 6.0.

However, we encourage you to update your cron and piping commands to use the new locations prior to updating to Version 8.0.

The old locations are deprecated as of Version 6.0, and the proxy functionality is removed as of version 8.0. The proxy files and their proxy locations are:

* <tt>/admin/cron.php</tt>
* <tt>/pipe/pipe.php</tt>
* <tt>/pipe/pop.php</tt>

<div class="docs-alert-info">If you do not require these proxy files, you can safely remove them from your installation.</div>

Automation Status

2024-04-24T13:55:56Z

SarahK: /* Available Information */

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

The Automation Status page gives you insights and information about the daily automation activity that occurs in WHMCS. It provides a way of viewing and monitoring automation activity over time, allowing you to see trends and identify any issues more easily.

You can access this feature at '''Utilities > Automation Status''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

You can also access it by clicking any summary graph shown in the '''Automation Overview widget''' on the [[Admin Dashboard|admin dashboard]] or, in WHMCS 8.0 and later, by clicking the cog (<i class="fa fa-cogs" aria-hidden="true"></i>) icon at the top of the [[Admin Area]].

==How to use it==

This page displays a summary of invoice generation activity for the last 7 days and the results and totals from the current day's automation tasks.

You can browse to earlier days by using the arrow keys or selecting a date from the calendar.

[[File:AutomationStatusPage.png]]

<div class="docs-alert-info">
Historic automation activity information will only start being recorded from the day you upgrade to WHMCS 7.1 or later.
</div>

==Available Information==

The page details items completed by a cron run for the selected date:

* '''Invoices''' — The total number of invoices generated.
* '''Late Fees''' — The total number of late fees applied to invoices.
* '''Credit Cards''' — The total number of successful and declined credit card attempts.
* '''Invoice & Overdue Reminders''' — The total number of any invoice and overdue reminders sent.
* '''Cancellation Requests''' — The total number of any processed cancellation requests. This also details the failed requests.
* '''Overdue Suspensions''' — The total number of successful and failed suspensions.
* '''Overdue Terminations''' — The total number of successful and failed terminations.
* '''Fixed Term Terminations''' — The total number of terminations defined by a product configuration.
* '''Overdue Invoice Cancellation''' — The total number of overdue unpaid invoices that the system cancelled.
* '''Domain Renewal Notices''' — The total number of any domain renewal emails sent.
* '''Inactive Tickets''' — The total number of inactive tickets closed.
* '''Delayed Affiliate Commissions''' — The total number of commissions applied.
* '''Email Marketer Rules''' — The total number of emails sent for the marketer.
* '''Database Backup''' — Whether the system set up the database backup.
* '''WHMCS Updates''' — Whether checking for updates was successful.
* '''Currency Exchange Rates''' — Whether the currency exchange rate updated successfully.
* '''Product Pricing Updates''' — Whether product pricing updated successfully.
* '''Server Usage Stats''' — Whether the usage information updated successfully.

==Failed Actions==

If you see a number marked as failed items, this indicates some items failed to complete successfully.

In the case of credit card captures declining, these will be retried automatically based upon your settings defined in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.

For failure items relating to Suspensions, Terminations, Cancellations, etc..., these will be retried daily until successful. They will also be added to the Module Queue from where you can view and resolve them. See the [[Module Queue]] page for more information.

==Historic Data and Trends==

The graph allows you to view a number of the task metrics over time.

By default the current week is displayed showing the number of invoices generated each day. You can choose other metrics and also choose from timeline options including the previous week, this month and last month.

Historic data is purged periodically.

[[File:automation-status-graph-new.png|600px]]

== Cron Task Reporting ==

<div class="docs-alert-info">
This section describes features available in version 7.10 and above.
</div>

From the first daily cron run after upgrading to WHMCS 7.10, detailed information about actions completed will be saved and available in WHMCS.

From the Automation Status Page clicking on the Cron Task boxes will open a modal that will detail the actions that completed successfully or failed with a link to the appropriate location in WHMCS.

[[File:CronTaskAutomationModal.png]]

The following table lists the cron tasks that have additional detail:

{| class="table table-striped"
! Task Name
! Logs
! Additional Links
! Notes
|-
| Invoices
|| A list of invoices generated via the cron run
||
*To Invoice using ID and Edit icon
*To client using client name
|| The invoice status is the current invoice status
|-
| Invoice & Overdue Reminders
|| A list of reminders sent separated by type
||
*To Invoice using ID and Edit icon
*To client using client name
|| The invoice status is the current invoice status
|-
| Late Fees
|| A list of invoices that had a late fee added
||
*To Invoice using ID and Edit icon
*To client using client name
|| The invoice status is the current invoice status
|-
| Credit Card Charges
|| A list of attempted payments whether successful or failed
||
*To Invoice using ID and Edit icon
*To client using client name
|| The invoice status is the current invoice status
The error message is the latest decline reason
|-
| Cancellation Requests
|| A list of services that had a cancellation request processed separated by success and failure
||
* To Invoice using ID and Edit icon
* To client using client name
* To the [[Module Queue]] for the failed task if unresolved
|| The status is the current status of the service
The error message is message that occurred on cron run.
|-
| Overdue Suspensions
|| A list of suspensions attempted separated by success and failure
||
*To the service/addon using the ID and Edit icon
*To the client using client name
*To the [[Module Queue]] for the failed task if unresolved
||
*The status is the current status of the service/addon
*The error message is message that occurred on cron run.
|-
| Overdue Terminations
|| A list of terminations attempted separated by success and failure
||
*To the service/addon using the ID and Edit icon
*To the client using client name
*To the [[Module Queue]] for the failed task if unresolved
||
*The status is the current status of the service/addon
*The error message is message that occurred on cron run.
|-
| Fixed Term Terminations
|| A list of fixed term terminations attempted separated by success and failure
||
*To the service/addon using the ID and Edit icon
*To the client using client name
*To the [[Module Queue]] for the failed task if unresolved
||
*The status is the current status of the service/addon
*The error message is message that occurred on cron run.
|-
| Domain Renewal Notices
||A list of domains that a renewal notice was sent for. Separated into first to fifth and also lists emails that failed to send
||
* To Domain using ID and Edit icon
* To client using client name
||The status is the current status of the domain
|-
| Inactive Tickets
|| A list of tickets automatically closed due to inactivity
||
* To Ticket using ID and Edit icon
* To client using client name (if a registered client)
|| The status is the current status of the ticket
|-
| Client Status Update
|| A list of clients updated separated by status being set
|| To the client using the id, client name, and edit icon
|| The status is the current status of the client
|}

Automation Settings

2024-04-24T13:55:53Z

SarahK: /* Enable Auto Cancellation */

The '''Automation Settings''' allow you to configure all of WHMCS's automated processes. This includes suspensions, unsuspensions, terminations, how far in advance the system generates invoices, and when the system sends overdue notices. It's the one central place that controls everything that the daily automation tasks do.

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

To trigger the daily automation tasks, you must configure a [[Crons|Cron Job]] at a recommended frequency of every 5 minutes. This is usually part of the initial installation of WHMCS.

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=Yk3-Ud0jITc&list=PLfpgUwyOgC7C4wwPhB7jEqSp_esXB31Jb&index=5&t=0s|Watch Video Tutorial]]

==Scheduling==

===Time of Day===
[[File:Time of Day.png|thumb|Time of Day]]
This setting allows you to select the hour in which you'd like WHMCS to perform all daily automation tasks. To function properly, this setting depends on configuring your cron job to run at least once every hour. We recommend setting it to run every 5 minutes to allow other system processes, such as checking for updates, to take place.

==Automatic Module Functions==
[[File:Automatic Module Functions.png|thumb|Automatic Module Functions]]
These settings pertain to your customer’s products or services and how the system handles non-payment.

===Enable Suspension===
Selecting this option will enable automatic suspensions when payments for products or services are overdue. The setting below (Suspend Days) controls the amount of time between your customer becoming overdue and when the system suspends them.

===Suspend Days===
If you enabled Enable Suspension, this configures the amount of time between a customer's product or service becoming overdue and the system suspending them.

===Enable Unsuspension===
When you enable this setting, services that the system suspended due to "Overdue on Payment" will automatically become unsuspended when they pay the unpaid invoice for the item. However, if you suspended products or services manually, and assigned a custom reason for suspension, then an automatic reactivation will not occur. For example, you may have manually suspended an item with a reason of "Broken Terms of Service" or "Awaiting ID Verification".

===Enable Termination===
Enable this option to terminate the client's service (remove it from the server) according to the setting below (Termination Days).

===Termination Days===
If you selected Enable Termination, this determines the number of days between a product or service becoming overdue and the system terminating that product or service.

==Billing Settings==
[[File:Billing Settings.png|thumb|Billing Settings]]
Use these settings to determine how the system generates invoices and sends payment reminders to your customers. Setting the Unpaid and Overdue Reminder settings to <tt>0</tt> will prevent the system from sending the related emails.

===Invoice Generation===
This is the number of days before the system will generate due date invoices. For example, if this setting is <tt>7</tt>, the system will generate an invoice seven days before the due date for products, services, addons, and domains. The number of days should be an integer of <tt>0</tt> or more.

====Per Billing Cycle Settings====
By clicking '''Advanced Settings''', you can specify a different invoice generation setting for each billing cycle. For example, you may want the system to generate invoices for monthly services seven days in advance and generate invoices for annual services 14 days in advance.

====Domain Invoice Generation====
This optional setting allows you to specify how far in advance to generate domain renewal invoices. You can use this if you want to give a longer time between invoice generation and the due date for domain invoices. This is particularly useful when you don't accept payments online and more time might be necessary to avoid domain expiration.

Leave this setting blank if you want the system to generate all invoices at the same time.

===Payment Reminder Emails===
If you enable this, the system will remind your customers by email in advance of an unpaid invoice's due date. It does this using the ''Invoice Unpaid Reminder'' setting (below). This setting does not apply to Overdue Reminders.

===Invoice Unpaid Reminder===
The system sends this email before the due date if the invoice remains unpaid, to remind a customer that the invoice will be due soon.

=== Overdue Reminders===
If a customer hasn't paid an invoice in a certain number of days after the due date, the system will email the customer with a reminder.

===Add Late Fee Days===
If a customer hasn't paid an invoice that is this number of days overdue, your customer will be charged late fees (according to your choices in General Settings).

===Overage Billing Charges===
Use this to determine how to bill clients for overage (if you enabled this). The first setting will calculate the bandwidth overage costs on the last day of each month and create an invoice that is due immediately. This will create a separate invoice.<br />
The second setting will still calculate the overage change on the last day of the month, but it will not create a separate invoice. Instead, the system will add it to the client's next invoice.

===Change Invoice Status===

Select this to use the ''Collections'' invoice status to denote invoices that are bad debts ([[Payment_Reversals|payment reversals]]). You can use this to track invoices that have received payment disputes or chargebacks.

<div class="docs-alert-info">
WHMCS 8.3 and higher includes support for disputes for [[Stripe]] and some [[PayPal]]® transactions at '''Billing > [[Disputes]]'''.
</div>

===Change Due Dates===
Part of the [[Payment_Reversals|Payment Reversals]] feature. This reverts Next Due Date Increments for the products and services in an invoice. The system considers them as due again, and, in cases where the date is in the past, overdue, which will trigger an automated suspension until repayment is made.

=== Enable Auto Cancellation ===
Select this to enable automatic cancellation of overdue invoices after a specific number of days. This setting automates removal of old, overdue invoices in the ''Unpaid'' status each time that the system cron runs.

* This setting will '''not''' remove any overdue invoices that have partial payment or applied credit, regardless of the invoice's age.
* Invoice cancellation does '''not''' explicitly trigger additional actions. However, depending on your automation settings, additional automation may occur due to cancelled invoices.
* When the system cron cancels the applicable invoices, it will add a note to the invoice to indicate closure due to automatic cancellation.

You can view the overdue unpaid invoices that the system cancelled during the last daily task run under '''Overdue Invoice Cancellation''' at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Status]]'''.

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

=== Days Overdue ===
If you enabled '''Enable Auto Cancellation''', enter the number of days an invoice can remain overdue before the system cron job cancels it.

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

==Payment Capture Settings==
[[File:Credit Card Charging Settings.png|thumb|Payment Capture Settings]]
<div class="docs-alert-info">
Prior to WHMCS 8.2, these settings were under '''Credit Card Charging Settings'''.
</div>
Use these settings to determine how to charge your customer's pay method when you use a merchant gateway to handle credit card and other payments.

===Process Days Before Due===
This specifies the number of days before the due date that you wish to capture. For example, setting this to <tt>1</tt> would attempt to charge the card for the first time one day before the invoice due date.

=== Attempt Only Once===
By default, the system will attempt to capture payment for unpaid invoices daily until it succeeds. When you enable this option, WHMCS will only attempt to charge the customer’s card once. If it fails, it will not try again until the client or an admin makes a manual payment attempt.

===Retry Every Week For===
When you enable this, WHMCS will attempt to charge the card every Seven days from the expected capture attempt date for this number of weeks.
For example, if an invoice's '''Next Due Date''' value is on the 14th and you set this setting to <tt>2</tt> and '''Process Days Before Due''' to <tt>1</tt>, the system will attempt the first payment capture on the 13th. Then, it will retry payment on the 20th and 27th if the invoice status is not ''Paid''.

You can also set this setting to <tt>0</tt> to disable the weekly retries, causing the system to attempt to charge the card every day until it succeeds or the invoice status changes to ''Cancelled''

===CC Expiry Notices Date===
This is the day of the month on which the system will send reminder emails to active clients with cards that expire by the end of the month, asking them to update their records. On the 1st of the month, WHMCS will remove any credit cards with an expiration date before that day's date.

We recommend a low value, such as <tt>1</tt>, to give clients as much notice as possible to update their card details. For example:

'''Scenario'''<br/>
Card Expiry Date: March 2020<br/>
CC Expiry Noticed Date: 1

'''Timeline of Events'''<br/>
Reminder email sent: 1st March 2020<br/>
Card removed from WHMCS: 1st April 2020

===Do Not Remove CC on Expiry===
When you enable this option, the client's credit card information will remain on file after its expiration date. When you disable this, the system will remove the credit card details using the setting you specified for CC Expiry Notices Date.

==Currency Auto Update Settings==
[[File:Currency Auto Update Settings.png|thumb|Currency Auto Update Settings]]
Use these settings for the multi-currency system.

===Exchange Rates===
When you enable this setting, WHMCS will connect with the European Central Bank and obtain the latest exchange rates. This will ensure your currency conversion functions are always using an accurate rate. For more information, see the list of [[Currencies#Auto_Updating_Rates |supported currencies]].

===Product Prices===
When you enable this setting, the system will automatically update your prices according to the exchange rates. For example, if you have a product that costs $1 in your default base currency (USD) and the exchange rate is 0.6 for a second currency (GBP), the product’s price would automatically update to £0.6. Tomorrow, if the exchange rate changed to 0.7, a $1 product would change to £0.7.

==Domain Reminder Settings==

[[File:Domain Reminder Settings.png|thumb|Domain Reminder Settings]]

You can configure WHMCS to send Domain Renewal Notices before and after a domain has expired and, in WHMCS 8.2, choose whether to send renewal notices for free domains bundled with a product or service.

For more information on this functionality, see [[Domain Renewal Notices]] and [[Free Domains]].

=== Renewal Notices ===

You can send a maximum of five reminders.

To configure these settings, for each renewal notice:

# Enter the number of days for that notice. If you set any field to <tt>0</tt> it will disable that email.
# Select whether to send the reminder that many days before or after the renewal date.

=== Free Domain Reminders ===

In WHMCS 8.2 and later, choose whether to send renewal reminders for free domains associated with a paid product or service. This setting defaults to disabled for existing installations upgrading to WHMCS 8.2 and to enabled for new installations of WHMCS 8.2 and higher.

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

==Domain Sync Settings==

[[File:Domain Sync Settings.png|thumb|Domain Sync Settings]]

===Domain Sync Enabled===
Enable this setting for the domain date and status synchronisation function.

<div class="docs-alert-info"><i class="fa fa-question-circle"></i> For more information about the domain sync task, see [[Domain Synchronisation]].</div>

===Sync Next Due Date===
Use this setting to choose whether to sync the Next Due Date to the Expiry Date, and, if you wish, how many days in advance of it.

===Domain Sync Notify Only===
If you enable this, the domain sync script won't make any changes. It will only notify admins of the changes it would have made. This is useful for debugging.

===Domain Expiry Sync Frequency===
A value of <tt>0</tt> will check the domain expiration dates every four hours. Use this setting to set a different frequency. The lowest frequency setting, <tt>1</tt>, will check every hour.

===Pending Transfer Sync Frequency===
A value of <tt>0</tt> will check the domains in Pending Transfer status every four hours. Use this setting to set a different frequency. The lowest frequency setting, <tt>1</tt>, will check every hour.

==Support Ticket Settings==
[[File:Support Ticket Settings.png|thumb|Support Ticket Settings]]
===Close Inactive Tickets===
After this amount of time has passed, the system will close any tickets that meet both of the following criteria:

* The ticket's status is either answered or customer reply.
* There have been no new replies from staff or the customer.

The system will also send an email to the customer.

Tickets in on hold and in progress status are exempt from auto-closure. Closure takes place when the daily cron job runs.

<div class="docs-alert-info">You must configure Ticket Statuses to "Auto-Close" for this setting to take effect. You can learn more about Ticket Statuses and the Auto-Close functionality in our [https://docs.whmcs.com/Support_Ticket_Statuses#Status_Options Status Options documentation].</div>

===Prune Ticket Attachments===
When this setting is enabled, ticket attachments will be automatically deleted after the selected amount of time of inactivity following the closure of a ticket. This can be set between 1 and 24 months.

For more information on this functionality, see the [[Ticket Attachment Pruning]] documentation.

==Data Retention Settings==
[[File:Data Retention Settings.png|thumb|Data Retention Settings]]

===Automatically Delete Inactive Clients===

<div class="docs-alert-info">
<span class="title">Automatically Delete Inactive Clients</span><br />
* We added this setting in WHMCS 7.5.
* In WHMCS 8.3 and earlier, this was the '''After no invoice or transaction activity has occurred for the following number of months''' setting.
</div>

This setting allows you to configure client records to be automatically deleted after a given number of months with no invoice or transaction history. The length of time you must retain data is often governed by the laws and regulations of your local jurisdiction. Most jurisdictions agree that you should only keep personal data for as long as is necessary.

To enable this setting, select '''After no invoice payment has occurred for the inactive or closed client in the following number of months''' and specify a number of months that is greater than <tt>0</tt>.

This setting is disabled by default.

<div class="docs-alert-danger">
<span class="title">Paid Invoices and Transactions</span><br />
The presence of paid invoices or transactions within the specified period determines whether WHMCS retains client records. If you enable this feature, WHMCS will immediately delete clients who are in the ''Inactive'' or ''Closed'' statuses and have no invoice or transaction history.
</div>

This setting causes the system to perform the '''Data Retention Pruning''' task each day. This will delete client records that meet the following criteria:

* A status of [[Automation_Settings#Client_Status_Update|'''Inactive''' or '''Closed''']].
* No paid invoices within the specified number of months.
* No entered or applied transactions within the specified number of months.
* If the client is an affiliate, a commission balance of <tt>0</tt> or no referrals within the specified retention period.

<div class="docs-alert-info">The system can automatically change the client status. Use the '''[[Automation_Settings#Client_Status_Update|Client Status Update]]''' setting to control this.</div>

=== Delete associated users if the user(s) are not associated with any other client account===

Optionally, you can set this to '''YES''' to cause the '''Data Retention Pruning''' task to also delete users who are only associated with this client.

==Miscellaneous==
[[File:Miscellaneous.png|thumb|Miscellaneous]]
===Cancellation Requests===
When you enable the [[Other_Tab#Show_Cancellation_Link|Show Cancellation Link]] option, enabling this setting will automatically terminate the client’s package on the termination date.

For more information, see [[Cancellation Requests]].

===Update Usage Statistics===
Enabling this option will display disk and bandwidth usage statistics from the hosting control panel (if it is supported) inside the WHMCS admin and client areas. It will update them on a daily basis.

===Client Status Update===
The following applies to the client status dropdown found in the client account Profile tab. WHMCS automatically sets clients older than 2 days, with no active products or services to Inactive status. This helps you to distinguish and filter clients effectively. However, you can stop WHMCS from doing this by changing this setting. More information on this feature is available in [[Clients:Profile_Tab#Changing_a_Clients_Status|Client Management]].

'''Disabled''' — The system won't change the status of a client automatically.

'''Change client status based on active/inactive products''' — If a client was created more than 2 days ago, has no active or suspended services, domains, addons, or billable items, the system will automatically set their account to Inactive status the next time that the cron job runs.

'''Change client status based on active/inactive products and not logged in for longer than 3 months''' — In addition to the above option, the system will only set a client's account to inactive when their last login date was over 3 months ago.

===Module Log Pruning===
Enabling this option allows you to choose the number of days of [[System_Logs#Module_Log|module log]] entries to retain. The system prunes the module log daily during the execution of the cron.

Changelog:WHMCS V8.10

2024-04-24T13:55:50Z

2024-04-03T18:05:22Z

SarahK:

New and Improved in WHMCS 8.10

2024-04-03T18:03:56Z

SarahK: /* Cancel Accumulated Overdue Invoices Automatically */

Now a Release Candidate, WHMCS 8.10 introduces automated provisioning for Sitejet Builder on supported servers and allows you to cancel overdue invoices automatically.

<div class="docs-alert-info">
You can learn more about the technical details of this release's changes in our [[Version 8.10 Release Notes|Release Notes]].
</div>

== Fast, Easy, Competitive Websites with Sitejet Builder ==

WHMCS now includes full automation support for [https://www.sitejet.io/en Sitejet Builder] on cPanel & WHM and Plesk hosting servers, making it easy for your customers to build and launch competitive websites, fast.

[[File:cpanel-sitejet-builder.png|600px]]

<div class="docs-alert-info">Sitejet Builder is included at no extra charge on servers that run [https://go.whmcs.com/1821/cpanel-sitejet-builder cPanel & WHM version 116 or higher] or [https://go.whmcs.com/1825/plesk-sitejet-builder Plesk 18.0.57 or higher].</div>

Sitejet Builder includes everything that your customers need to create professional websites, no coding required. They can choose from over 140 templates and customize everything with a simple drag-and-drop editor. Stock photos, videos, and even AI-assisted content creation are included.

You can start offering Sitejet Builder by adding the correct feature or permission to your hosting plans or by creating a predefined Sitejet Builder addon. Promotions for your Sitejet Builder products and addons will display to your customers in the Client Area.

[[File:client-area-sitejet-builder-login.png|600px]]

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

For more information, see [[Sitejet Builder]].

== Cancel Accumulated Overdue Invoices Automatically ==

In WHMCS 8.9 and earlier, removing old overdue invoices was a manual process. In WHMCS 8.10 and later, you can enable automatic cancellation for invoices that have been overdue for a specified amount of time.

[[File:auto-cancel-invoices-billing-settings.png|600px]]

When you enable this feature, the system cron will cancel any overdue invoices that are in the ''Unpaid'' status and have exceeded your set number of days. This ensures that overdue invoices will not accumulate on your system indefinitely, and it requires no manual action from you.

[[File:auto-cancelled-invoice.png|600px]]

You can enable automatic overdue invoice cancellation and set the number of days using the '''Enable Auto Cancellation''' and '''Days Overdue''' settings in the '''Billing Settings''' section at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]'''.

For more information, see [[Automation Settings]].

== Updating to WHMCS 8.10 ==

To take advantage of these changes, you need to update to WHMCS 8.10.

Right now, WHMCS 8.10 is a Release Candidate. We recommend making sure your customizations are up-to-date for the new version and checking the compatibility of any third-party modules you use.

New and Improved in WHMCS 8.10

2024-04-03T18:03:43Z

SarahK: /* Cancel Accumulated Overdue Invoices Automatically */

Now a Release Candidate, WHMCS 8.10 introduces automated provisioning for Sitejet Builder on supported servers and allows you to cancel overdue invoices automatically.

<div class="docs-alert-info">
You can learn more about the technical details of this release's changes in our [[Version 8.10 Release Notes|Release Notes]].
</div>

== Fast, Easy, Competitive Websites with Sitejet Builder ==

WHMCS now includes full automation support for [https://www.sitejet.io/en Sitejet Builder] on cPanel & WHM and Plesk hosting servers, making it easy for your customers to build and launch competitive websites, fast.

[[File:cpanel-sitejet-builder.png|600px]]

<div class="docs-alert-info">Sitejet Builder is included at no extra charge on servers that run [https://go.whmcs.com/1821/cpanel-sitejet-builder cPanel & WHM version 116 or higher] or [https://go.whmcs.com/1825/plesk-sitejet-builder Plesk 18.0.57 or higher].</div>

Sitejet Builder includes everything that your customers need to create professional websites, no coding required. They can choose from over 140 templates and customize everything with a simple drag-and-drop editor. Stock photos, videos, and even AI-assisted content creation are included.

You can start offering Sitejet Builder by adding the correct feature or permission to your hosting plans or by creating a predefined Sitejet Builder addon. Promotions for your Sitejet Builder products and addons will display to your customers in the Client Area.

[[File:client-area-sitejet-builder-login.png|600px]]

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

For more information, see [[Sitejet Builder]].

== Cancel Accumulated Overdue Invoices Automatically ==

In WHMCS 8.9 and earlier, removing old overdue invoices was a manual process. In WHMCS 8.10 and later, you can enable automatic cancellation for invoices that have been overdue for a specified amount of time.

[[File:auto-cancel-invoices-billing-settings.png|600px]]

When you enable this feature, the system cron will cancel any overdue invoices that are in the ''Unpaid'' status and have exceeded your set number of days. This ensures that overdue invoices will not accumulate on your system indefinitely, and it requires no manual action from you.

[[File:auto-cancelled-invoice.png|600px]]

You can enable automatic overdue invoice cancellation and set the number of days using the '''Enable Auto Cancellation''' and '''Days Overdue''' settings in the '''[Billing Settings](/system/automation/automation-settings#billing-settings)''' section at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]'''.

For more information, see [[Automation Settings]].

== Updating to WHMCS 8.10 ==

To take advantage of these changes, you need to update to WHMCS 8.10.

Right now, WHMCS 8.10 is a Release Candidate. We recommend making sure your customizations are up-to-date for the new version and checking the compatibility of any third-party modules you use.

SarahK:

{| class="table table-striped"
|+ <span style="font-weight: bold; font-size">MySQL Version Support by WHMCS Version</span>
! WHMCS Version (Status)
! MySQL v5.2
! MySQL v5.3
! MySQL v5.4
! MySQL v5.5
! MySQL v5.6
! MySQL v5.7
! MySQL v8.0
|-
| v6.3 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y || N || N
|-
| v7.0 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || N || N
|-
| v7.1 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || N || N
|-
| v7.2 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || N || N
|-
| v7.3 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || N
|-
| v7.4 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || N
|-
| v7.5 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || N
|-
| v7.6 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || N
|-
| v7.7 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v7.8 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v7.9 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v7.10 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v8.0 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v8.1 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v8.2 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v8.3 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v8.4 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v8.5 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v8.6 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v8.7 (EOL) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v8.8 (LTS) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v8.9 (Active) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|-
| v8.10 (RC) ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y ||style="background: #81D153; font-weight: bold;" | Y || style="background: #81D153; font-weight: bold;" | Y
|}

IonCube Loader Version Matrix

2024-04-03T17:47:19Z

SarahK:

<div class="docs-alert-info">[[System Environment Guide|Minimum]] ionCube® Loader Version by WHMCS Version</div>
{| class="table table-striped"
! WHMCS Version (Status)
! PHP v5.2
! PHP v5.3
! PHP v5.4
! PHP v5.6
! PHP v7.0
! PHP v7.1
! PHP v7.2
! PHP v7.3
! PHP v7.4
! PHP v8.1
|-
| v6.3 (EOL) || style="font-weight: bold;" | 4.6.1 || style="font-weight: bold;" | 4.6.1 || style="font-weight: bold;" | 4.6.1 || style="font-weight: bold;" | 4.6.1 || -- || -- || -- || -- || -- || --
|-
| v7.0 (EOL) || -- || -- || -- || style="font-weight: bold;" | 5.0.21 || style="font-weight: bold;" | 6.0.2 || -- || -- || -- || -- || --
|-
| v7.1 (EOL) || -- || -- || -- || style="font-weight: bold;" | 5.0.21 || style="font-weight: bold;" | 6.0.2 || -- || -- || -- || -- || --
|-
| v7.2 (EOL) || -- || -- || -- || style="font-weight: bold;" | 5.0.21 || style="font-weight: bold;" | 6.0.2 || -- || -- || -- || -- || --
|-
| v7.3 (EOL) || -- || -- || -- || style="font-weight: bold;" | 5.0.21 || style="font-weight: bold;" | 6.0.2 || -- || -- || -- || -- || --
|-
| v7.4 (EOL) || -- || -- || -- || style="font-weight: bold;" | 5.0.21 || style="font-weight: bold;" | 6.0.2 || -- || -- || -- || -- || --
|-
| v7.5 (EOL) || -- || -- || -- || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.2.0 || -- || -- || --
|-
| v7.6 (EOL) || -- || -- || -- || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1|| -- || --
|-
| v7.7 (EOL) || -- || -- || -- || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1|| -- || --
|-
| v7.8 (EOL) || -- || -- || -- || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1|| -- || --
|-
| v7.9 (EOL) || -- || -- || -- || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1|| -- || --
|-
| v7.10 (EOL) || -- || -- || -- || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.1.0 || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1|| -- || --
|-
| v8.0 (EOL) || -- || -- || -- || -- || -- || -- || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1
| style="font-weight: bold;" | 10.4.3 || --
|-
| v8.1 (EOL) || -- || -- || -- || -- || -- || -- || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1
| style="font-weight: bold;" | 10.4.3 || --
|-
| v8.2 (EOL) || -- || -- || -- || -- || -- || -- || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1
| style="font-weight: bold;" | 10.4.3 || --
|-
| v8.3 (EOL) || -- || -- || -- || -- || -- || -- || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1
| style="font-weight: bold;" | 10.4.3 || --
|-
| v8.4 (EOL) || -- || -- || -- || -- || -- || -- || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1
| style="font-weight: bold;" | 10.4.3 || --
|-
| v8.5 (EOL) || -- || -- || -- || -- || -- || -- || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1
| style="font-weight: bold;" | 10.4.3 || --
|-
| v8.6 (EOL) || -- || -- || -- || -- || -- || -- || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1
| style="font-weight: bold;" | 10.4.3 || style="font-weight: bold;" | 12.0.1
|-
| v8.7 (EOL) || -- || -- || -- || -- || -- || -- || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1
| style="font-weight: bold;" | 10.4.3 || style="font-weight: bold;" |12.0.1
|-
| v8.8 (LTS) || -- || -- || -- || -- || -- || -- || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1
| style="font-weight: bold;" | 10.4.3 || style="font-weight: bold;" |12.0.1
|-
| v8.9 (Active) || -- || -- || -- || -- || -- || -- || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1
| style="font-weight: bold;" | 10.4.3 || style="font-weight: bold;" |12.0.1
|-
| v8.10 (RC) || -- || -- || -- || -- || -- || -- || style="font-weight: bold;" | 10.2.0 || style="font-weight: bold;" | 10.3.1
| style="font-weight: bold;" | 10.4.3 || style="font-weight: bold;" |12.0.1
|}