Difference between revisions of "Product Addons"

From WHMCS Documentation

(→‎Managing Addons)
Line 1: Line 1:
 
===What are Addons and Configurable Options?===
 
===What are Addons and Configurable Options?===
−
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 on products allow you to give your clients ways to alter the price of that product. [[Product Addons]] let you offer additional items that the client can select. These are billed separately from the product.
−
 
+
−
*Configurable options are defined in groups
+
*Configurable Options are defined in groups.
−
*Groups of options can then be applied to one or more products
+
*Groups of options can be applied to one or more products.
−
 
+
−
===When should I use configurable options instead of addons?===
+
===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...
+
Use Configurable Options when:
−
*If you want the total amount to be billed as a single item and not separately
+
*You want to offer a choice of options for a single item, like disk space, the server operating system, or locations.
−
*When the billing cycle of the addon must match the billing cycle of the product
+
*You want the total amount to be billed as a single item and not separately.
−
 
+
*The billing cycle of the addon must match the billing cycle of the product.
−
===When should I use addons instead of configurable options?===
+
−
 
+
===When should I use Addons instead of Configurable Options?===
−
*If the item is a one-off service
+
−
*If it can be selected independently of other items
+
Use Product Addons when the item:
−
*If it should be billed on its own cycle - eg. an SSL certificate might be billed annually regardless of the package cycle
+
*Is a one-time service.
−
 
+
*Can be selected independently of other items.
−
*Not subject to prorata at a product level or client-wide signup anniversary prorata.
+
*Is billed on its own cycle. For example, an SSL certificate might be billed annually regardless of the package cycle.
−
 
+
*Is 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 in several tabs 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'''. 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===
−
To set annual pricing on the addon:
+
−
 
+
Under '''Details''', you can configure these settings:
−
#Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services > Product Addons'''.
+
−
#Click '''Edit''' next to the addon.
+
*'''Name''' — The Product Addon name. This displays in the client order form.
−
#Click '''Pricing'''.
+
*'''Description''' — The Product Addon description. This displays in the client order form.
−
#Enable the annual pricing and set the desired selling price.
+
*'''Tax Addon''' — Check if the system should apply tax rules to this addon.
−
This will ensure the addon is always billed annually even if the parent product billing cycle is different.
+
*'''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.
−
==Product Addons==
+
**This item doesn't determine whether the addons displays in the Client Area or on the order form.
−
===Creating a New Addon===
+
*'''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.
−
To create a new addon:
+
*'''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.
−
#Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services > Product Addons > Add New'''.
+
**If you don't enter a new value, the addon will display on the order form alphabetically.
−
#Enter a '''Name''' and '''Description'''.
+
*'''Hidden''' — Check to hide the addon on the order form. Admins can still use it and clients can still order it via direct links.
−
# Click ''Save Changes''.  
+
*'''Retired''' — Check to hide the addon from both admins and clients.
−
# Select from the following options, which are optional and which you can also change later:
+
**If you check this, the addon will not appear on order forms or in the Admin Area.
−
##Check '''Tax Addon''' if the system should apply tax rules to this addon.
+
**This setting does not change existing purchased addons.
−
##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.
+
====How Addons are Displayed====
−
##Choose a '''Welcome Email''' if you want to send an email notification relating to the new addon on activation.
+
The table below shows how '''Show On Order''', '''Hidden''', and '''Retired''' affect addon display when you enable them:
−
##'''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'''.
 
−
 
 
−
===How Addons are Displayed===
 
−
The table below shows how the Show On Order, Hidden, and Retired options affect addon display when you enable them.
 
−
 
 
 
<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>
Line 67: Line 54:
 
<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>
 
<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>
−
 
+
−
===Managing Addons===
+
===Pricing===
−
 
