Configure the server module, product automation and optional profile quantity choices.
Packagevpn-dashboard-whmcs.zip
Install inmodules/servers/vpn_dashboard
Provider keywhmcs
01
Install
Put the module in the right place.
Download the WHMCS ZIP from Integration downloads in your VPN Dashboard account.
Extract it and copy the vpn_dashboard directory into modules/servers in your WHMCS installation.
Create or edit a WHMCS product and choose VPN Dashboard on its Module Settings tab.
Download it from your account.Module packages are private and the current ZIP is available under Integration downloads after sign-in.
02
Connect
Add the dashboard connection.
Enter the HTTPS address of your hosted dashboard.
Enter the billing API token, SSO signing secret and webhook signing secret from the matching billing connection in VPN Dashboard.
Set the provider key to whmcs, run Test Connection and add the WHMCS server public IP to the billing API allow-list.
Use one matching provider key.The module, billing connection and customer sign-in settings must use whmcs.
03
Product
Set up the VPN product.
Set the default, minimum and maximum profile quantities and choose shared or dedicated server access.
To sell a selectable quantity, create a configurable option named profile_limit, vpn_dashboard_profile_limit, vpn_profiles, vpn_profile, profiles or profile_count.
Choose the normal WHMCS module automation timing for account creation and service changes.
04
Customer access
Add the customer-area link.
The WHMCS service overview includes a signed link to the customer VPN area. The link expires after five minutes.
Keep the SSO signing secret private. Change it in both systems if it is ever exposed.
Configuration reference
Settings used by WHMCS.
Connection settings apply to the module. Product settings apply to each plan.
Connection settings5 fields
Dashboard URLRequired HTTPS address
The address of your hosted VPN Dashboard, without an API path.
Billing API tokenRequired secret
Copy the token from the matching billing connection in VPN Dashboard.
SSO signing secretRequired, at least 32 characters
Signs the short-lived link that takes a customer from their billing account to the VPN area.
Webhook signing secretBlank or at least 32 characters
Signs write requests from the module. Leave it blank only when the billing server IP is enforced through the API allow-list.
Provider keywhmcs
Must match the provider key on the billing connection and customer sign-in settings.
Product settings5 fields
Default profiles50 by default
Used when no recognised WHMCS configurable option supplies a quantity.
Minimum profiles1 by default
The lowest profile quantity the module accepts.
Maximum profiles10,000 by default
The highest profile quantity the module accepts.
Server access typeShared or dedicated; shared by default
Dedicated services wait for dedicated VPN server capacity.
Configurable optionOptional profile quantity
Use a recognised option name such as profile_limit when customers should choose the allowance.
Service lifecycle
What WHMCS sends.
Create AccountCreates the VPN service and customer access.
Change PackageUpdates the existing service and profile allowance.
Suspend AccountSuspends VPN access for that service.
Unsuspend AccountRestores VPN access for that service.
Terminate AccountCancels VPN access for that service.
Before launch
Check the complete order path.
The module connection check succeeds.
The product creates the expected profile allowance and server access type.
The customer link opens the correct branded VPN area.
Suspension and restoration update the same service.
Cancellation removes access from the same service.
Module notes
Details specific to WHMCS.
The external service ID is based on the immutable WHMCS service ID.
The selected quantity is stored as the profile_limit service property.
Use the same provider key for the billing connection and customer sign-in settings.
Ready to install?
Download the WHMCS module from your account.
The package and its version details are kept under Integration downloads.
