Disk Space and Bandwidth Overage Billing - Revision history

Lawrence: /* Invoicing */

2022-09-13T12:17:11Z

‎Invoicing

Lawrence: /* Invoicing */

2022-09-13T12:17:00Z

‎Invoicing

SarahK at 19:00, 21 April 2022

2022-04-21T19:00:48Z

PeterM: Changes to Custom Fields and Configurable Options

2021-02-09T16:09:40Z

Changes to Custom Fields and Configurable Options

SarahK at 13:57, 5 August 2020

2020-08-05T13:57:51Z

Nathan: /* Invoicing */

2017-11-07T20:58:43Z

‎Invoicing

Nathan at 20:58, 7 November 2017

2017-11-07T20:58:16Z

John at 15:18, 25 June 2014

2014-06-25T15:18:52Z

John: /* Notes */

2014-06-25T15:07:40Z

‎Notes

John: /* Notes */

2014-03-05T15:39:43Z

‎Notes

@@ Line 27: / Line 27: @@
 Overage invoice line items are generated with a format as follows:
-Shared Hosting - whmcsdemo.com (01/05/2014 - 31/05/2014)
+ Shared Hosting - whmcsdemo.com (01/05/2014 - 31/05/2014)
   Total Disk Usage = 1.5 GB - Overage Charge = 0.5 GB @ 1.50/GB

@@ Line 27: / Line 27: @@
 Overage invoice line items are generated with a format as follows:
- Shared Hosting - whmcsdemo.com (01/05/2014 - 31/05/2014)
+Shared Hosting - whmcsdemo.com (01/05/2014 - 31/05/2014)
   Total Disk Usage = 1.5 GB - Overage Charge = 0.5 GB @ 1.50/GB

@@ Line 3: / Line 3: @@
 *Usage charges are calculated on the last day of each month
 *They can be invoiced on the last day of the month independantly from the related product or added as billable items to be included on the next invoice the client gets sent
-*Native support is included for '''cPanel, Plesk & DirectAdmin''' modules using the values returned from the respective control panel API's but this feature can also be used by developers with their own control panels passing usage data direct to the WHMCS database
+*Native support is included for cPanel, Plesk, and DirectAdmin modules using the values returned from the respective control panel API's but this feature can also be used by developers with their own control panels passing usage data direct to the WHMCS database
 ==How to Configure==
-*The configuration of overage billing is done on a per product basis on the '''Other''' tab of product configuragion at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.
+To enable and configure overage billing for a product:
-*To enable it for a product, begin by ticking the '''Overages Billing''' checkbox
-*Next enter the '''Soft Disk Limit''' and '''Soft Bandwidth Limit''' which should be the amounts included with the package - anything over this amount is what's considered the over usage - can be zero to bill solely based on use
+# Go to the '''Other''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.
-*Then enter the cost for disk space and bandwidth in your default currency into the '''Disk Overages Cost''' and '''Bandwidth Overages Cost''' fields - these can be set up to 4 decimal places and will be multipled by the overused amount.
+# Check '''Overages Billing'''.
-*Choose the unit overages will be measured in (Megabytes, Gigabytes or Terabytes)<br/>1 GB = 1024 MB, 1 TB = 1024 GB.
+# Enter the '''Soft Disk Limit''' and '''Soft Bandwidth Limit''' to include with the package.
-*Click save to complete the changes
+# Enter the cost for disk space and bandwidth in your default currency for '''Disk Overages Cost''' and '''Bandwidth Overages Cost'''.
-*Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.
+#* You can use up to four decimal places.
-*Use the Overage Billing Charges option to choose when clients are invoiced for their overage usage.
+#* The system will multiply this by the overused amount.
 ==Invoicing==
@@ Line 30: / Line 34: @@
 ==Custom Fields and Configurable Options==
-The '''Overage Billing''' limits defined for a '''Product/Service''' can be overridden by '''Product Custom Fields''' or '''Configurable Options''', named either '''Disk Space''' and/or '''Bandwidth'''. The values provided will instead be used when performing overage calculations.
+The overage billing limits for a product can be overridden by custom fields or configurable options named either '''Disk Space''' or '''Bandwidth'''. The values provided will instead be used when performing overage calculations.
 For example, if the soft disk limit was set to 10MB, and a configurable option was set to 20MB, then the client would only be charged for overage once they go above 20MB.
