The module handles the complete VPN service lifecycle, including peer creation, bandwidth enforcement, suspension, unsuspension, termination, configuration delivery, and usage-based billing.
Clients can access their connection details, scan a configuration QR code, download a ready-to-use configuration file, and review traffic statistics in the client area, while administrators can monitor configured routers, inspect live WireGuard peers, and review traffic usage from one central addon module.

This tutorial will show you how to successfully install and configure MikroTik WireGuard VPN For WHMCS.
We will guide you step by step through the installation process, MikroTik server connection, product configuration, metric billing setup, addon module management, and client area features.

The files should be uploaded into the corresponding WHMCS folders.

The file is located in 'modules/addons/MikroikWireGuardVpn For WHMCS/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

• Find MikroTik WireGuard VPN on the list and click Activate.
• Set access permissions for the required administrator roles and save the changes.
  

The addon module can now be opened through Addons → MikroTik WireGuard VPN.

Before connecting the router to WHMCS, make sure that:

• MikroTik RouterOS 7.20 or later is installed.
• A WireGuard interface has been created on the router.
• The RouterOS REST API is available.
• The API user has permissions sufficient to manage WireGuard peers, addresses, queues, and traffic data required by the module.
• The selected HTTP or HTTPS service and port are accessible from the WHMCS server.
• When a secure connection is used, HTTPS and a valid router certificate are configured correctly.

The module communicates with the router exclusively through the MikroTik RouterOS REST API. Legacy API and Winbox access are not required.

The module uses the standard WHMCS server infrastructure. Choose MikroTik WireGuard VPN from the Module dropdown menu and provide the router connection details.

Configure the following fields:

• Name – enter a descriptive server name.
• Hostname – provide the router hostname or IP address.
• Username – enter the RouterOS API username.
• Password – enter the password assigned to the API user.
• Port – provide the port used by the RouterOS REST API. The default HTTPS port is 443.
• Secure – enable to connect through HTTPS; leave disabled only when an HTTP connection is intentionally used.

If the test is successful, save the server configuration.

The server group can later be selected in the product's module settings. Add multiple routers when you want to distribute VPN services across a larger infrastructure.

Open the Module Settings tab and select MikroTik WireGuard VPN as the module.

The available settings include:

• Server Group – select the group containing the MikroTik router that will host the VPN peer.

• General
  • WireGuard Interface – enter the WireGuard interface used for the service.
  • Comment Prefix – define the prefix added to comments identifying module-created peers.
• Bandwidth
  • Upload Speed Limit – define the maximum upload speed assigned to the service.
  • Download Speed Limit – define the maximum download speed assigned to the service.
• Client Configuration
  • Tunnel IP Address Pool - assign tunnel IP addresses individually or define an IP address range. Separate the first and last address in the range with a hyphen, for example: 192.168.0.3-192.168.0.14
  • Allowed IP Addresses – specify the addresses or networks routed through the VPN tunnel.
  • DNS Servers – define the DNS servers included in the client configuration.
  • Keepalive Interval (seconds) – set the keepalive interval in seconds.
• Client Area Features
  • Enable Traffic Statistics – enable traffic data collection and presentation.
  • Statistics Retention (days) – define how long collected traffic records should be stored.
  • Help / Setup Guide URL – provide a link to your VPN setup instructions.
  • Client Downloads URL – provide a link clients can use to download the WireGuard application.

Depending on the selected WHMCS option, the VPN account may be created automatically after the first payment, immediately after order placement, or manually by an administrator.

The Metric Billing section allows you to control which traffic metrics are billed through the native WHMCS metric billing system.

Use the switch next to each metric to enable or disable billing. When enabled, the metric usage is reported to WHMCS and included in usage-based billing. Disabled metrics are not billed.

Select Configure Pricing below each metric to define the included traffic allowance and the price charged for each additional gigabyte. Download and upload pricing can be configured independently for every available billing cycle.

The addon module provides a centralized overview of MikroTik servers, WireGuard accounts, traffic, and module activity.
Navigate to Addons → MikroTik WireGuard VPN to open it.

The statistics widgets show the numbers of configured servers, active services, suspended services, and provisioned VPN accounts. The Traffic Overview (Last 30 Days, GB) graph presents the total recorded traffic.

For each entry, you can review its name, hostname, connection port, connection scheme, number of assigned services, and current status.

Use search and filters to locate a specific peer or narrow the list by its current state.

For each peer, the list may include:

• peer comment
• WireGuard interface
• allowed address
• public key
• peer state
• received and transmitted traffic
• last handshake
• related WHMCS service, when available

For precise details on Logs, please refer to our dedicated documentation article, which you may find here.

Prepare translations for the original English files with this handy built-in tool. For specific instructions on how to use this tool please refer to its dedicated article, you will find it here.

This feature allows you to assign permissions, define resource access for administrators, and track activities with detailed logs.
Customize access settings to fit your team’s structure and maintain transparency with ease. For comprehensive guidance, refer to the tool's dedicated article.

Open a client's product or service in the WHMCS admin area to manage the related WireGuard VPN account.

Administrators can also perform the standard module commands:

• Create
• Suspend
• Unsuspend
• Terminate
• Change Package

Resetting the VPN interface disables and re-enables the WireGuard peer to force a new handshake. The assigned keys, tunnel IP address, and configuration remain unchanged.

Switch between daily and monthly views to analyze usage over the required period. The metric statistics panel also shows the current download and upload totals and allows administrators to refresh the counters directly from the router.

Administrators can preview the generated configuration or download it as a ready-to-use .conf file.

The client area gives customers direct access to their WireGuard VPN service and the resources required to configure a connection.

Depending on the product configuration, clients can also open the setup guide and download the WireGuard application.

Available client actions include:

• previewing the WireGuard configuration
• scanning the configuration QR code
• downloading the ready-to-use .conf file
• resetting the VPN interface
• opening the setup guide
• downloading the WireGuard client

The same configuration can be downloaded as a ready-to-import .conf file.

Statistics can be displayed in daily or monthly intervals.

The action does not change the assigned keys, tunnel IP address, or configuration. The client must confirm it before it is performed.

The module uses the standard WHMCS automation cron for traffic collection, metric usage reporting, and data maintenance.
Make sure that the main WHMCS automation cron is configured and running according to the official WHMCS documentation.

An essential guidance through the module update process can be found here.

• Verify the router hostname or IP address and REST API port.
• Make sure the selected HTTP or HTTPS service is enabled and reachable from the WHMCS server.
• Confirm the API username, password, and assigned RouterOS permissions.
• If Secure is enabled, verify the router certificate and HTTPS configuration.

• Make sure the selected WireGuard interface exists on the target router.
• Check whether the configured tunnel IP address pool contains an available address.
• Review the module logs for the exact RouterOS API response.
• Verify that the API user can manage the resources required by the module.

• Confirm that traffic statistics are enabled in the product's module settings.
• Make sure the WHMCS metric billing cron is running correctly.
• Allow the module enough time to collect the first traffic records.
• Use Refresh Now on the service page to read the current counters from the router on demand.
• Review the module logs for traffic collection errors.

• Enable usage-based metric billing in the product's module settings.
• Configure pricing for the Download (GB) and Upload (GB) metrics in WHMCS.
• Confirm that traffic usage is being collected and reported.
• Verify that the WHMCS automation cron is running.