Skip to content
VirtlixCP

Documentation / Integrations

WHMCS Module for VPS

Set Product Type to KVM VPS. When an order is paid, the module creates a VPS for the client with the WHMCS service's hostname and password.

Module settings

Setting Example What it does
VPS vCPU 2 Virtual CPUs
VPS Memory (MB) 2048 Memory in MB
VPS Disk (GB) 40 Disk size
VPS OS Template alma-9 Template slug from VPS, OS Templates
VPS IP Pool OVH additional IPs IP pool name or ID. Comma-separated to try several
VPS Hypervisor Optional hypervisor name or ID. Blank picks the one with most free memory that has the template
VPS Port Speed (Mbps) 1000 Download and upload speed
VPS Bandwidth (GB) 2000 Monthly transfer. Blank for unmetered. The VPS is powered off when it runs out

The template must be downloaded on the hypervisor first. Check VPS Settings on a service in WHMCS confirms the template, IP pool and hypervisor work.

Configurable options

All optional. Each one overrides the matching module setting, so one product can offer several sizes, systems or locations. Put the value before |.

Option name Example value
vCPU 2|2 vCPU
Memory 2048|2 GB RAM (MB, or 2GB)
Disk 40|40 GB SSD
Operating System alma-9|AlmaLinux 9
Location OVH additional IPs|Gravelines
Port Speed 1000|1 Gbps
Bandwidth 2000|2 TB or 0|Unmetered
Plan VPS M|VPS M: a plan name or ID from VPS, Plans. Its size, port speed and bandwidth are used unless the options above are set
Control Panel plesk|Plesk, hestiacp|HestiaCP, cpanel|cPanel, webuzo, cloudpanel, a recipe name from VPS, Recipes, or none|No panel

A control panel is installed after the OS is up; see Control Panels, Recipes and SSH Keys. cPanel, Plesk and HestiaCP need a full hostname, like server1.example.com, as the service's domain.

SSH key on order

Add a product Custom Field named SSH Key (Text Area). The key the client pastes on the order form is added to the VPS's root account.

What each action does

WHMCS action In VirtlixCP
Create Creates the VPS with the service's hostname and password, and assigns it to the client
Suspend Suspends the VPS: it shuts down, and the client sees it as suspended, with the WHMCS suspension reason, but can't start it
Unsuspend Lifts the suspension and starts the VPS
Terminate Deletes the VPS and its disk and frees its IP
Change Package Applies the new port speed and bandwidth, then resizes. Disks only grow
Change Password Sets the VPS's root password (Administrator on Windows). A running Linux VPS takes it straight away, without a restart
Usage Update Copies this month's bandwidth into WHMCS

Client area

Clients see the status (with the reason when suspended), username and password (hidden until Show), how to connect, any extra IP addresses, the OS, resources, port speed and this month's bandwidth, with Start, Shut Down and Reboot buttons. Manage on VirtlixCP signs them into the panel's VPS page for the console, reinstall, password, hostname, DNS and live graphs.

Admins get Start, Shut Down, Reboot, Power Off, Check VPS Settings, Fill Fields and Set Hostname from Domain, which renames the VPS to the hostname in the service's Domain field (a running Linux VPS without a restart).

Change Password and Set Hostname from Domain need the module from 26 October 2026 or later; without a restart needs VirtlixCP 5.5.22.