+
−
To manage existing addons, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services > Product Addons'''.
+
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.
 +
*'''Allow Multiple Quantities''' — In WHMCS 8.0 and later, select whether to allow orders for multiple quantities of the addon.
 +
 +
====Product Addons Billing Cycle Workflow====
 +
 +
If the Product Addon has a billing cycle in the pricing matrix and it matches the parent product in the cart, WHMCS will match the billing cycle. 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.
 +
 +
For some addons, like SSL certificates, you may wish to ensure this is billed annually regardless of the parent product billing cycle. To do this, only specify annual pricing for the addon in the addon pricing matrix.
 +
 +
To set annual pricing on the addon:
 +
 +
#Go to '''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'''.
 +
#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.
 +
 +
===Module Settings===
 +
 +
Under '''Module Settings''', if you want the addon to trigger provisioning:
 +
 +
#Select a [[Server_Modules|Module Name]].
 +
#Configure the settings that appear. These depend on the module you choose.
 +
#In WHMCS 7.2 and later, at the bottom of the tab, select an option for when you want to activate the addon.
 +
 +
===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 a New Addon==
 +
 +
To create a new addon:
 +
 +
#Go to '''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'''.
 +
#Click '''Add New Addon'''.
 +
#Configure the settings in each tab. For more information, see [[#Addon_Settings|Addon Settings]] above.
 +
#Click '''Save Changes'''.
 +
 +
==Managing Addons==
 +
 +
To manage existing addons, go to '''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'''.
 
*From here, you can view, edit and delete existing addons.
 
*From here, you can view, edit and delete existing addons.
 
*You can't delete an addon if it is in use by customers.
 
*You can't delete an addon if it is in use by customers.
−
 
+
−
===Assigning Addons to Customers===
+
Admins can issue addons to customers. For more information, see [[Products Management#Addons|Products Management]].
−
 
+
−
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==
 
==Configurable Options==
−
For more information, see [[Configurable Options]].
+
For more information about Configurable Options, see [[Configurable Options]].

Revision as of 00:16, 19 September 2020

What are Addons and Configurable Options?

Configurable Options on products allow you to give your clients ways to alter the price of that product. Product Addons let you offer additional items that the client can select. These are billed separately from the product.

  • Configurable Options are defined in groups.
  • Groups of options can be applied to one or more products.

When should I use Configurable Options instead of Addons?

Use Configurable Options when:

  • You want to offer a choice of options for a single item, like disk space, the server operating system, or locations.
  • You want the total amount to be billed as a single item and not separately.
  • The billing cycle of the addon must match the billing cycle of the product.

When should I use Addons instead of Configurable Options?

Use Product Addons when the item:

  • Is a one-time service.
  • Can be selected independently of other items.
  • Is billed on its own cycle. For example, an SSL certificate might be billed annually regardless of the package cycle.
  • Is not subject to prorata at a product level or client-wide signup anniversary prorata.

Product Addon Settings

Product Addons use the following settings in several tabs at Configuration () > System Settings > Product Addons, or, prior to WHMCS 8.0, Setup > Products/Services > Product Addons. 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 Show On Order, Hidden, and Retired affect addon display when you enable them:

Show on OrderHiddenRetired
Order Form
Client Area Order Addons
Admin Area Search Filters
Admin Area Order Form

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.
  • Allow Multiple Quantities — In WHMCS 8.0 and later, select whether to allow orders for multiple quantities of the addon.

Product Addons Billing Cycle Workflow

If the Product Addon has a billing cycle in the pricing matrix and it matches the parent product in the cart, WHMCS will match the billing cycle. 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.

For some addons, like SSL certificates, you may wish to ensure this is billed annually regardless of the parent product billing cycle. To do this, only specify annual pricing for the addon in the addon pricing matrix.

To set annual pricing on the addon:

  1. Go to Configuration () > System Settings > Product Addons, or, prior to WHMCS 8.0, Setup > Products/Services > Product Addons.
  2. Click the Edit icon next to the addon.
  3. Click Pricing.
  4. Select Recurring for Payment Type.
  5. Select the checkbox under Annually for each of your currencies.
  6. 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.

Module Settings

Under Module Settings, if you want the addon to trigger provisioning:

  1. Select a Module Name.
  2. Configure the settings that appear. These depend on the module you choose.
  3. In WHMCS 7.2 and later, at the bottom of the tab, select an option for when you want to activate the addon.

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 a New Addon

To create a new addon:

  1. Go to Configuration () > System Settings > Product Addons, or, prior to WHMCS 8.0, Setup > Products/Services > Product Addons.
  2. Click Add New Addon.
  3. Configure the settings in each tab. For more information, see Addon Settings above.
  4. Click Save Changes.

Managing Addons

To manage existing addons, go to Configuration () > System Settings > Product Addons, or, prior to WHMCS 8.0, Setup > 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.

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

Configurable Options

For more information about Configurable Options, see Configurable Options.

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