-When setting up a '''Configurable Option''' for the purpose of overriding '''Overage Billing Limits''', the Option Type can be any which returns a numerical value; this would be the Drop Down, Radio, and Quantity types. While only numerical values can be used as options, the [[Addons_and_Configurable_Options#Friendly_Display_Names|Friendly Display Names]] functionality can be used to display non-numerical values to the customer. The unit of measurement is obtained from the '''Other''' tab of the product configuration at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''. For example:
+When setting up a configurable option for the purpose of overriding overage billing limits, the option type can be any that returns a numerical value (''Drop Down'', ''Radio'', or ''Quantity''). While only numerical values can be used as options, [[Addons_and_Configurable_Options#Friendly_Display_Names|friendly names]] can display non-numerical values to the customer. The unit of measurement is obtained from the '''Other''' tab of the product configuration at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''. For example:
 |150GB
@@ Line 40: / Line 44: @@
 |999MB
-The '''Configurable Option''' value will always use the same unit of measurement configured in the product configuration '''Other''' tab, although the [[Addons_and_Configurable_Options#Friendly_Display_Names|Friendly Display Names]] functionality does allow you to display a different unit of measurement if required. For example, if the product is configured with MB as the unit of measurement but it is desirable to display 10 Gigabytes to clients:
+The '''Configurable Option''' value will always use the same unit of measurement configured in the product configuration '''Other''' tab, although [[Addons_and_Configurable_Options#Friendly_Display_Names|friendly names]] allow you to display a different unit of measurement if required. For example, if the product is configured with MB as the unit of measurement but it is desirable to display 10 Gigabytes to clients:
 |10 Gigabytes
-When setting up a '''Product Custom Field''' for the purpose of overriding '''Overage Billing Limits''', the Field Type can be any which returns a numerical value; this would be the Text Box, Drop Down, and Text Area types. Additionally, it is important to note that values defined by a '''Configurable Option''' will override values set by a '''Product Custom Field'''. As with '''Configurable Options''', the unit of measurement is obtained from the '''Other''' tab of the product configuration at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.
+When setting up a '''Product Custom Field''' for the purpose of overriding '''Overage Billing Limits''', the Field Type can be any which returns a numerical value; this would be the Text Box, Drop Down, and Text Area types. Additionally, it is important to note that values defined by a '''Configurable Option''' will override values set by a '''Product Custom Field'''. As with '''Configurable Options''', the unit of measurement is obtained from the '''Other''' tab of the product configuration at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products and Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.
 ==Notes==
 If you only wish to charge for one of the items (ie. charge only for bandwidth overages) set the soft disk limit to a very high value, say 999999999. That way the user will never exceed it and thus never be charged for any disk overage.
-If you'd like to have WHMCS automatically suspend a service when its overage costs are not paid, the ''Include on the Next Invoice'' option must be selected at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' or, prior to WHMCS 8.0, ''Setup > Automation Settings''.
+If you'd like to have WHMCS automatically suspend a service when its overage costs are not paid, the ''Include on the Next Invoice'' option must be selected at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Automation Settings]]''' or, prior to WHMCS 8.0, ''Setup > Automation Settings''.
-Overage billing may only be configured in your system's default currency. WHMCS will automatically convert overage prices into a client's currency using the rates listed at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Currencies''' or, prior to WHMCS 8.0, '''Setup > Currencies'''.
+Overage billing may only be configured in your system's default currency. WHMCS will automatically convert overage prices into a client's currency using the rates listed at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Currencies]]''' or, prior to WHMCS 8.0, '''Setup > Currencies'''.

@@ Line 30: / Line 30: @@
 ==Custom Fields and Configurable Options==
-The Overage Billing limits defined for a Product/Service can be overridden by Product Custom Fields or Configurable Options named either "Disk Space" and/or "Bandwidth". The values provided will instead be used when performing overage calculations.
+The '''Overage Billing''' limits defined for a '''Product/Service''' can be overridden by '''Product Custom Fields''' or '''Configurable Options''', named either '''Disk Space''' and/or '''Bandwidth'''. The values provided will instead be used when performing overage calculations.
-−
 For example, if the soft disk limit was set to 10MB, and a configurable option was set to 20MB, then the client would only be charged for overage once they go above 20MB.
-−
-When setting up a Configurable Option for the purpose of overriding Overage Billing Limits the Option Type can be any which returns a numerical value; this would be the Drop Down, Radio, and Quantity types. While only numerical values can be used as options the [[Addons_and_Configurable_Options#Friendly_Display_Names|Friendly Display Names]] functionality can be used to display non-numerical values to the customer.
+When setting up a '''Configurable Option''' for the purpose of overriding '''Overage Billing Limits''', the Option Type can be any which returns a numerical value; this would be the Drop Down, Radio, and Quantity types. While only numerical values can be used as options, the [[Addons_and_Configurable_Options#Friendly_Display_Names|Friendly Display Names]] functionality can be used to display non-numerical values to the customer. The unit of measurement is obtained from the '''Other''' tab of the product configuration at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''. For example:
-−
-When setting up a Product Custom Field for the purpose of overriding Overage Billing Limits the Field Type can be any which returns a numerical value; this would be the Text Box, Drop Down, and Text Area types. Additionally, it is important to note that values defined by a Configurable Option will override values set by a Product Custom Field.
+|150GB
 ==Notes==

@@ Line 7: / Line 7: @@
 ==How to Configure==
-*The configuration of overage billing is done on a per product basis on the '''Other''' tab of product config (Setup > Products/Services > Edit > Other tab).
+*The configuration of overage billing is done on a per product basis on the '''Other''' tab of product configuragion at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services'''.
 *To enable it for a product, begin by ticking the '''Overages Billing''' checkbox
 *Next enter the '''Soft Disk Limit''' and '''Soft Bandwidth Limit''' which should be the amounts included with the package - anything over this amount is what's considered the over usage - can be zero to bill solely based on use
@@ Line 13: / Line 13: @@
 *Choose the unit overages will be measured in (Megabytes, Gigabytes or Terabytes)<br/>1 GB = 1024 MB, 1 TB = 1024 GB.
 *Click save to complete the changes
-*Navigate to '''Setup > Automation Settings''' and use the Overage Billing Charges option to choose when clients are invoiced for their overage usage.
+*Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' or, prior to WHMCS 8.0, '''Setup > Automation Settings'''.
 ==Invoicing==
@@ Line 40: / Line 41: @@
 If you only wish to charge for one of the items (ie. charge only for bandwidth overages) set the soft disk limit to a very high value, say 999999999. That way the user will never exceed it and thus never be charged for any disk overage.
-If you'd like to have WHMCS automatically suspend a service when its overage costs are not paid, the ''Include on the Next Invoice'' option must be selected at ''Setup > Automation Settings''.
+If you'd like to have WHMCS automatically suspend a service when its overage costs are not paid, the ''Include on the Next Invoice'' option must be selected at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Automation Settings''' or, prior to WHMCS 8.0, ''Setup > Automation Settings''.
-Overage billing may only be configured in your system's default currency. WHMCS will automatically convert overage prices into a client's currency using the rates listed at Setup > Currencies.
+Overage billing may only be configured in your system's default currency. WHMCS will automatically convert overage prices into a client's currency using the rates listed at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Currencies''' or, prior to WHMCS 8.0, '''Setup > Currencies'''.

← Older revision		Revision as of 15:07, 25 June 2014
Line 21:		Line 21:

	If you'd like to have WHMCS automatically suspend a service when its overage costs are not paid, the ''Include on the Next Invoice'' option must be selected at ''Setup > Automation Settings''.		If you'd like to have WHMCS automatically suspend a service when its overage costs are not paid, the ''Include on the Next Invoice'' option must be selected at ''Setup > Automation Settings''.
		+
		+	Overages are calculated with a precision of one tenth of one gigabytyte. For example, an overage of 1.5 GB at $1.00 per GB will bill $1.50.

← Older revision		Revision as of 15:39, 5 March 2014
Line 20:		Line 20:
	If you have configurable options named "Disk Space" and "Bandwidth", then these will override the limits set on the Other tab. These will then be used in the overages calculations. So for example if the soft disk limit was set to 10MB and the configurable option set to 20MB the client would only be charged for overage once they go above 20MB.		If you have configurable options named "Disk Space" and "Bandwidth", then these will override the limits set on the Other tab. These will then be used in the overages calculations. So for example if the soft disk limit was set to 10MB and the configurable option set to 20MB the client would only be charged for overage once they go above 20MB.

−	To have ~~the~~ service ~~suspended if the~~ overage costs are not paid ~~it's necessary to select~~ the ''~~include~~ on the ~~next invoice to generate for the client~~'' ~~overage invoicing~~ option.	+	If you'd like to have WHMCS automatically suspend a service when its overage costs are not paid, the ''Include on the Next Invoice'' option must be selected at ''Setup > Automation Settings''.