PanelAlpha Documentation
Back Home
Live Demo Get Started

WHMCS Module

Documentation
    Introduction FAQ
Getting Started
    Requirements Installation Update Guide SSL Configuration Resetting Admin Password Translations Health Check
Admin Area
    Dashboard Instances Services Users Logs Migrations
Onboarding Methods
    Quick Onboarding Super Quick Onboarding Standard Onboarding
System Configuration
    General Configuration Branding Hosting Servers DNS Servers Email Servers Remote Backups Plans Notifications Automatic SSL Themes, Plugins and Packages
Hosting Server Connections
    Hosting Scenarios PanelAlpha Engine for Docker cPanel Plesk DirectAdmin WP Cloud
Email Server Connections
    Mailcow cPanel
DNS Server Connections
    Cloudflare cPanel DNS Only PowerDNS
Billing Systems Integrations
    WHMCS
Billing Scenarios
    Introduction Single WordPress Instance Predefined WordPress Template Multiple WordPress Instances Cross-Selling Paid Plugins and Themes Cross-Selling Domains Plan Upgrade Free Trial Period
Integrations
    Integrated Solutions Matomo Google Analytics Let's Encrypt Google PageSpeed Insights DB-IP Extendify
Client Area - Instances
    List of Instances Creating New Instance Importing Existing Instance Instance Details Changing Domain Sharing Instances Monitoring Backups Plugins Advanced Settings
Client Area - Hosting
    Summary Domains FTP Accounts MySQL Databases Cron Jobs DNS Zone Editor Email Addresses Email Forwarders

# WHMCS Module

Direct Download

  • PanelAlpha For WHMCS
    • Features list
  • Installation
  • Configuration
    • Server
    • Product
    • Addon
  • Management
    • Admin area
    • Addon page
    • Client area
    • Account synchronisation
  • Additional information

# PanelAlpha For WHMCS

PanelAlpha For WHMCS is a module that seamlessly integrates PanelAlpha platform provisioning and management options with your WHMCS system. As a widely recognized web hosting and billing platform, WHMCS empowers you to efficiently provision and bill your clients for a variety of services. These may include ordered accounts with WordPress websites, product addons like plugins and themes, and services offered by PanelAlpha.

# Features list

  • Admin Area
    • Create/Terminate/Suspend/Unsuspend PanelAlpha Service
    • Change Package
    • Configure Service Per PanelAlpha Plan
    • View Selected Plan Configuration From PanelAlpha:
      • Instances Limit
      • Onboarding Type
      • Server Type And Group
      • Disk Space And Memory Limit
      • Selected DNS And Email Server
    • Enable Automatic WordPress Instance Provisioning When Service Is Created
    • Define Default WordPress Instance Theme
    • Define Default WordPress Instance Name
    • Toggle WordPress Instance Name Field On Order Form
    • Enable Only Manual Service Termination
    • Enable PanelAlpha Single Sign-On (SSO) For Client Area
    • Configure Metric Billing For:
      • Active WordPress Instances
      • Remote Backups Size
      • Disk Usage
    • Create/Terminate Service Addons With Preconfigured Packages From PanelAlpha:
      • View Selected Package Configuration With Included Plugins And Themes
    • Synchronize Accounts Between WHMCS And PanelAlpha Platform
  • Client Area
    • Use Single Sign-On (SSO) To Manage WordPress Instances In PanelAlpha
    • View Current Usage Billing For:
      • Active WordPress Instances
      • Remote Backups Size
      • Disk Usage
  • General Info
    • Multi-Language Support
    • Supports PHP 8.2 Back To PHP 7.4
    • Supports WHMCS Themes "Six" And "Twenty-One"
    • Supports WHMCS V8.11 Back To WHMCS V8.8

# Installation

This comprehensive tutorial will provide you with step-by-step instructions on the installation and configuration process of the PanelAlpha For WHMCS module. Our guide will ensure you successfully set up the module and customize the offered options to meet your business needs.

  1. Download the module from our GitHub Repository (opens new window).
    • Direct download link: https://github.com/panelalpha/panelalpha-for-whmcs/archive/refs/heads/main.zip (opens new window)
  2. Upload and extract the module files into the main WHMCS directory.

That's it! You have just successfully installed the PanelAlpha For WHMCS module!

# Configuration

# Server

  1. Go to System Settings → Servers and press the Add New Server button.
  2. Next, choose PanelAlpha from the Module dropdown menu. Remember not to use SSL Mode for connections, keep this option disabled or otherwise you will encounter errors when testing the server connection.
    Fill in the following fields:
    • Name - Enter any name of your choice.
    • Hostname - Remember to always add the port number, as on the screen below.
    • API Token - The API token can be generated in PanelAlpha admin area in Configuration → Admins under the Enable API Token action.
  3. Check the connection when the server configuration of your server is ready.
    In order to check the connection with the PanelAlpha server, press the 'Test Connection' button.
  1. The next step is creating a server group. To do so, click on Create Server Group.
  2. Enter the name, click on your previously created server, press Add and Save Changes afterwards.

