Difference between revisions of "Product Addons"

From WHMCS Documentation

m (How addons are displayed)
(Module Settings)
 
(27 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Product Addons let you offer additional items which the client has a yes/no choice over and are billed seperately from the product. [[Configurable Options]] on products allow you to give your clients variables which alter the price of that product. In this article, we will look at when you would use them and how.
+
Product Addons let you offer additional items that the client can select. These are billed separately from the product.
  
===When should I use configurable options instead of addons?===
+
You can access this feature at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Product Addons''', or, prior to WHMCS 8.0, '''Setup > Products/Services > Product Addons'''.
  
*If you want to offer a choice of options for a single thing - for example Disk Space, Operating System, Locations, etc...
 
*If you want the total amount to be billed as a single item and not seperately
 
*When you want the billing cycle of the addon to match the billing cycle of the product
 
  
===When should I use addons instead of configurable options?===
+
== When to Use Product Addons ==
  
*If the item is a one off service
+
Depending on your purpose, you may wish to use product addons or you may wish to use configurable options. Configurable options on products allow you to give your clients ways to alter the price of that product while product addons do not.  
*If it can be selected independently of other items
 
*If it should be billed on it's own cycle - eg. a dedicated IP might be billed annually regardless of the package cycle
 
*Not subject to prorata at a product level or client-wide signup anniversary prorata.
 
  
==Product Addons==
+
For more information, see [[Addons and Configurable Options]].
===Creating a New Addon===
 
  
#Begin by going to '''Setup > Products/Services > Product Addons > Add New'''
 
#Enter a '''Name''' and '''Description''', then click ''Save Changes''. The other options on this page are optional and can be changed later:
 
##Tick the '''Tax Addon''' box if tax rules should be applied to this addon
 
##Tick '''Show on Order''' if you want the addon to be displayed during the initial order process. When disabled, the addon can only be ordered from an existing service. This can be useful for addons that you may not wish to offer right away on new signups. As such, unlike the Hidden or Retired options, this doesn't hide the addon from the client area and order form, nor completely prevent it from being ordered.
 
##Ticking '''Suspend Parent Product''' will cause the parent product to which the addon belongs to be suspended should it become overdue on payment per your automation settings.
 
##Choose a '''Welcome Email''' if you want to send an email notification relating to the new addon when activated
 
##'''Addon Weighting''' – By default addons are listed on the order form alphabetically (set addon weighting value to 0), this display order can be customised by entering a weighting for each addon. A value of 1 would mean the addon was displayed at the top of the list, an addon with a weighting of 2 displayed beneath it and so on...
 
##'''Hidden''' - Tick to not show the addon on the order form - can still be ordered using the direct order links and added as an Admin
 
##'''Retired''' - When ticked the addon is hidden from both admin and client. The addon will not appear on the orderform or appear selectable in admin management. This will not change existing purchased addons.
 
#Under the '''Pricing''' tab, enter the prices for each of your activated currencies - setup fees to be charged at the initial time of order only and recurring amounts to be charged every cycle
 
#Under the '''Module Settings''' tab, if you'd like the addon to trigger provisioning, select a [[Server_Modules|Module Name]] which should be triggered when the addon is ordered.
 
# Select the provisioning option which controls when you'd like this addon to be activated; as soon as the order is placed, when the first payment is received, when you manually accept a pending order or never.<div class="docs-alert-info"><span class="title">Note</span><br />In version 7.1 and earlier a single ''Autoactivate on Payment'' option was available. In version 7.2 and above this is replaced with four provisioning options.</div>
 
# When used with addons, '''Custom Fields''' are for internal use only and are typically auto-populated by modules.
 
#Under the '''Applicable Products''' tab, click the products to which the addon applies in the ''Available Products'' column they will move to the ''Selected Products'' column and therefore appear during the ordering process for the selected products. To de-select a product click; it's name in the ''Selected Products'' column.
 
#If an '''Associated Download''' is selected, once the addon's status is Active, the chosen file(s) will become available for the client to download under the parent product's Downloads tab in the client area (Services > My Services > View Details > Downloads tab). For more information refer to [[Product Download Distribution]].
 
Finally, click Save Changes
 
 
===How Addons are Displayed===
 
Below is a table showing how the Show On Order, Hidden and Retired options affect addon display when enabled.
 
  
 +
==Product Addon Settings==
 +
 +
Product Addons use the following settings. You can update these settings during Product Addon creation or later by clicking the '''Edit''' icon for an addon:
 +
 +
===Details===
 +
 +
Under '''Details''', you can configure these settings:
 +
 +
*'''Name''' — The Product Addon name. This displays in the client order form.
 +
*'''Description''' — The Product Addon description. This displays in the client order form.
 +
*'''Tax Addon''' — Check if the system should apply tax rules to this addon.
 +
*'''Show on Order''' — Check to display the addon during the initial order process.
 +
**If you disable this, clients can only order the addon via an existing service. This is useful if you do not want to offer the addon to new customers. This will not completely prevent clients from ordering the addon.
 +
**This item doesn't determine whether the addons displays in the Client Area or on the order form.
 +
*'''Suspend Parent Product''' — Check to suspend the parent product if the addon becomes overdue (as determined by your automation settings).
 +
*'''Welcome Email''' — Select an email notification to send when the addon is activated.
 +
*'''Addon Weighting''' — Enter a value to customize the display order that clients see.
 +
**For example, a value of <tt>1</tt> displays the addon at the top of the list with a value of <tt>2</tt> displaying beneath it.
 +
**If you don't enter a new value, the addon will display on the order form alphabetically.
 +
*'''Hidden''' — Check to hide the addon on the order form. Admins can still use it and clients can still order it via direct links.
 +
*'''Retired''' — Check to hide the addon from both admins and clients.
 +
**If you check this, the addon will not appear on order forms or in the Admin Area.
 +
**This setting does not change existing purchased addons.
 +
 +
====How Addons are Displayed====
 +
The table below shows how the '''Show On Order''', '''Hidden''', and '''Retired''' options affect the display of product addons:
 +
 
<table class="table table-bordered">
 
<table class="table table-bordered">
 
<tr><th></th><th class="text-center">Show on Order</th><th class="text-center">Hidden</th><th class="text-center">Retired</th></tr>
 
<tr><th></th><th class="text-center">Show on Order</th><th class="text-center">Hidden</th><th class="text-center">Retired</th></tr>
<tr><td>Order Form</td><td class="text-center"><span class="fa fa-check-circle"></span></td><td class="text-center"></td><td class="text-center"><span class="fa fa-times-circle"></span></td></tr>
+
<tr><td>Order Form</td><td class="text-center"><span class="fa fa-check-circle"></span></td><td class="text-center"><span class="fa fa-times-circle"></span></td><td class="text-center"><span class="fa fa-times-circle"></span></td></tr>
<tr><td>Client Area Order Addons</td><td class="text-center"></td><td class="text-center"><span class="fa fa-check-circle"></span></td><td class="text-center"><span class="fa fa-times-circle"></span></td></tr>
+
<tr><td>Client Area Order Addons</td><td class="text-center">n/a</td><td class="text-center"><span class="fa fa-times-circle"></span></td><td class="text-center"><span class="fa fa-times-circle"></span></td></tr>
<tr><td>Admin Area Search Filters</td><td></td><td class="text-center"><span class="fa fa-check-circle"></span></td><td class="text-center"><span class="fa fa-times-circle"></span></td></tr>
+
<tr><td>Admin Area Order Form</td><td class="text-center"><span class="fa fa-check-circle"></span></td><td class="text-center">n/a</td><td class="text-center"><span class="fa fa-times-circle"></span></td></tr>
<tr><td>Admin Area Order Form</td><td></td><td class="text-center"><span class="fa fa-check-circle"></span></td><td class="text-center"><span class="fa fa-times-circle"></span></td></tr>
 
 
</table>
 
</table>
 +
<span class="fa fa-check-circle"></span> — With this option selected, the addon will show in the relevant area.<br/>
 +
<span class="fa fa-times-circle"></span> — With this option selected, the addon will not show in the relevant area. This will take precedence over the '''Show On Order''' option.<br/>
 +
'''n/a''' — This option will have no effect for the relevant area.
  
===Managing Addons===
+
===Pricing===
 +
 
 +
Under '''Pricing''', you can configure these settings:
 +
 
 +
*'''Payment Type''' — Select whether you want the addon to be '''Free''', '''One Time''', or '''Recurring'''.
 +
**If you selected '''One Time''' or '''Recurring''', a pricing matrix will display. Check '''Enable''' for the desired frequencies and then enter the desired '''Setup Fee''' and '''Price''' for each frequency.
 +
**'''Setup Fee''' is charged when the addon is ordered, and '''Price''' is charged at the set frequency.
 +
*'''Prorata Billing''' — In WHMCS 8.2 and later, check to sync the addon due date with the due date for the parent service.
 +
*'''Allow Multiple Quantities''' — In WHMCS 8.0 and later, select whether to allow orders for multiple quantities of the addon.
 +
* '''On-Demand Renewals''' — In WHMCS 8.9 and later, configure the addon-specific settings for [[On-Demand Renewals|on-demand renewals]]:
 +
** To use the global configuration in the '''[[Ordering_Tab|Ordering]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''', select '''Use System Default'''.
 +
** To override the global configuration and '''always''' offer on-demand renewals for the addon, select '''Use Addon-Specific Configuration''' and check '''Check to allow clients to place renewal orders early'''. Optionally, enter the maximum length of the on-demand renewal period for each billing cycle, or enter <tt>0</tt> to disable on-demand renewals for that billing cycle.
 +
** To override the global configuration and '''never''' offer on-demand renewals for the addon, select '''Use Addon-Specific Configuration''' but do '''not''' check '''Check to allow clients to place renewal orders early.'''.
 +
 
 +
====Product Addon Billing====
 +
 
 +
The billing cycle for addons depends on how it was purchased:
 +
* If the product addon is purchased with a product or service that is available for the addon, one of the following occurs:
 +
** If the addon has a billing cycle in the pricing matrix, it uses the same billing cycle as the parent product.
 +
** If the addon '''does not''' have a billing cycle in the pricing matrix, it uses the minimum available term for the addon.
 +
* If a product addon is ordered at a later date via the client area ('''Services > View Available Addons''') it may have a different billing cycle and '''Next Due Date''' from the parent product.
 +
   
 +
For example, you may want to ensure that an item is billed annually regardless of the parent product billing cycle. You could configure a website builder addon to always be billed according to the associated product or service's terms by specifying annual pricing for the addon in the addon pricing matrix.
 +
 
 +
To set annual pricing on the addon:
 +
 
 +
#Click the '''Edit''' icon next to the addon.
 +
#Click '''Pricing'''.
 +
#Select '''Recurring''' for '''Payment Type'''.
 +
#Select the checkbox under '''Annually''' for each of your currencies.
 +
#Enter the desired '''Setup Fee''' and '''Price'''.
 +
 
 +
This will ensure the addon is always billed annually, even if the parent product billing cycle is different.
 +
 +
====Prorata Billing====
 +
 
 +
In WHMCS 8.2 and later, you can choose to use prorata billing with product addons. Prorata billing synchronizes billing to a specific day of the month.
 +
 
 +
For product addons, WHMCS uses the prorata date setting from the associated parent product or service instead of a separate date. WHMCS will then bill for the product addon and the parent product or service on the same day of the month for their respective billing cycles.
 +
 
 +
For example scenarios using prorata billing settings with product addons, see [[Prorata Billing]].
  
*To manage existing addons, go to '''Setup > Products/Services > Product Addons'''
+
===Module Settings===
*From here you can view, edit and delete existing addons
+
 
*You will not be able to delete an addon if it is in use by customers
+
Use the '''Module Settings''' tab to configure the addon for provisioning:
*Modifying addons gives you exactly the same layout and options as adding a new one
+
 
 +
# Select a '''[[Server_Modules|Module Name]]'''.
 +
# In WHMCS 8.2 and later, select an '''Addon Type'''.
 +
#* If you use ''cPanel/WHM'' or ''Plesk'' as the module, choose '''Add-On Feature''' to offer certain module-specific features like [[WP Toolkit]]. If you choose this type, choose the desired feature for '''Feature Name'''.
 +
#* Choose '''Independent Product''' for all other types of addon. Prior to WHMCS 8.2, all addons use this type.
 +
# Configure the additional settings that appear. These depend on the module and addon type you choose.
 +
# In WHMCS 7.2 and later, select when you want to activate the addon.
  
===Assigning Addons to Customers===
+
===Predefined Addons===
 +
 
 +
In WHMCS 8.2 and later, a '''Predefined Addons''' section appears at the bottom of the first addon creation page. It allows you to quickly create addons with preconfigured settings.
 +
 +
Click a predefined addon to automatically prepopulate the '''Create New Addon''' settings with the appropriate values. For example, clicking '''WP Toolkit Deluxe (cPanel)''' will configure all of the necessary settings for an addon to sell WP Toolkit Deluxe on your compatible cPanel servers. For more information, see [[WP Toolkit]].
 +
 
 +
Some settings may be unavailable for certain predefined addons (for example, you cannot select a different module for a cPanel-specific addon). You can configure the remaining settings as normal.
 +
 +
<div class="docs-alert-info">
 +
<span class="title">MarketConnect</span><br />
 +
The '''Predefined Addons''' section also includes MarketConnect items. Click a MarketConnect product to display the '''Learn More''' tab in that product's MarketConnect modal.
 +
</div>
  
*In addition to clients being able to order addons from the client area, admins can issue addons to customers
+
===Custom Fields===
*Refer to [[Products Management#Addons]] for details
+
For Product Addons, '''Custom Fields''' are for internal use only. Typically, these are autopopulated by the modules you choose.
 +
 +
===Applicable Products===
 +
 +
Under '''Applicable Products''', select the products that will display the addon as an option during the ordering process. To do this, under '''Available Products''', click the products and services that are associated with the addon. They will automatically move to '''Selected Products'''.
 +
 +
To deselect a product or service, click its name under '''Selected Products'''.
 +
 +
===Associated Download===
 +
 +
Under '''Associated Download''', select the files that the purchaser can download after purchasing the addon (once the addon's status is '''Active'''). To do this, under '''Available Downloads''', click the desired files. They will automatically move to '''Selected Downloads'''.
 +
 +
To deselect a product or service, click its name under '''Selected Downloads'''.
 +
 +
Clients can download the files at '''Services > My Services > View Details > Downloads''' in the Client Area. For more information, see [[Product Download Distribution]].
 +
 +
== Creating and Managing Addons ==
 +
 +
To create a new addon:
 +
 +
#Click '''Add New Addon'''.
 +
#Configure the settings in each tab. For more information, see [[#Addon_Settings|Addon Settings]] above.
 +
#Click '''Save Changes'''.
  
==Configurable Options==
+
When you manage addons, you cannot delete addons that are active purchases for a customer.
Information on [[Configurable Options]] can be found on their own page.
+
 
 +
Admins can issue addons to customers. For more information, see [[Products Management#Addons|Products Management]].

Latest revision as of 14:14, 3 April 2024

Product Addons let you offer additional items that the client can select. These are billed separately from the product.

You can access this feature at Configuration () > System Settings > Product Addons, or, prior to WHMCS 8.0, Setup > Products/Services > Product Addons.


When to Use Product Addons

Depending on your purpose, you may wish to use product addons or you may wish to use configurable options. Configurable options on products allow you to give your clients ways to alter the price of that product while product addons do not.

For more information, see Addons and Configurable Options.


Product Addon Settings

Product Addons use the following settings. You can update these settings during Product Addon creation or later by clicking the Edit icon for an addon:

Details

Under Details, you can configure these settings:

  • Name — The Product Addon name. This displays in the client order form.
  • Description — The Product Addon description. This displays in the client order form.
  • Tax Addon — Check if the system should apply tax rules to this addon.
  • Show on Order — Check to display the addon during the initial order process.
    • If you disable this, clients can only order the addon via an existing service. This is useful if you do not want to offer the addon to new customers. This will not completely prevent clients from ordering the addon.
    • This item doesn't determine whether the addons displays in the Client Area or on the order form.
  • Suspend Parent Product — Check to suspend the parent product if the addon becomes overdue (as determined by your automation settings).
  • Welcome Email — Select an email notification to send when the addon is activated.
  • Addon Weighting — Enter a value to customize the display order that clients see.
    • For example, a value of 1 displays the addon at the top of the list with a value of 2 displaying beneath it.
    • If you don't enter a new value, the addon will display on the order form alphabetically.
  • Hidden — Check to hide the addon on the order form. Admins can still use it and clients can still order it via direct links.
  • Retired — Check to hide the addon from both admins and clients.
    • If you check this, the addon will not appear on order forms or in the Admin Area.
    • This setting does not change existing purchased addons.

How Addons are Displayed

The table below shows how the Show On Order, Hidden, and Retired options affect the display of product addons:

Show on OrderHiddenRetired
Order Form
Client Area Order Addonsn/a
Admin Area Order Formn/a

— With this option selected, the addon will show in the relevant area.
— With this option selected, the addon will not show in the relevant area. This will take precedence over the Show On Order option.
n/a — This option will have no effect for the relevant area.

Pricing

Under Pricing, you can configure these settings:

  • Payment Type — Select whether you want the addon to be Free, One Time, or Recurring.
    • If you selected One Time or Recurring, a pricing matrix will display. Check Enable for the desired frequencies and then enter the desired Setup Fee and Price for each frequency.
    • Setup Fee is charged when the addon is ordered, and Price is charged at the set frequency.
  • Prorata Billing — In WHMCS 8.2 and later, check to sync the addon due date with the due date for the parent service.
  • Allow Multiple Quantities — In WHMCS 8.0 and later, select whether to allow orders for multiple quantities of the addon.
  • On-Demand Renewals — In WHMCS 8.9 and later, configure the addon-specific settings for on-demand renewals:
    • To use the global configuration in the Ordering tab at Configuration () > System Settings > General Settings, select Use System Default.
    • To override the global configuration and always offer on-demand renewals for the addon, select Use Addon-Specific Configuration and check Check to allow clients to place renewal orders early. Optionally, enter the maximum length of the on-demand renewal period for each billing cycle, or enter 0 to disable on-demand renewals for that billing cycle.
    • To override the global configuration and never offer on-demand renewals for the addon, select Use Addon-Specific Configuration but do not check Check to allow clients to place renewal orders early..

Product Addon Billing

The billing cycle for addons depends on how it was purchased:

  • If the product addon is purchased with a product or service that is available for the addon, one of the following occurs:
    • If the addon has a billing cycle in the pricing matrix, it uses the same billing cycle as the parent product.
    • If the addon does not have a billing cycle in the pricing matrix, it uses the minimum available term for the addon.
  • If a product addon is ordered at a later date via the client area (Services > View Available Addons) it may have a different billing cycle and Next Due Date from the parent product.

For example, you may want to ensure that an item is billed annually regardless of the parent product billing cycle. You could configure a website builder addon to always be billed according to the associated product or service's terms by specifying annual pricing for the addon in the addon pricing matrix.

To set annual pricing on the addon:

  1. Click the Edit icon next to the addon.
  2. Click Pricing.
  3. Select Recurring for Payment Type.
  4. Select the checkbox under Annually for each of your currencies.
  5. Enter the desired Setup Fee and Price.

This will ensure the addon is always billed annually, even if the parent product billing cycle is different.

Prorata Billing

In WHMCS 8.2 and later, you can choose to use prorata billing with product addons. Prorata billing synchronizes billing to a specific day of the month.

For product addons, WHMCS uses the prorata date setting from the associated parent product or service instead of a separate date. WHMCS will then bill for the product addon and the parent product or service on the same day of the month for their respective billing cycles.

For example scenarios using prorata billing settings with product addons, see Prorata Billing.

Module Settings

Use the Module Settings tab to configure the addon for provisioning:

  1. Select a Module Name.
  2. In WHMCS 8.2 and later, select an Addon Type.
    • If you use cPanel/WHM or Plesk as the module, choose Add-On Feature to offer certain module-specific features like WP Toolkit. If you choose this type, choose the desired feature for Feature Name.
    • Choose Independent Product for all other types of addon. Prior to WHMCS 8.2, all addons use this type.
  3. Configure the additional settings that appear. These depend on the module and addon type you choose.
  4. In WHMCS 7.2 and later, select when you want to activate the addon.

Predefined Addons

In WHMCS 8.2 and later, a Predefined Addons section appears at the bottom of the first addon creation page. It allows you to quickly create addons with preconfigured settings.

Click a predefined addon to automatically prepopulate the Create New Addon settings with the appropriate values. For example, clicking WP Toolkit Deluxe (cPanel) will configure all of the necessary settings for an addon to sell WP Toolkit Deluxe on your compatible cPanel servers. For more information, see WP Toolkit.

Some settings may be unavailable for certain predefined addons (for example, you cannot select a different module for a cPanel-specific addon). You can configure the remaining settings as normal.

MarketConnect
The Predefined Addons section also includes MarketConnect items. Click a MarketConnect product to display the Learn More tab in that product's MarketConnect modal.

Custom Fields

For Product Addons, Custom Fields are for internal use only. Typically, these are autopopulated by the modules you choose.

Applicable Products

Under Applicable Products, select the products that will display the addon as an option during the ordering process. To do this, under Available Products, click the products and services that are associated with the addon. They will automatically move to Selected Products.

To deselect a product or service, click its name under Selected Products.

Associated Download

Under Associated Download, select the files that the purchaser can download after purchasing the addon (once the addon's status is Active). To do this, under Available Downloads, click the desired files. They will automatically move to Selected Downloads.

To deselect a product or service, click its name under Selected Downloads.

Clients can download the files at Services > My Services > View Details > Downloads in the Client Area. For more information, see Product Download Distribution.

Creating and Managing Addons

To create a new addon:

  1. Click Add New Addon.
  2. Configure the settings in each tab. For more information, see Addon Settings above.
  3. Click Save Changes.

When you manage addons, you cannot delete addons that are active purchases for a customer.

Admins can issue addons to customers. For more information, see Products Management.