User Tools

Site Tools




The billing menu is one of the major configuration items of the HSMX gateway. Here you configure all the different billing packages available to your subscribers. There are three types of billings plans:

  • Pre-paid billings plans: Guest pays in advance for a pre-defined time or volume
  • Post-paid billings plans: Guest pays after use of his connections, price depends on time and/or volume (only in combination with PMS module)
  • Free-access billings plans: Guest does not pay for the access for a specific time period or a specific amount of data volume, the free-access plan supports the recurrence value, this will determine how many times a guest can choose a free billing plan.

Billing overview

The overview page displays all the billing packages, it is possible to group billing plans to keep them organised. Still-in-use billing plans can be deleted but remain tied to a subscriber profile in the background, then are not deleted but hidden. Staff billing plans are only visible for admin users who have the staff option checked.

Adding a billing plan

Adding a billing plan can be done via the add icon in the navigation bar, you will have to select between pre-paid / post-paid or free access.


  • Name: Name of the billing plan the subscriber subscribed to.
  • Description: Description of the pack.
  • Price: Value of the package.
  • Bandwidth up (kbps): The maximum available upload bandwidth in kilo bits per seconds.
  • Bandwidth down (kbps): The maximum available download bandwidth in kilo bits per seconds.
  • Small bandwidth up/down (kbps): A fall back bandwidth available to the guest when the subscriber used up all available data volume (only when configured).
  • Small bandwidth reset: After this period, the full bandwidth is available again.
  • WAN connection: All clients with this billing will use the selected WAN connection (only available when load balancing is enabled).
  • URL Redirection: The URL that the user will be redirected to after login.
  • Staff: This option makes the billing plan only available for staff users.
  • Volume up: Available upload data volume, after that the package will expire or fall back on the small bandwidth configured.
  • Volume down: Available download data volume, after that the package will expire or fall back on the small bandwidth configured.
  • Network policy: A network policy (client firewall) tied to this package (see Network policies on how to configure policies).
  • QoS Profile: A QoS (Quality of Service) profile tied to this package (See QoS on how to configure a QoS policy)
  • Content filter: The content filter tied to this profile (See Content Filter for more information). In Gateway/Auth infrastructure this field becomes a text-field that links to the name of the content filter configured on the Auth HSMX server.
  • Upsell: When this is enabled and the system has available public IPs, the client will be using 1-to-1 NAT to an unique public IP
  • Idle-Timeout: The client connection will be closed after inactivity, the timeout can be configured here.
  • Session timeout: How long the account can be logged in. When the connection is closed, this timer also stops so they can reuse the remaining time at a later date.
  • Expiry timeout: How long the account is valid after first login.
  • Expiration after creation: How long the account is valid after creation
  • Start date: The account is only valid after this start date
  • End Date: the account will expire at this date.
  • Time based access: the account can only log in between start and end hour.
  • Calender days: The account is only valid on the days /hours specified in this calender day configuration.
  • Location: The account is only valid in this location.
  • Simultaneous use: How many simultaneous clients can connect with this account.
  • Limit account to x MAC addresses: The total amount of devices that can connect to this device, this is for the entire lifetime of the package so not just simultaneously.
  • Max concurrent packages: Limit the amount of simultaneous valid accounts associated with this package. Once the threshold is reached, it will not be offered to new subscribers.
  • Recurrence (free billing packages only): indicates if, how and when this free package can be resubscribed to when it expired.
  • Expire: When the account will expire, usually initialized after first login.
  • Delay expiration, if the package has the option set to expire on guest checkout an timeout can be set so the account is still valid for a few hours after checkout. (Hospitality module)
  • Sales outlet: A sales outlet can be used when charging this account. (Hospitality module)
  • Group: A profile can be tied to a subscriber group.

Upgrade Packages


A new way to give an upgrade path to users is by using upgrade packages. Upgrade packages allow a client to update their current package rather than buy a complete new package.

Upgrade packages are tied to a billing plan, this makes it possible to differentiate the shown upgrade packages depending on what the customer already has. For example when a user already has a high bandwidth package, you can only show packages to update time / amount of connections. When they are on a low bandwidth package you can show bandwidth upgrades. Upgrade packages are an ideal way to up-sell standard free Internet access and generate revenue (use Upgrade Rules to limit the shown options).

Upgrades packages are only usable together with PMS/Hospitality.


First off upgrade packages need to be enabled. By default we only show full package options when the user decides to upgrade his/her billing plan. In Billing / Setting you can configure the HSMX gateway to show upgrade packages instead of full plans.

To create an upgrade for a billing plan, click the upgrade icon (upwards arrow with plus sign) from the overview page. This show an overview of the selected billing plan (first column) and it's associated upgrades (subsequent columns). To create a new upgrade option, use the create link in the action section, this will add a new empty column to the overview you can configure with extra options (more time, bandwidth, volume …).

The option “Calculate price based on remaining time” will deduct the price you configure depending on how much time you've used your current package. For example if you used up half of your package, you will only pay 50% of the upgrade price.

The 'Upgrade package to' field allows you to provide neat (to clients transparent) upgrade paths between full billing plans. This is purely administratively. You still need to configure the effective difference between the two billing plans (added volume, bandwidth, …). Based on the full billing plan you can provide customized upgrade paths using upgrade rules (under Service / Rules / upgrade rules), this allows you to shield certain billing options from being available based on the subscribers current billing plan and/or other properties.

As soon as you created the upgrade packages they will be automatically become available for your clients as long as you have an upgrade compatible portal or use a portal from the portal page editor. (Make sure upgrade packages are enabled in general settings.)

Calendar days

Calender days allow you to specify special recurrent days and moments. It can for example be used to specify holidays, office hours or other cyclic or one-off events. These calendar days can be tied to a billing plan, accounts configured with this billing plan are only valid on the dates time configured in this calendar day.

MAC based

Here you can configure some limitations that are set for mac based users. These users have no authentication but with this module you can still configure their network options.

  • Bandwidth up (kbps): The maximum available upload bandwidth in kilo bits per seconds.
  • Bandwidth down (kbps): The maximum available download bandwidth in kilo bits per seconds.
  • Network policy: A network policy (client firewall) tied to this package (see Network policies)
  • QoS Profile: A QoS (Quality of Service) profile tied to this package (See QoS)
  • Content filter: The content filter tied to this profile (optional module) (See Content Filter)


Session time

Define how the session time will be calculated when the guest logs off. You can choose to use the measured start/stop times or (the second option) substract the idle time-out from the stop-time for a more realistic session-time.


Configure the VAT rate and currency to be used in reports, invoices, …

Upgrade settings

When a guest browses to the upgrade domain you can choose to show full billing-plans or upgrade packages. Enable upgrade packages and create packages in the billing sub-menu. When full plans are shown you can additionally offer a rebate based on the remaining time of the current plan.

Note: a custom portal needs to support upgrade packages/options. Please contact support for more information.

manual/billing.txt · Last modified: 2021/06/03 14:40 (external edit)