# Product

  1. In order to create and then configure a product, go to Setup → Products/Services → Products/Services.
    Click on the Create a New Group button.

  2. Enter the product group name and press Save Changes.

  3. Once you have a product group, you can assign your product to it. To create a product, click on Create a New Product.

  4. Next, choose your product type, assign the product to a group of products created in the previous step. Enter your product name, select module: 'PanelAlpha' and then press 'Continue'.
    Remember to disable the default 'Create as Hidden' option beforehand.

  5. Now, go to the 'Module Settings' section, choose both PanelAlpha and your previously created server group from the dropdown menus. Available options for the product configuration will appear:

    • PanelAlpha Plan - A plan will be assigned to the service on the basis of which the service will be created.
    • Automatic instance provisioning - If enabled, a new instance will automatically be created with the selected theme when the service is created.
      • Default Instance Theme - Select a theme that will be installed once the service is created.
      • Default Instance Name - Provide the name of the instance that will be installed once the service is created.
      • Show Instance Name Field on Ordere Form - If enabled, a custom field with the instance name to provide will be visible on the order form.
    • Manual termination - If enabled, termination of the service will only occur after a manual action by the admin.
    • PanelAlpha SSO in main menu - If enabled, the user will receive a link to their PanelAlpha account on the main client area menu.
  1. Do not forget to click on the 'Save Changes' button when your configuration is ready.

# Addon

  1. Go to System Settings → Product Addons and press the 'Add New Addon' button.

  2. Next, choose the addon type as 'Independent Product', enter the package name and select the addon module: 'PanelAlpha'.

  3. Now, go to the addon's 'Module Settings' section and select the package:

    • Package - You can select a ready package configured in PanelAlpha.
    • Preview the package configuration:
      • Plugin automation on assign - Describes what happens to the plugins when the package is added to the service.
      • Theme automation on assign - Describes what happens to the themes when the package is added to the service.
      • Plugins included - List of plugins assigned to the selected package.
      • Themes included - List of themes assigned to the selected package.
  1. Assign the addon to the selected products at the 'Applicable Products' tab.
  1. Remember to 'Save Changes' when your addon configuration is ready.

# Management

# Admin area

As soon as you set up a server for a client, you can request various actions and view server details from the WHMCS admin area.

Available module commands:

  • Create/Suspend/Unsuspend/Terminate the service
  • Change Package

Metric Statistics:

  • Data on active instances assigned to the service
  • Data on the remote backup size
  • Disk usage analysis

# Addon page

If your product has an addon, you can also review its details from the admin area. Simply locate it in the list under the main product name.

Available actions on addons:

  • Create the addon
  • Terminate the addon

# Client area

Accessing their account on PanelAlpha is easy for clients, who simply need to click the Manage WordPress button in the navigation bar.

Access the PanelAlpha service, where you will find a button that allows direct login to the platform via SSO.

In the Metrics section, you can also view the current billing usage for active WordPress instances, the size of remote backups and disk usage.

The Additional Information section provides details on the WordPress instance name that has been created on this service.

# Account synchronisation

Follow the below guide to synchronize and import services from PanelAlpha into your WHMCS.

  1. In your WHMCS installation, navigate to: System Settings → Servers.
  2. Step 1 - Locate your PanelAlpha server in the list and click the Sync Accounts button.
  1. Step 2: Analyse - A table will display available services and their details.
    • Select the services that are not yet synchronized and that you wish to import by checking the Import/Sync box. Then, click Continue.
  1. Step 3: Review - You will be moved to the Review step. Here, you can see the PanelAlpha services that will soon be created in WHMCS.
    • Configure account import settings:
      • Send Client Welcome Email - Enable to send a welcome email to clients for newly created accounts. Select the template from the dropdown menu, and set the status to Yes to activate.
      • Reset Service Account Passwords - Set to Yes to auto-generate new passwords for imported accounts.
      • Send Service Welcome Email - Set to Yes to send a welcome email for existing products only.
      • Set Recurring Billing Information - Enable to automatically set billing based on the selected cycle. This applies to existing products only.
    • Once configured, press Continue to complete the account synchronisation process.
  1. Step 4: Summary - Wait a moment for synchronization to complete. A success message will confirm the server synchronization completion.

Important!
The synchronization process verifies account existence in both WHMCS and PanelAlpha. This means that if a service exists in WHMCS but is no longer available in PanelAlpha, it may be removed from WHMCS during synchronization.

Services that no longer exist in PanelAlpha but still have active corresponding accounts in WHMCS are marked as shown on the screen below and can be selected in Step 2 of the account synchronization process. These services will be deleted from WHMCS upon successful completion of the process.

# Additional information

  1. Domain Require - The WHMCS option that determines whether a client needs to provide a domain when placing an order has been hidden from WHMCS product "Details" section. For PanelAlpha services, this field is automatically populated based on the onboarding type defined in the plan associated with the product.