VPN Dashboard
← Paymenter integration

Installation guide

Connect Paymenter to VPN Dashboard.

Add the server extension, configure a product and choose whether customers select a quantity.

Packagevpn-dashboard-paymenter.zip
Install inextensions/Servers/VpnDashboard
Provider keypaymenter
01

Install

Put the module in the right place.

  1. Download the Paymenter ZIP from Integration downloads in your VPN Dashboard account.
  2. Extract it and copy VpnDashboard into extensions/Servers in your Paymenter installation.
  3. Create a Paymenter server using the VPN Dashboard extension.
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.

  1. Enter the HTTPS address of your hosted dashboard.
  2. Enter the billing API token, SSO signing secret and webhook signing secret from the matching billing connection in VPN Dashboard.
  3. Set the provider key to paymenter, run the extension connection check and add the Paymenter 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 paymenter.
03

Product

Set up the VPN product.

  1. Attach the VPN Dashboard server extension to the Paymenter product.
  2. Set the default, minimum and maximum profiles. Enable customer quantity only when buyers should choose the allowance.
  3. Choose protocols and shared or dedicated access. Traffic, profile rotation and support tier can also be set when the product needs them.
04

Customer access

Add the customer-area link.

An active Paymenter service includes an action that opens the customer VPN area using a five-minute signed link.

Keep the SSO signing secret private. Change it in both systems if it is ever exposed.

Configuration reference

Settings used by Paymenter.

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 keypaymenter
Must match the provider key on the billing connection and customer sign-in settings.
Product settings10 fields
Default profiles50 by default
Used when checkout does not supply a profile quantity.
Minimum profiles1 by default
The lowest quantity accepted from checkout.
Maximum profiles10,000 by default
The highest quantity accepted from checkout.
Let customers choose quantityOff by default
Adds a profile quantity field to Paymenter checkout.
Server accessShared or dedicated; shared by default
Controls whether the service uses your shared VPN server pool or waits for dedicated capacity.
Dedicated servers1 by default
Used only when Server access is set to dedicated.
VPN protocolsBoth, WireGuard only or OpenVPN only
Sets which profile types the customer can create. Both protocols are enabled by default.
Monthly traffic (GB)Optional
Leave blank to use the dashboard default.
Profile rotation (days)Optional
Leave blank when profiles should not expire automatically.
Support tierstandard by default
A lowercase plan key sent with the service. Change it only when matching tiers exist in your dashboard.

Service lifecycle

What Paymenter sends.

Create serviceCreates VPN access and returns the customer sign-in information.
Upgrade serviceUpdates the existing profile and plan settings.
Suspend serviceSuspends VPN access for that service.
Unsuspend serviceRestores VPN access for that service.
Terminate serviceCancels VPN access for that service.

Before launch

Check the complete order path.

  1. The module connection check succeeds.
  2. The product creates the expected profile allowance and server access type.
  3. The customer link opens the correct branded VPN area.
  4. Suspension and restoration update the same service.
  5. Cancellation removes access from the same service.

Module notes

Details specific to Paymenter.

  • A dedicated service can request one or more dedicated servers and remain pending until capacity is assigned.
  • The checkout quantity field is only added when Let customers choose quantity is enabled.
  • Use the connection check before attaching the extension to a live product.

Ready to install?

Download the Paymenter module from your account.

The package and its version details are kept under Integration downloads.

Sign in to download