Difference between revisions of "Product Addons"

From WHMCS Documentation

(→‎Managing Addons)
(→‎Module Settings)
 
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
===What are Addons and Configurable Options?===
+
Product Addons let you offer additional items that the client can select. These are billed separately from the product.
−
Configurable Options on products allow you to give your clients variables which alter the price of that product. [[Product Addons]] let you offer additional items which the client has a yes/no choice over and are billed separately from the product. In this article, we will look at when you would use them and how.
 
  
−
*Configurable options are defined in groups
+
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'''.
−
*Groups of options can then be applied to one or more products
 
  
−
===When should I use configurable options instead of addons?===
 
  
−
*If you want to offer a choice of options for a single thing - for example Disk Space, Operating System, Locations, etc...
+
== When to Use Product Addons ==
−
*If you want the total amount to be billed as a single item and not separately
 
−
*When the billing cycle of the addon must match the billing cycle of the product
 
  
−
===When should I use addons instead of configurable options?===
+
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 the item is a one-off service
+
For more information, see [[Addons and Configurable Options]].
−
*If it can be selected independently of other items
 
−
*If it should be billed on its own cycle - eg. an SSL certificate 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 billing cycle workflow===
+
==Product Addon Settings==
−
 
+
−
If the Product Addon has a billing cycle configured in the pricing matrix which matches the parent product in the cart, then matching billing cycle will be used automatically. If a product addon is ordered at a later date via the client area ('''Services > View Available Addons''') it can have a different billing cycle and next due date from the parent product.
+
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:
−
 
+
−
For some addons such as SSL certificates, you may wish to ensure this is billed annually regardless of the parent product billing cycle, to do this you should only specify annual pricing for addon in the addon pricing matrix.
+
===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">
 +
<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"><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">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 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>
 +
</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.
  
 +
===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:
 
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]].
  
−
#Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services > Product Addons'''.
+
===Module Settings===
−
#Click '''Edit''' next to the addon.
+
 
−
#Click '''Pricing'''.
+
Use the '''Module Settings''' tab to configure the addon for provisioning:
−
#Enable the annual pricing and set the desired selling price.
+
 
−
This will ensure the addon is always billed annually even if the parent product billing cycle is different.
+
# 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.
  
−
==Product Addons==
+
===Predefined Addons===
−
===Creating a New Addon===
+
 
 +
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>
  
 +
===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:
 
To create a new addon:
−
 
+
−
#Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services > Product Addons > Add New'''.
+
#Click '''Add New Addon'''.
−
#Enter a '''Name''' and '''Description'''.
+
#Configure the settings in each tab. For more information, see [[#Addon_Settings|Addon Settings]] above.
−
# Click ''Save Changes''.
 
−
# Select from the following options, which are optional and which you can also change later:
 
−
##Check '''Tax Addon''' if the system should apply tax rules to this addon.
 
−
##Check '''Show on Order''' if you want the addon to display during the initial order process. When you disable this, clients can only order the addon from an existing service. This can be useful for addons that you may not wish to offer right away on new signups. Unlike the '''Hidden''' or '''Retired''' options, this doesn't hide the addon from the client area and order form. It also doesn't completely prevent clients from ordering it.
 
−
##Check '''Suspend Parent Product''' to cause the system to suspend the parent product (to which the addon belongs) if the addon becomes overdue on payment, per your automation settings.
 
−
##Choose a '''Welcome Email''' if you want to send an email notification relating to the new addon on activation.
 
−
##'''Addon Weighting''' — By default, addons display on the order form alphabetically (an addon weighting value to 0). You can customize the display order by entering a weighting for each addon. For example, a value of 1 displays the addon at the top of the list, while an addon with a weighting of 2 displays beneath it.
 
−
##Check '''Hidden''' to hide the addon on the order form. Clients can still order it using the direct order links and admins can continue to use it.
 
−
##Check '''Retired''' to hide the addon from both admins and clients. The addon will not appear on the order form or as selectable in admin management. This will not change existing purchased addons.
 
−
#Under the '''Pricing''' tab, enter, in the prices for each of your activated currencies, setup fees to charge at the initial time of order only and recurring amounts to charge every cycle.
 
−
#Under the '''Module Settings''' tab, if you'd like the addon to trigger provisioning, select a [[Server_Modules|Module Name]] to trigger when someone orders the addon.
 
−
# Select a provisioning option to control when you'd like to activate this addon. You can do this as soon as someone places the order, when the first payment arrives, 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, we replaced this with four provisioning options.</div>
 
−
# When you use this with addons, '''Custom Fields''' are for internal use only. Typically, modules auto-populate them.
 
−
#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 appear during the ordering process for the selected products. To deselect a product , click its name in the '''Selected Products''' column.
 
−
#If you select an '''Associated Download''', 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'''). For more information, refer to [[Product Download Distribution]].
 
 
#Click '''Save Changes'''.
 
#Click '''Save Changes'''.
  
−
===How Addons are Displayed===
+
When you manage addons, you cannot delete addons that are active purchases for a customer.  
−
The table below shows how the Show On Order, Hidden, and Retired options affect addon display when you enable them.
+
 
−
 
+
Admins can issue addons to customers. For more information, see [[Products Management#Addons|Products Management]].
−
<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><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>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>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></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>
 
−
 
 
−
===Managing Addons===
 
−
 
 
−
To manage existing addons, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services > Product Addons'''.
 
−
*From here, you can view, edit and delete existing addons.
 
−
*You can't delete an addon if it is in use by customers.
 
−
 
 
−
===Assigning Addons to Customers===
 
−
 
 
−
In addition to clients being able to order addons from the client area, admins can issue addons to customers. For more information, see [[Products Management#Addons|Products Management]].
 
−
 
 
−
==Configurable Options==
 
−
For more information, see [[Configurable Options]].
 

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.

Retrieved from "http://3.17.75.209/index.php?title=Product_Addons&oldid=34502"