WHMCS Documentation - User contributions [en]

Template:MobileApp

2022-05-19T19:39:46Z

Matt:

<includeonly><div style="margin-top:15px;padding:10px;background:#F9F9F9;border:1px solid #e8e8e8;text-align:center;">'''[https://www.whmcs.com/preview/mobile WHMCS Mobile App Preview]'''<br />{{#ifeq:{{{type|}}}|Connecting to WHMCS|'''Connecting to WHMCS'''|[[Mobile_App:_Connecting_to_WHMCS|Connecting to WHMCS]]}} {{!}} {{#ifeq:{{{type|}}}|Troubleshooting|'''Troubleshooting'''|[[Mobile_App:_Troubleshooting|Troubleshooting]]}}</div></includeonly><noinclude>
Add <nowiki>{{MobileApp}}</nowiki> for a footer to your pages, produces:
{{MobileApp}}
</noinclude>

Version 8.3 Release Notes

2021-11-30T12:20:29Z

Matt: /* Improved SSL Certificate Validation */

<div class="docs-alert-info" style="max-width:370px;">
<span class="title">Release Information</span>
<br />
Version: 8.3<br />
Release Type: General Availability<br />
Latest Update: 29th November 2021<br />
Distribution Types: Full and Via Automatic Updater
</div>

==Version History==
<onlyinclude>
<table class="table table-striped">
<tr><td>8.3.0</td><td>Beta 1</td><td>13th September 2021</td></tr>
<tr><td>8.3.0</td><td>Release Candidate 1</td><td>28th September 2021</td></tr>
<tr><td>8.3.0</td><td>General Availability</td><td>13th October 2021</td></tr>
<tr><td>8.3.1</td><td>Maintenance</td><td>28th October 2021</td></tr>
<tr><td>[[Version_8.3.2_Release_Notes|8.3.2]]</td><td>Maintenance</td><td>29th November 2021</td></tr>
</table>
</onlyinclude>

==Download==

Download the latest version of WHMCS from https://download.whmcs.com/

==Upgrade Process==

WHMCS 8.0 and above requires PHP 7.2 or later. WHMCS 8.0 introduces support for PHP 7.4. Earlier versions of WHMCS do not support PHP 7.4.

<div class="docs-alert-warning">You will only see the WHMCS 8 updates within the Automatic Updater if you are running on PHP 7.2 or later. If you are running PHP 7.1 or earlier, to update to WHMCS 8 via the Automatic Updater, you will first need to upgrade to PHP 7.2 or PHP 7.3, and then check for updates and perform the update.</div>

Once you are running WHMCS 8, you can upgrade to PHP 7.4.

[[Upgrading|View Standard Upgrade Steps]]

===Automatic Updating===

If you are running WHMCS 7.0 or later, you can use the built-in [[Automatic_Updater|Automatic Update]] utility.

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

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

For more information about updating, refer to the [[Automatic Updater]] documentation.

== Release Notes ==

=== Improved Email Reply Importing and Attachments ===

We have improved the support ticket system's handling of insecure email replies. This includes new settings at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' that set how WHMCS handles importing for support tickets.

[[Blocked_Support_Email_Replies|Learn more...]]

=== Plesk Usage Statistics ===

The list of servers at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' now displays services and either accounts or domains for Plesk servers.

=== Manage Stripe and PayPal® Disputes ===

You can now work with disputes directly within the WHMCS Admin Area, including viewing and closing disputes and submitting evidence. Currently, this feature supports the Stripe and PayPal payment gateways.

[[Disputes|Learn More...]]

=== Improved Client Profile Summary ===

The client profile '''Summary''' tab at '''Clients > View/Search Clients > Client Profile''' now offers faster filtering, sorting, and pagination tools. This improves the ability to locate products, services, addons, domains, and quotes.

=== Automated WordPress® Hosting ===

You can now easily create WordPress hosting products with full WHMCS automation for cPanel and Plesk servers. Automatic provisioning installs WordPress when the product is purchased, and both clients and admins can create additional WordPress installations on the hosting account from the Client Area and Admin Area.

[[WordPress Hosting|Learn More...]]

=== Friendly URLs for Products ===

You can now customize friendly URLs for each of your products. Once you have created one or more product URLs, you can easily view the number of visits for the active (most recent) product URL.

[[Friendly URLs|Learn More...]]

=== Affiliate Commission Reversals ===

New updates to the affiliate system help you reverse commission payments for disputed or refunded purchases. This ensures that affiliates won't receive a commission if your business did not retain the funds from a given purchase.

[[Affiliates|Learn More...]]

=== Improved SSL Certificate Validation ===

WHMCS now supports DNS validation for MarketConnect's DigiCert SSL certificates. Starting in October 2021, wildcard certificates no longer allow file based authentication and require validation using either DNS or email. Our changes include interface improvements that allow clients and admins to access validation data for certificates that are waiting to be issued.

[[SSL_Certificates_via_WHMCS_MarketConnect|Learn More...]]

== Deprecation and Removal Notices ==

''None''

== Template ==

For a list of changed files and a graphical view of the exact changes, please refer to the GitHub repositories below.

===Twenty-One Theme===

The following link provides a comparison of changes between 8.2.1 and 8.3.2 (Maintenance):

https://github.com/WHMCS/templates-twenty-one/compare/v8.2.1-release.1...v8.3.2-release.1

=== Six Theme ===

The following link provides a comparison of changes between 8.2.1 and 8.3.2 (Maintenance):

https://github.com/WHMCS/templates-six/compare/v8.2.1-release.1...v8.3.2-release.1

=== Standard Cart Order Form ===

The following link provides a comparison of changes between 8.2.1 and 8.3.2 (Maintenance):

https://github.com/WHMCS/orderforms-standard_cart/compare/v8.2.1-release.1...v8.3.2-release.1

== Changelog ==
* [[Changelog:WHMCS_V8.3.0_Beta_1|Version 8.3.0 Beta 1]]
* [[Changelog:WHMCS_V8.3.0_RC_1|Version 8.3.0 RC 1]]
* [[Changelog:WHMCS_V8.3.0_GA|Version 8.3.0 GA]]
* [[Changelog:WHMCS_V8.3.1|Version 8.3.1 Maintenance]]
* [[Changelog:WHMCS_V8.3.2|Version 8.3.2 Maintenance]]

Reseller License Manager

2021-06-30T21:37:54Z

Matt:

''' - Addon Name:''' Reseller License Manager<br />
''' - Latest Version:''' 4.0.0<br />
''' - Release Date:''' 30th June 2021<br />
''' - Compatible With:''' WHMCS 7.3 and later. Latest WHMCS 8.x is recommended.

The WHMCS Reseller License Manager is an add-on designed for members of the WHMCS Reseller Program.

The add-on integrates with WHMCS to provide a drop-in solution for managing, issuing and assigning licenses to customers.

Functionality includes:

* Ability to view all license keys within your account
* Ability to associate license keys with customers products & services
* Automated license key issueing and assignment to new customer signups
* License key management including reissues, upgrades, reserving and cancellation
* Ability to provision new licenses
* Client limit status visibility and automated email notifications/upgrades

==Download==

To download the add-on, visit the Reseller Portal located within our Members Area at the url below.

https://www.whmcs.com/members/reseller

==Installation==

To install the add-on, follow the steps below.

# Download the latest add-on files from https://www.whmcs.com/members/reseller
# Unzip the zip file download to a directory on your computer
# Upload the files to the ''~/modules/addons/whmcslicenses/'' directory within your WHMCS installation
# Login to the admin area and navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
# Locate '''WHMCS License Manager''' in the list of Addon Modules and hit the Activate button
# Ensure your administrator role group is granted permission to access the add-on and hit Save.

Now visit '''Addons > WHMCS License Manager''' to verify the installation was successful.

Enter your registered Email Address and API Key for the Reseller API on the splash screen shown.
[[Image:whmcslicenses_splash.png|900px|WHMCS Licenses Splash Screen]]
<div class="docs-alert-info">If you do not have a Reseller API Key yet, visit https://www.whmcs.com/members/reseller to generate one</div>

==Upgrading==

To upgrade the add-on to a newer version, follow the steps below.

# Download the latest add-on files from https://www.whmcs.com/members/reseller
# Unzip the zip file download to a directory on your computer
# Upload the files to the ''~/modules/addons/whmcslicenses/'' directory within your WHMCS installation, overwriting all existing files

Login to your WHMCS admin area and visit '''Addons > WHMCS License Manager''' to complete the update process and access the addon.

==Usage==
===Getting Started===
====Bundled Offering====

A bundled offering allows you to include a WHMCS license free of charge when certain products are purchased. For example with a Reseller Hosting Package.

To configure bundled offerings, follow the steps below:

# Navigate to '''Addons > WHMCS License Manager'''
# Click ''Automation Setup''
#:[[File:whmcslicenses_bundled_offering.png|thumb|WHMCS Licenses Bundled Offering]]
# Under the Bundled Offering section, select the products you wish to be issued with free licenses upon their initial purchase. You can choose between issueing a Starter or Plus license as a bundled license. No fee will be billed to the customer for a bundled license.
#* Each product can only be assigned to a single license type.
#:[[Image:whmcslicenses_paid_addons.png|thumb|WHMCS Licenses Bundled Offering]]

====Paid Add-On Purchase====

A paid add-on offering allows you to offer a WHMCS license as an optional extra Product Addon during the initial order flow.

To configure a paid add-on offering, follow the steps below.

# Navigate to '''Addons > WHMCS License Manager'''
# Click ''Automation Setup''
# Under the Paid Add-on Purchase section, you will see a list of Product Addons that are currently configured to provision a WHMCS license key upon purchase.
# If you see a Product Addon for the license type you wish to offer, simply click into it and modify the Applicable Products to include the product or products you wish for it to be offered with.
# If you do not see an existing Product Addon for the license type you wish to offer, you can create one by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Product Addons''' and creating a Product Addon, ensuring to select 'WHMCS License Reselling' as the module.
# Alternatively, the button labelled "Create Missing License Products" on the Automation Setup tab can be used to create Product Addons for all the available WHMCS license types.

===Settings===
[[Image:whmcslicenses_settings.png|900px|WHMCS Licenses Settings]]
====Client Upgrades====
Enable this option to allow your clients to receive an email when they are approaching, or exceeded, the client limit for their license product. The client will be able to place an order for an upgrade to the next available license tier.

====Notify Clients Approaching Limit====
<div class="docs-alert-info">Only available when Client Upgrades are disabled.</div>

Enable this option to send clients an automated email notification when they reach the approaching client limit warning level.

====Approaching Limit Email====
<div class="docs-alert-info">Only available when Client Upgrades are disabled.</div>

Select the email template to be sent when the above option is enabled. Default: WHMCS License Client Limit Imminent. The email template can be edited via '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Email Templates''' or, prior to WHMCS 8.0, '''Setup > Email Templates'''.

====Notify Clients At Limit====
<div class="docs-alert-info">Only available when Client Upgrades are disabled.</div>

Enable this option to send clients an automated email notification when they reach the client limit.

====At Limit Email====
<div class="docs-alert-info">Only available when Client Upgrades are disabled.</div>

Select the email template to be sent when the above option is enabled. Default: WHMCS License Client Limit Reached. The email template can be edited via '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Email Templates''' or, prior to WHMCS 8.0, '''Setup > Email Templates'''.

====Check for Unassigned License Keys====
Enable this option to find the first unassigned license key already active within your reseller account on module provision. When enabled, this option can slow down provisioning if a large number of licenses are active in your account.

==Automated Upgrade Flow==

Version 4.0 and later includes a self-serve automated license upgrade process for end users.

When a license key reaches or exceeds the client limit, customers will receive an email containing a link to upgrade their license. Upon following this link, end users will be presented with a page itemising their current license, the new license type required based on the active clients, and the cost difference for the upgrade.

[[File:whmcs-rlm-upgrade-preview.png|800px]]

Upgrade costs are calculated on a prorata basis, calculated by billing the new product price for the number of days between today and the next due date, with a credit applied for the days remaining until the next due date at the current product price.

If the customer selects to continue, an invoice is generated and can be paid using any available payment gateway. Upon payment being completed successfully and the payment applied to the invoice, the license key will be upgraded instantly.

[[File:whmcs-rlm-upgrade-invoice.png|800px]]

Invoices will remain in an Unpaid status for up to 24 hours. If it remains unpaid after that time, the invoice will be automatically cancelled and the upgrade link should be followed again to see the revised upgrade price calculation and generate another invoice if desired.

Prices for the upgrade are taken from the pricing configured in your Product Addons for WHMCS license types. To ensure upgrades can be performed for all license tiers, it is important to ensure you have a Product Addon for each tier of license available for WHMCS.

The Automation Setup page provides a list of Product Addons that exist for each tier of WHMCS license. A button to auto-create Product Addons for any license tiers for which you do not currently have an addon product setup is also available here.

== Changelog==
===v4.0.0===
* Performance improvements should make pages within the addon faster to load
* A new provisioning module is now included for the provisioning and management of WHMCS Licenses and should be assigned to all product addons used for WHMCS licenses.
* All existing addons for WHMCS licenses have been automatically updated to use the new module.

* The Automation Setup page has been updated to simplify the process of configuring products which should include a free WHMCS license.

* For WHMCS licenses offered as a paid optional extra, these should now be configured via the native Product Addons UI, the same as with any other addon products.

* This release includes a new self-serve automated license upgrade process for your customers. This functionality replaces the current Client Notification settings.
* When a license key reaches or exceeds the client limit, customers will receive an email containing a link to upgrade their license.
* Upgrade costs are calculated on a prorata basis, based on the prices defined in your Product Addons for WHMCS licenses.
* To ensure upgrades can be performed for all license tiers, it is important to ensure you have a Product Addon for each tier of license available for WHMCS.
* The Automation Setup page provides a list of Product Addons that exist for each tier of WHMCS license.
* A button to auto-create Product Addons for any license tiers for which you do not currently have an addon product setup is also available here.
* Existing WHMCS license addons without pricing configured have been automatically set to the Recommended Retail Price. This is to enable automated upgrades. You can modify prices via the Product Addons page.
* The self-service upgrade functionality can be disabled within the Settings tab if desired.

* A 'Migration License Product' Product Addon is created and assigned automatically for any WHMCS licenses that were previously assigned using the 'custom addon' functionality. If no custom addons existed, this migration product will not have been created.

File:Whmcs-rlm-upgrade-invoice.png

2021-06-30T21:36:14Z

Matt:

2020-09-08T16:25:53Z

Matt:

File:SolusIOPanels.png

2020-09-08T16:25:11Z

Matt: Matt uploaded a new version of File:SolusIOPanels.png

SolusIO FAQ

2020-09-07T15:53:24Z

Matt: /* How do users access the SolusIO system? */

The SolusIO Integration for WHMCS supports a number of different billing methods.

===Post-Pay Billing===

At this time, the SolusIO WHMCS module only supports Post-Pay billing.

====What is Post-Pay Billing?====

The Post-Pay Model allows customers or end users to signup and gain access to Solus.IO to provision virtual machines on-demand. The user is then billed after the service has been used for usage in the prior billing period.

====How do users sign-up?====

With the Post-Pay Model of billing, there is no purchase or order necessary.

Users can sign-up/activate their SolusIO user account via the provided landing page.

The enrollment process requires minimal information from the user necessary to create a WHMCS client account, along with email verification and agreement to your Terms of Service and (optionally) Post-Pay specific Terms & Conditions. The workflow is as follows:

# User requests to create an account for VM provisioning
# User enters their name, company, email address and a desired password
# User is sent an email containing a link to complete the signup process
# Once the email link is followed, the user is prompted to agree to your Terms of Service and Post-Pay Terms & Conditions
# Upon acceptance of all terms, user account is provisioned to SolusIO
# User is then provided with a login button to the SolusIO Control Panel

Users can then access SolusIO at any time via a provided SSO link within the WHMCS client area dashboard.

====How do users access the SolusIO system?====

With the Post-Pay Model, customers use the SolusIO control panel to provision and manage virtual machines.

The WHMCS client area dashboard will show one of the following 2 panels, dependant upon the users current SolusIO enrollment status.

[[File:SolusIOPanels.png]]

For enrolled users, the '''Login to SolusIO''' button can be used to access the SolusIO control panel at any time via automated single sign-on. Non-enrolled users are provided a shortcut to the provided landing page to learn more and sign-up.

====How does invoicing work?====

Invoices are generated on the 1st of each month for all usage accrued in the immediately preceeding month.

For example, on the 1st August, invoices will be generated for the usage by all users in the month of July.

====How is usage calculated?====

SolusIO tracks the uptime of every virtual machine and uptime is billed at the hourly rate of tokens that you define within the SolusIO software.

When it becomes time to generate an invoice, WHMCS will request the uptime totals for each user from the SolusIO system and then create an invoice with an itemized list of resources (aka virtual machines) and the amount due, calculated by taking the tokens usage value provided by the SolusIO system, and multiplying it by the token pricing that you have defined in WHMCS.

====How is billing triggered?====

Invoice generation and user management is managed by a cron task.

The cron task will be executed once per day.

The cron task can be triggered manually using the following command:

<div class="source-cli">php crons/cron.php do --SolusioAutomation -vvv</div>

* Please note that invoice generation will only occur on the 1st day of each month.

2020-09-07T14:58:48Z

Matt:

Our SolusIO Integration is the '''official integration''' between WHMCS and the SolusIO Virtual Infrastructure Management Platform.

Supporting 3 methods of billing integration:

* '''Self-Service VM Provisioning with Post-Pay Billing''' - Available now - Allow customers to register for access to VM provisioning, manage virtual machines and provision on-demand via the SolusIO control panel, and have billing performed at set intervals by WHMCS in a post-pay (pay after use) model.
* '''Self-Service VM Provisioning with Pre-Pay Credits''' - Coming Soon! - Allow customers to register for access to VM provisioning, deposit funds in advance, and manage virtual machines and provision on-demand via the SolusIO control panel. Usage charges are assessed against the customers available balance in real-time.
* '''Retail VM Selling''' - Coming Soon! - Sell pre-configured VPS plans through your WHMCS online store. Offer traditional style VPS and virtual machines with a fixed monthly price, prepaid up front and billed on a regular fixed billing cycle. Customers will not need to use the SolusIO control panel.

For more information, please refer to our [[SolusIO FAQ]]

==Installation==

# Download the latest version of the integration via the WHMCS Marketplace: ''link coming soon''
# Extract the zip file
# Upload the 'solusio' directory to the '/modules/addons' folder of your WHMCS installation.

===First Use===

# Login to the WHMCS Admin Area
# Navigate to ''Setup > Addon Modules''
# Locate the SolusIO module in the list
# Click the '''Activate''' button
# Upon success, click the Configure button
# Under Access Control, select the user group to which your admin user is assigned
# Click '''Save Changes'''
# After the page reloads, navigate to ''Addons > SolusIO''

You will then be guided through the process of connecting to your SolusIO instance

===Accessing the SolusIO Integration===

You can access the SolusIO module within WHMCS at any time by navigating to ''Addons > SolusIO'' within the WHMCS admin area.

==Connecting to SolusIO==

Upon accessing the SolusIO module for the first time you will see a screen as follows.

[[File:SolusIOConnect.png]]

Enter the URL to your SolusIO installation. This should be the url you use to access the web interface.

Enter your API Key. This can be retrieved by navigating to ''Account > API Tokens > Generate API Token'' when logged into the SolusIO user area.

Click '''Test Connection''' to verify a connection can be established with the SolusIO system

Upon success, you will be redirected to management screen.

==Setup & Use==

===Post-Pay===

Upon accessing the SolusIO module post connecting to SolusIO, you will be presented with the following screen which allows you to set settings related to Post-Pay billing.

[[File:SolusIOPostPaySetup.png]]

====Landing Page====

The WHMCS SolusIO Post-Pay functionality comes with a ready made landing page designed to make it quick and easy to get up and running with offering SolusIO services. The link is provided here for convenience. This page can only be accessed when Post-Pay billing is enabled.

[[File:SolusIOPostPayLandingPage.png]]

Menu items are automatically added to the WHMCS client area when enabled. For logged out users, it can be accessed via a Cloud Hosting option in the main menu. For logged in users, it can be accessed via a Cloud Hosting menu option under the Website & Security dropdown menu.

====Customising the Landing Page====

The landing page is controlled by templates and can be customized. To make changes, we recommend copying the file /modules/addons/solusio/templates/post-pay/landing-page.tpl into the active WHMCS client area template directory under the path /templates/{active_template}/modules/addons/solusio/post-pay/landing-page.tpl. All paths are relative to the WHMCS root installation directory. From there, you can make changes to the template within your WHMCS client area template directory and these customisations will be preserved during module updates.

====Configuration====

=====Post-Pay Limit Group=====

The limit group settings allow you to control settings related to limits imposed on new Post-Pay enabled users.

<table class="table table-striped">
<tr><th>Setting Name</th><th>Description</th></tr>
<tr><td>New User Limit Group</td><td>Select the limit group you wish to be applied by default to all new Post-Pay users. (* Limit groups must be created and defined within the SolusIO control panel)</td></tr>
</table>

=====Post-Pay General Settings=====

The general settings allow you to control general settings.

<table class="table table-striped">
<tr><th>Setting Name</th><th>Description</th></tr>
<tr><td>Post-Pay Terms & Conditions</td><td>An optional URL to Terms & Conditions for the Post-Pay Billing service for SolusIO. Use this to provide additional terms relating to the invoicing and payment of Post-Pay service usage.</td></tr>
</table>

=====Post-Pay Invoicing=====

The invoicing settings allow you to control settings related to invoices generated for Post-Pay usage.

<table class="table table-striped">
<tr><th>Setting Name</th><th>Description</th></tr>
<tr><td>Invoicing Grace Period</td><td>The number of days you want to allow after generation before an invoice is considered overdue.</td></tr>
</table>

=====Suspension Settings=====

The suspension settings allow you to control settings related to service restrictions for non-payment of Post-Pay usage.

<table class="table table-striped">
<tr><th>Setting Name</th><th>Description</th></tr>
<tr><td>Lock Overdue Users</td><td>The number of days you want to allow before locking a user account in SolusIO. This is the number of days from the due date.</td></tr>
<tr><td>Suspend Overdue Users</td><td>The number of days you want to allow before suspending a user account in SolusIO. This is the number of days from the due date.</td></tr>
</table>

For more information regarding locking and suspension restrictions, please refer to the SolusIO documentation.

===Settings===

The settings tab allows you to modify connection and pricing settings.

====Token Pricing====

Token Pricing must be set for each active currency within WHMCS.

Token Pricing can be set up to 4 decimal places.

The prices entered should be the monetary cost in each given current for 1 unit of token usage.

====API Connection====

The API Connection panel can be used to modify and update the Installation URL and API Key at any time.

To make a change, enter both the Installation URL and an API Key and click the '''Test Connection''' button to validate the inputs.

If a connection is successful, the URL and API Key used by WHMCS will be updated.

==SolusIO Setup==

The following articles describe configuration and setup within the SolusIO system itself.

===WHMCS Billing Integration===

Within the SolusIO product, it is possible to configure ''Billing Integration Settings''.

The billing integration allows SolusIO to retrieve token pricing information as well as perform single sign-on to the WHMCS billing portal.

WHMCS will auto-configure the WHMCS Billing Integration values for you every time a successful connection is established between the WHMCS SolusIO module and a SolusIO target instance. It is not possible to generate and set these values manually.

Should there be a need to re-configure or re-setup the connection at any time, you will need to re-establish the API Connection with the SolusIO target instance using the API Connection panel located within the Settings tab of the SolusIO WHMCS integration module.

SolusIO

2020-09-07T14:52:14Z

Matt:

File:SolusIOPostPayLandingPage.png

2020-09-07T14:51:06Z

Matt:

SolusIO FAQ

2020-09-07T14:47:59Z

Matt: Created page with "The SolusIO Integration for WHMCS supports a number of different billing methods. ===Post-Pay Billing=== At this time, the SolusIO WHMCS module only supports Post-Pay billin..."

The SolusIO Integration for WHMCS supports a number of different billing methods.

===Post-Pay Billing===

At this time, the SolusIO WHMCS module only supports Post-Pay billing.

====What is Post-Pay Billing?====

The Post-Pay Model allows customers or end users to signup and gain access to Solus.IO to provision virtual machines on-demand. The user is then billed after the service has been used for usage in the prior billing period.

====How do users sign-up?====

With the Post-Pay Model of billing, there is no purchase or order necessary.

Users can sign-up/activate their SolusIO user account via the provided landing page.

The enrollment process requires minimal information from the user necessary to create a WHMCS client account, along with agreement to your Terms of Service.

User accounts are provisioned to SolusIO immediately upon activation and users can then access SolusIO via a provided SSO link in the WHMCS client area dashboard.

====How do users access the SolusIO system?====

With the Post-Pay Model, customers use the SolusIO control panel to provision and manage virtual machines.

The WHMCS client area dashboard will show one of the following 2 panels, dependant upon the users current SolusIO enrollment status.

[ images go here ]

For enrolled users, the '''Login to SolusIO''' button can be used to access the SolusIO control panel at any time via automated single sign-on. Non-enrolled users are provided a shortcut to the provided landing page to learn more and sign-up.

====How does invoicing work?====

Invoices are generated on the 1st of each month for all usage accrued in the immediately preceeding month.

For example, on the 1st August, invoices will be generated for the usage by all users in the month of July.

====How is usage calculated?====

SolusIO tracks the uptime of every virtual machine and uptime is billed at the hourly rate of tokens that you define within the SolusIO software.

When it becomes time to generate an invoice, WHMCS will request the uptime totals for each user from the SolusIO system and then create an invoice with an itemized list of resources (aka virtual machines) and the amount due, calculated by taking the tokens usage value provided by the SolusIO system, and multiplying it by the token pricing that you have defined in WHMCS.

====How is billing triggered?====

Invoice generation and user management is managed by a cron task.

The cron task will be executed once per day.

The cron task can be triggered manually using the following command:

<div class="docs-cli">php crons/cron.php do --SolusioAutomation -vvv</div>

* Please note that invoice generation will only occur on the 1st day of each month.

File:SolusIOPostPaySetup.png

2020-09-07T14:46:21Z

Matt:

SolusIO

2020-09-07T14:39:21Z

Matt:

2020-03-12T21:10:13Z

Matt: