Usage Billing - Revision history

JuanR: /* Usage Data Collection */

2022-11-28T14:41:57Z

‎Usage Data Collection

SarahK: /* Extensibility */

2022-05-09T21:04:10Z

‎Extensibility

SarahK: /* Invoicing and Billing */

2022-05-09T21:03:45Z

‎Invoicing and Billing

SarahK at 18:39, 3 February 2022

2022-02-03T18:39:40Z

SarahK at 17:50, 3 February 2022

2022-02-03T17:50:37Z

John at 13:21, 29 December 2020

2020-12-29T13:21:36Z

DanR: /* Configuring Metric Pricing */

2020-12-20T20:25:14Z

‎Configuring Metric Pricing

DanR: /* Getting Started */

2020-12-20T20:22:25Z

‎Getting Started

DanR: /* Extensibility */

2020-12-20T20:15:05Z

‎Extensibility

SarahK: /* Client Area */

2020-12-01T21:43:21Z

‎Client Area

← Older revision		Revision as of 14:41, 28 November 2022
Line 112:		Line 112:

	Custom cron invocations can use the option "--TenantUsageMetrics" to fire or suppress its execution.		Custom cron invocations can use the option "--TenantUsageMetrics" to fire or suppress its execution.
		+
		+	<div class="docs-alert-info">
		+	<span class="title">Server Timezones</span><br />
		+	Your server's timezone must match the WHMCS server's timezone to prevent incorrect reporting. For more information, see [https://docs.cpanel.net/whm/server-configuration/server-time/ Server Time].
		+	</div>

	==Extensibility==		==Extensibility==

← Older revision		Revision as of 21:04, 9 May 2022
Line 117:		Line 117:
	Module developers can define metrics and collection routines for metrics that are to be made available for display and usage billing by a provisioning module.		Module developers can define metrics and collection routines for metrics that are to be made available for display and usage billing by a provisioning module.

−	To learn more, ~~visit the Provisioning Module developer docs at~~ https://developers.whmcs.com/provisioning-modules/usage-metrics/	+	To learn more, see our [https://developers.whmcs.com/provisioning-modules/usage-metrics/ Provisioning Module documentation].

@@ Line 103: / Line 103: @@
 ==Invoicing and Billing==
-You can enable usage billing using the '''Enable Metric Usage Invoicing''' setting in the '''[[Invoice Tab|Invoice]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings]]'''.
+You can enable usage billing using the '''Enable Metric Usage Invoicing''' setting in the '''[[Invoice Tab|Invoice]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
 ==Usage Data Collection==

@@ Line 1: / Line 1: @@
 <div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.9 and above</div>
-Usage billing in WHMCS allows you to setup products which contain variable priced items whose price is determined at the time of invoicing based on usage data provided to WHMCS.
+Usage billing in WHMCS allows you to set up products that contain variable-priced items whose price is determined at the time of invoicing based on usage data provided to WHMCS.
 The following are some example use cases for Usage Billing:
@@ Line 14: / Line 9: @@
 * A hosting company offers a hosting package with 10GB of bandwidth included and charges $1.00 per GB used over that
 * A hosting company offers reseller hosting that allows you to create 10 cPanel Accounts as standard, but charges you $0.20 per account after that
 <div class="docs-alert-success">
@@ Line 20: / Line 22: @@
 </div>
-==Getting Started==
+== Configuring Usage Billing and Metrics ==
 Products associated with capable provisioning modules can capture metrics. These metrics can be can be priced and billed or simply enabled for display purposes.
-Metrics are enabled in '''Module Settings''' in '''[[Products_and_Services|Products/Services]]'''. If the selected module supports metrics, the '''Metric Billing''' section will be populated with each metric it can observe.
+You can enable metrics for a product in the '''Module Settings''' 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 > Products/Services'''.
 [[File:Usage-billing-module-settings-metric-config.png]]
-To enable a metric for billing or display purposes, slide the toggle to '''On'''.  If a metric is enabled, it will appear within the client's product details view of the client area.  An admin will always see all metrics, enabled or disabled, within the admin area when viewing a service belonging to a product which reports metrics.
+If a metric is enabled, it will appear within the client's product details view of the client area.  An admin will always see all metrics, enabled or disabled, within the admin area when viewing a service belonging to a product which reports metrics.
 <div class="docs-alert-success">
-<span class="title">Tip</span><br />
+<span class="title">More Information</span><br />
-Check out our blog article on Usage Billing for an in-depth look into how Usage Billing works [https://blog.whmcs.com/133590/usage-billing-in-depth here.]
+* Check out our blog article on Usage Billing for an in-depth look into how Usage Billing works [https://blog.whmcs.com/133590/usage-billing-in-depth here.]
 </div>
-==Configuring Metric Pricing==
+=== Configuring Metric Pricing ===
-* '''Metric Type''' - A Metric Type defines how the metric is measured. This can be one of either Snapshot, Daily or Monthly.
+To configure metric pricing, click '''Configure Pricing''' for that metric in the '''Module Settings''' 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 > Products/Services'''.
 [[File:Usage-billing-metric-pricing-config.png]]
-<div class="docs-alert-info"><i class="fa fa-info-circle"></i> Unsure how to get started billing clients for their usage? - Check out our step by step guide to get started [https://help.whmcs.com/m/setup/l/1184631-billing-clients-for-their-usage here.]</div>
+Metric pricing can be configured using any of the following pricing schemes:
-* '''Per Unit:''' Charge the same amount per unit
+* '''Per Unit''' — Charge the same amount for each unit.
-* '''Total Volume:''' The per unit price is determined by the total volume consumed.
+* '''Total Volume''' — Charge a per-unit price based on the total volume consumed.
-* '''Graduated:''' The per unit price is per consumption range. The total charge is the sum of the range calculations.
+* '''Graduated''' — Charge a per-unit price based on the consumption range. The total charge is the sum of the range calculations.
-For the Total Volume and Graduated pricing schemes, pricing must be defined in brackets.
+For '''Total Volume''' and '''Graduated''' pricing schemes, you '''must''' enter pricing in the text boxes.
-You can create as many different pricing brackets as you wish. Pricing brackets start immediately following the Quantity Included number.
+You can create as many different pricing brackets as you wish.
-We’ll use the same bracket information in the examples below to indicate how the price billed can vary using different schemes.
+The examples below illustrate how the price billed can vary using different schemes.
-===Per Unit Pricing===
+==== Per Unit Pricing ====
 Per unit pricing is the simplest pricing mode we offer. Enter a cost per unit and you’re done.
@@ Line 72: / Line 62: @@
 In a per-unit pricing scheme, prices are defined as per-unit costs, and all units cost the same. Thus, only 1 price bracket may be defined. For example if you used Per Unit pricing for "Addon Domains" and defined a cost of $1/each/period and a customer buys 3, then a $3 charge would be added at the end of the period.
-===Total Volume Pricing===
+==== Total Volume Pricing ====
 In the total volume pricing scheme, multiple price brackets define the prices at different quantity levels. The price per unit for all units is determined by the prevailing price for the total used quantity. An example can illustrate this the best. Say you allow your customers to use an unlimited number of MySQL Databases with a pricing structure defined as follows:
@@ Line 86: / Line 76: @@
 If a customer uses 25 MySQL Databases, they will pay $0.50 per database, for a total of '''$12.50'''.
-===Graduated Pricing===
+==== Graduated Pricing ====
 In the graduated pricing scheme, multiple price brackets define the prices at different quantity levels, much like in the Total Volume scheme. However, unlike the total volume scheme, your customers will pay the defined price per unit for each allocated unit. Let's see how this changes the price a customer pays using the same pricing brackets as pictured above.

@@ Line 113: / Line 113: @@
 ==Invoicing and Billing==
-Usage billing invoicing is globally controlled by the "Enable Metric Usage Invoicing " option found within the Invoicing tab of General Settings.
+You can enable usage billing using the '''Enable Metric Usage Invoicing''' setting in the '''[[Invoice Tab|Invoice]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings]]'''.
 ==Usage Data Collection==

← Older revision		Revision as of 20:25, 20 December 2020
Line 44:		Line 44:

	[[File:Usage-billing-metric-pricing-config.png]]		[[File:Usage-billing-metric-pricing-config.png]]
		+
		+	<div class="docs-alert-info"><i class="fa fa-info-circle"></i> Unsure how to get started billing clients for their usage? - Check out our step by step guide to get started [https://help.whmcs.com/m/setup/l/1184631-billing-clients-for-their-usage here.]</div>

	==Pricing Schemes Explained==		==Pricing Schemes Explained==

← Older revision		Revision as of 20:22, 20 December 2020
Line 31:		Line 31:

	To configure pricing for a metric, click the "Configure Pricing" under the given metric name.		To configure pricing for a metric, click the "Configure Pricing" under the given metric name.
		+
		+	Check out our blog article on Usage Billing for an in-depth look into how Usage Billing works [https://blog.whmcs.com/133590/usage-billing-in-depth here.]

	==Configuring Metric Pricing==		==Configuring Metric Pricing==

← Older revision		Revision as of 20:15, 20 December 2020
Line 128:		Line 128:
	Module developers can define metrics and collection routines for metrics that are to be made available for display and usage billing by a provisioning module.		Module developers can define metrics and collection routines for metrics that are to be made available for display and usage billing by a provisioning module.

−	To learn more, visit the Provisioning Module developer docs at https://developers.whmcs.com/provisioning-modules/	+	To learn more, visit the Provisioning Module developer docs at https://developers.whmcs.com/provisioning-modules/usage-metrics/

← Older revision		Revision as of 21:43, 1 December 2020
Line 103:		Line 103:

	The notable difference is any disabled metrics will not appear here. Only metrics that are enabled for billing will be displayed.		The notable difference is any disabled metrics will not appear here. Only metrics that are enabled for billing will be displayed.
−
−	~~[[File:Usage-billing-client-metric-view.png]]~~

	==Invoicing and Billing==		==Invoicing and Billing==