Difference between revisions of "Products and Services"

From WHMCS Documentation

m (Typo)
Line 1: Line 1:
−
Products are configured via the '''Setup > Products/Services > Products/Services''' page
+
Configure products via the '''Setup > Products/Services > Products/Services''' page.
  
−
Basic instructions for creating your first product group and product can be found under [[Setting Up Your First Product]]. This page explains all the advanced options available, including hiding products, stock control and upgrades.
+
For basic instructions for creating your first product group and product, see [[Setting Up Your First Product]]. This page explains all the advanced options available, including hiding products, stock control, and upgrades.
  
 
[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=0lqzsTSUGw0&hd=1|Watch Video Tutorial]]
 
[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=0lqzsTSUGw0&hd=1|Watch Video Tutorial]]
  
 
==Product Groups==
 
==Product Groups==
−
Products are organised on the order form by group, as each group has a separate page, this means products can be split into categories or across several pages for ease of display. For example you may wish to list your shared hosting plans on a separate page to the reseller plans. Clients can switch between groups on the order form or you can link to them directly (see [[#Links Tab]]).
+
Products organize on the order form by group. Each group has a separate page, so you can split products into categories or across several pages for ease of display. For example, you may wish to list your shared hosting plans on a separate page to the reseller plans. Clients can switch between groups on the order form or you can link to them directly (see [[#Links Tab]]).
  
−
*To create a product group click the '''Create a New Group''' link
+
To create a product group:
−
*Enter a name for the group - this will be displayed on the order form
+
 
−
* Under normal circumstances all product groups will use the system default order form template specified in the general settings. However if you wish to use a different template for just this group, select it from the '''Order Form Template''' option here.<br/>'''N.B.''' Any order form template selected here cannot be overwritten by the carttpl variable in the link URL.
+
*Click the '''Create a New Group''' link.
−
*Use the tick boxes to select which ''payment gateways'' will be offered on the checkout page to pay for products within this group.
+
*Enter a name for the group. This will display on the order form.
−
*To hide this group from the order form tick the ''Hidden'' checkbox
+
*Under normal circumstances, all product groups will use the system default order form template in the general settings. However, if you wish to use a different template for just this group, select it from the '''Order Form Template''' option here.<br/>The <tt>carttpl</tt> variable in the link URL can't overwrite any order form templates that you select.
−
*Click ''Create Group''. To edit the group at a later date click the corresponding Edit icon on the Products/Services page.
+
*Use the checkboxes to select which ''payment gateways'' to offer on the checkout page for products within this group.
 +
*To hide this group from the order form, check the ''Hidden'' checkbox.
 +
*Click ''Create Group''. To edit the group at a later date, click the corresponding Edit icon on the Products/Services page.
  
 
To customise display sorting, see [[Products_and_Services#Sorting|Sorting]]
 
To customise display sorting, see [[Products_and_Services#Sorting|Sorting]]
  
 
==Products==
 
==Products==
−
To create a product click the '''Create a New Product''' link and you will see these three options:
+
To create a product, click the '''Create a New Product''' link. You will see these three options:
−
* '''Product Type''' - There are 4 options to choose from and used to determine only how WHMCS should handle it. This is only for system use - you use the groups to divide products into categories for your own use.
+
* '''Product Type''' — There are four options to choose from, which WHMCS uses to determine how to handle the product. This is only for system use; you use the groups to divide products into categories for your own use.
−
**Shared Hosting - for web hosting accounts
+
**Shared Hosting — For web hosting accounts.
−
**Reseller Hosting - for web hosting reseller accounts
+
**Reseller Hosting — For web hosting reseller accounts.
−
**Dedicated/VPS Server - for servers and displays server hostname, ns & root pw fields on signup
+
**Dedicated/VPS Server — For servers. This displays the server hostname, nameserver, and root password fields on signup.
−
**Other - for anything else
+
**Other — For anything else.
−
*'''Product Group''' - The group the product belongs to for display on the order form
+
*'''Product Group''' — The group the product belongs to for display on the order form.
−
*'''Product Name''' - The name to display to customers and throughout the admin area
+
*'''Product Name''' — The name to display to customers and throughout the admin area.
−
Once created the following options will be available for configuration. To edit a product at a later date click the corresponding Edit icon on the Products/Services page.
 
  
−
To customise display sorting, see [[Products_and_Services#Sorting|Sorting]]
+
After you create the product, the following options will be available for configuration. To edit a product at a later date, click the corresponding Edit icon on the Products/Services page.
 +
 
 +
To customise display sorting, see [[Products_and_Services#Sorting|Sorting]].
  
 
===Details Tab===
 
===Details Tab===
−
This is the first tab you see and contains general information about a product including its name and product group.
+
This is the first tab you see. It contains general information about a product, including its name and product group.
  
−
* '''Product Type''', '''Product Group''' and '''Product Name''' - See above [[#Products]]
+
* '''Product Type''', '''Product Group''' and '''Product Name''' — See the [[#Products|Products]] section above.
−
*'''Product Description''' - The detailed information displayed on the order form relating to this product
+
*'''Product Description''' — The detailed information on the order form, which relates to this product.
−
** '''Note:''' Line breaks are maintained when formatting a description. When using HTML it is recommended to avoid new lines, unless you want them to be displayed in the end result.
+
** '''Note:''' The system maintains line breaks when you format a description. When using HTML, we recommend avoiding new lines unless you want them to appear in the end result.
−
*'''Welcome Email''' - The email template to send when the product is activated. You can create custom email templates to use on different products - see [[Email Templates]] for more info.
+
*'''Welcome Email''' — The email template to send when activating the product. You can create custom email templates to use on different products. For more information, see [[Email Templates]].
−
*'''Require Domain''' - To show the domain registration options on ordering. Should always be enabled for hosting and disabled for any other products that don't require a domain name.
+
*'''Require Domain''' — The domain registration options on ordering. You should always enable this for hosting and disable it for any other products that don't require a domain name.
−
*'''Stock Control''' - Can be used if you have a specific quantity of an item available (for example servers) or a limited special offer product - tick to enable and enter a quantity remaining and WHMCS will stop orders when it reaches zero.  
+
*'''Stock Control''' — The specific available quantity of an item (for example, servers) or a limited special-offer product. Check this to enable it, and then enter the remaining quantity. WHMCS will stop orders when it reaches zero.  
−
*'''Sort Order''' -  Can be set to a number to overide the default product ordering of alphabetical names. A product with sort order of 0 will appear in the list first, 1 will be beneath that, 2 beneath that etc..
+
*'''Sort Order''' — A number that overrides the default product ordering of alphabetical names. For example, a product with sort order of 0 will appear in the list first, with 1 will be beneath that and 2 beneath that.
−
*'''Apply Tax''' - Tick if tax rules should be applied to this product. For more information refer to [[Tax Configuration|Tax/VAT Rules]].
+
*'''Apply Tax''' — Whether to apply tax rules to this product. For more information, see [[Tax Configuration|Tax/VAT Rules]].
−
*'''Hidden''' - Tick to not show the product on the order form - can still be ordered using the direct order links
+
*'''Hidden''' — Whether to show the product on the order form. Customers will still be able to order this using the direct order links.
−
*'''Retire''' -  When ticked the product is hidden from admin area lists, such as the Products/Services dropdown in the client's Products/Services tab.
+
*'''Retire''' — Whether to hide the product from admin area lists, such as the Products/Services menu in the client's Products/Services tab.
  
 
===Pricing Tab===
 
===Pricing Tab===
−
This second tab is where the prices and length of the product are specified.
+
This second tab lets you specify the prices and duration of the product.
 
[[File:Price grid.png|thumb|Price Grid]]
 
[[File:Price grid.png|thumb|Price Grid]]
−
*'''Payment Types''' - consists of Free, One Time & Recurring options
+
*'''Payment Types''' — Free, One Time, and Recurring options.
−
*When One Time or Recurring payment types are selected, the '''pricing grid''' will appear for entry of the product price. Enable each billing cycle by ticking the corresponding '''Enable''' checkbox.
+
**When you select One Time or Recurring payment types, the '''pricing grid''' will appear for entry of the product price. Enable each billing cycle by checking the corresponding '''Enable''' checkbox.
−
**For Free products the grid will not appear as one cannot specify a price for a free product.
+
**For Free products, the grid will not appear, since you cannot specify a price for a free product.
 
**For One Time products, enable the One Time/Monthly column and enter your prices into that column.
 
**For One Time products, enable the One Time/Monthly column and enter your prices into that column.
−
**For Recurring pricing types there are several billing cycles to choose from depending on how often you want clients to be billed. You can enable as many or as few as you like.
+
**For Recurring pricing types, you can choose from several billing cycles depending on how often you want to bill clients. You can enable as many or as few as you like.
−
**The '''setup fee''' in each column allows you to specify different setup fees depending on the cycle chosen, for example you may charge setup fees on monthly cycles and offer free setup if paid annually
+
**The '''setup fee''' in each column allows you to specify different setup fees depending on the cycle you choose. For example, you may charge setup fees on monthly cycles and offer free setup for yearly cycles.
−
**If you do not wish to offer a particular billing cycle, UNtick the Enable checkbox to '''disable''' it. In this screenshot the product will only be available monthly or annually with no setup fee.
+
**If you do not wish to offer a particular billing cycle, deselect the Enable checkbox to '''disable''' it. In this screenshot, the product will only be available monthly or annually with no setup fee.
−
*'''Allow Multiple Quantities''' - When enabled this option allows clients to choose the quantity of this product they wish to order, on the checkout page an option will be available. The product must require no additional configuration such as product custom fields, configurable options.
+
*'''Allow Multiple Quantities''' — When you enable it, this option allows clients to choose the quantity of this product they wish to order. This is available on the checkout page. The product must require no additional configuration (like product custom fields or configurable options).
−
*'''Recurring Cycles Limit''' - For Recurring payment types the default value 0 will invoice indefinitely until cancelled. However by entering a value in this field you can limit the number of times this product will invoice the client. For example entering 5 on a monthly product would cause no invoice to be generated in the 6th month after ordering.
+
*'''Recurring Cycles Limit''' — For Recurring payment types, the default value (<tt>0</tt>) will invoice indefinitely until cancelled. However, by entering a value in this field, you can limit the number of times this product will invoice the client. For example, entering 5 on a monthly product would keep the system from generating an invoice in the 6th month after ordering.
−
*'''Auto Terminate/Fixed Term''' - You can setup products to automatically terminate after a set number of days from the service's Registration Date. This can be used to offer free trial products for a certain period of time, or time limited products that should only recur for a certain number of cycles before stopping.
+
*'''Auto Terminate/Fixed Term''' — You can set up products that automatically terminate after a set number of days from the service's Registration Date. Use this to offer free trial products for a certain period of time or time-limited products that should only recur for a certain number of cycles before stopping.
−
**To enable enter the number of days to wait before terminating, and choose an email template to be sent to the client when the termination occurs (for example an up-selling email to promote your paid products in the case of a trial, or confirmation of payment completing for instalment payment situations). Set the Auto Terminate/Fixed Term value to 0 to disable this feature.  
+
**To enable this, enter the number of days to wait before terminating and choose an email template to send to the client when the termination occurs (for example, an up-selling email to promote your paid products in the case of a trial, or confirmation of payment completing for installment payments). Set the Auto Terminate/Fixed Term value to 0 to disable this feature.  
−
**Entering a number in this field will cause the product to be terminated when the cron runs x days after the product registration date.
+
**Entering a number in this field terminate the product when the cron job runs that many days after the product registration date.
−
*'''Termination Email''' - When the above feature is enabled, choose an email to be sent to the client when the product is terminated.
+
*'''Termination Email''' — When you enable the above option, choose an email to send to the client at product termination.
 
<div class="docs-alert-info">
 
<div class="docs-alert-info">
 
<span class="title">Note:</span><br />
 
<span class="title">Note:</span><br />
−
The Termination Email dropdown field is only populated with custom product type email templates.  For more information on creating a custom email template, please visit [http://docs.whmcs.com/Email_Templates http://docs.whmcs.com/Email_Templates]
+
The Termination Email menu only includes custom product type email templates.  For more information on creating a custom email template, see [http://docs.whmcs.com/Email_Templates Email Templates]
 
</div>
 
</div>
−
*'''Prorata Billing''' - This allows you to bill products on a specific day of the month and charge a prorata'd amount at the initial time of order. If enabled all clients will be charged on one exact day each month. When disabled the product will use the default anniversary billing system (eg. Jun 15 - Jul 15).
+
*'''Prorata Billing''' — This allows you to bill products on a specific day of the month and charge a prorata amount at the initial time of order. If you enable this, the system will charge all clients on one exact day each month. Otherwise, the product will use the default anniversary billing system (for example, Jun 15–Jul 15).
 
<div class="docs-alert-info">
 
<div class="docs-alert-info">
 
<span class="title">Note:</span><br />
 
<span class="title">Note:</span><br />
−
Prorata billing is not compatible with the free domain logic or having domain renewal invoices generated further in advance than other products.
+
Prorata billing is not compatible with the free domain logic or having domain renewal invoices that the system generates further in advance than other products.
 
</div>
 
</div>
−
*'''Prorata Date''' - If you set this to 1, then all clients would be charged on the 1st of each month.
+
*'''Prorata Date''' — If you set this to 1, the system will charge all clients on the 1st of each month.
−
*'''Charge Next Month''' - After this day of the month has been reached, a client will also be charged for the next month in their initial payment when signing up on a monthly billing cycle. If you had prorata date set to 1, and a client signed up on the 30th of the month, they'd only be charged a tiny amount without this setting. So it is pro-rated amount + next month in advance.<br/>'''TIP:''' If you wish to pro-rate a product but not use the 'charge next month' feature, set "Prorata Date" to a normal value and "Charge Next Month" to 32.
+
*'''Charge Next Month''' — After this day of the month, the system will also charge a client for the next month in their initial payment when signing up on a monthly billing cycle. Without enabling this, if you have set the prorata date to 1, and a client signs up on the 30th of the month, they would only pay a small amount. If you enable this, they would pay the prorated amount plus the next month in advance.<br/>'''TIP:''' If you wish to prorate a product but not to enable this feature, set "Prorata Date" to a normal value and "Charge Next Month" to 32.
  
 
===Module Settings (aka Provisioning)===
 
===Module Settings (aka Provisioning)===
  
−
This tab specifies which server type the product will use and how WHMCS will behave when this product is ordered.  
+
This tab specifies which server type the product will use and how WHMCS will behave when someone orders this product.
−
*From the Module Name dropdown menu select the type of server you're using
+
 
−
*The options you will see depend upon the module chosen, and more info specific to each module can be found in the [[Server_Modules|Provisioning Modules]] section
+
*From the Module Name menu, select the type of server you're using.
−
*If a product has no specific module to be linked to then you can set it to "[[Auto_Release|Autorelease]]" in order to have the activation simulated and therefore welcome email sent automatically
+
* Select your desired options. The options you will see depend upon the module chosen. For more information about each module, see the [[Server_Modules|Provisioning Modules]] section.
−
*There are 4 automation settings to choose from for product activation and they are:
+
*If a product has no specific module to link to, set it to "[[Auto_Release|Autorelease]]" in order to simulate the activation and send a welcome email automatically.
−
**Automatically setup the product as soon as an order is placed - this will setup instantly usually used for free products
+
*Select one of the four automation settings for product activation:
−
**Automatically setup the product as soon as the first payment is received - this will perform the setup as soon as the order is paid for
+
**Automatically setup the product as soon as an order is placed — Set it up instantly. Usually, you would use this for free products.
−
**Automatically setup the product when you manually accept a pending order - this will perform the setup only when an admin has manually reviewed and accepted the order
+
**Automatically setup the product as soon as the first payment is received — Perform the setup as soon as the customer pays for the order.
−
**Do not automatically setup this product - never auto setup the product - admins can still initiate manually from the product details page under a clients profile
+
**Automatically setup the product when you manually accept a pending order — Perform the setup only when an admin has manually reviewed and accepted the order.
 +
**Do not automatically setup this product — Never auto-set up the product. Admins can still initiate manually from the product details page under a clients profile.
  
 
====Metric Billing====
 
====Metric Billing====
 
[[File:Usage-billing-module-settings-metric-config.png|thumb|]]
 
[[File:Usage-billing-module-settings-metric-config.png|thumb|]]
−
The Metric Billing section is displayed when a module which supports this feature is selected (WHMCS version 7.9 and above).
+
The Metric Billing section displays when you select a module that supports this feature (WHMCS version 7.9 and above).
  
−
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.
+
To enable a metric for billing or display purposes, set the toggle to On. If you enable a metric, 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 for a product that reports metrics.
  
−
To configure pricing for a metric, click the "Configure Pricing" under the given metric name.  
+
To configure pricing for a metric, click "Configure Pricing" under the given metric name.  
  
−
Detailed usage and configuration instructions are located on the [[Usage Billing]] page.
+
For usage and configuration instructions, see [[Usage Billing]].
  
 
===Custom Fields===
 
===Custom Fields===
  
−
From this tab you can create custom fields for this product, allowing you to collect additional information from your clients on the order form required for supplying the product.
+
From this tab you can create custom fields for this product. This allows you to collect additional order form information that you need to supply the product.  
−
*Field types consist of text boxes, dropdown selections, yes/no checkboxes, memo text boxes and password fields (text entered here with appear as asterisks ****)
+
 
−
*Fields can be set as admin only for private data, required/optional on the order form, displayed on the order form or only in the client area, or displayed on invoices (such as VAT numbers)
+
*Field types consist of text boxes, menus, yes-or-no checkboxes, memo text boxes, and password fields. Text in password fields appear as asterisks (<tt>****</tt>).
−
*See [[Custom_Fields|Custom Fields]] for more info
+
*You can set fields as admin-only for private data, required or optional on the order form, displayed on the order form, displayed in the client area, or displayed on invoices (such as VAT numbers).
 +
 
 +
For more information, see [[Custom_Fields|Custom Fields]].
  
 
===Configurable Options===
 
===Configurable Options===
  
−
Use this tab to select which configurable options are associated with the product, they can be displayed on the order form or in the client area.
+
Use this tab to select which configurable options to associate with the product. You can display them on the order form or in the client area.
−
*Configurable Options allow you to give your clients options which alter the price of the product
+
*Configurable Options allow you to give your clients options that alter the price of the product.
−
*Refer to [[Addons_and_Configurable_Options|Addons & Configurable Options]] for more info
+
*For more information, see [[Addons_and_Configurable_Options|Addons & Configurable Options]].
  
 
===Upgrades===
 
===Upgrades===
  
 
The sixth tab allows you to specify whether the client can upgrade or downgrade from this product to another.
 
The sixth tab allows you to specify whether the client can upgrade or downgrade from this product to another.
−
*Upgrades/downgrades can be fully automated by WHMCS with many of the modules
+
 
−
*All you need to do on this tab is select the products that the product can be upgraded or downgraded to
+
*WHMCS can fully automate upgrades and downgrades for many of the modules.
−
*Use Ctrl+Click to select multiple products
+
*In this tab, select the products that the product can be upgrade or downgrade to.
−
*There is also a checkbox for enabling the upgrades of configurable options if there are any on the product
+
*Use Ctrl+Click to select multiple products.
−
*From the '''Upgrade Email''' dropdown menu you can select an email template to be sent when a client upgrades to this product. A new Product email template will first need to be created under Setup > Email Templates.
+
*Select the checkbox to enable the upgrades of configurable options, if there are any on the product.
−
*See the [[Automated_Upgrades_and_Downgrades|Automated Upgrades and Downgrades]] article for more info on how upgrades/downgrades are calculated and processed.
+
*Select an email template to use when a client upgrades to this product from the '''Upgrade Email''' menu. You will first need to create a new Product email template under Setup > Email Templates.
 +
*For more information about how WHMCS calculates and processes upgrades and downgrades, see [[Automated_Upgrades_and_Downgrades|Automated Upgrades and Downgrades]].
  
 
===Free Domain===
 
===Free Domain===
  
−
Use this tab to configure the offer of a free domain with a product if desired.
+
Use this tab to configure the offer of a free domain with a product.
−
*WHMCS lets you offer free domains with your packages when purchased with certain payment terms
+
*WHMCS lets you offer free domains with your packages when customers purchase them with certain payment terms. For example, you might want to offer a free domain when someone purchases a package annually.
−
*For example you might want to offer a free domain when a package is purchased annually as an incentive
+
*For more information on how to configure this, see [[Domains_Configuration#Offering_Free_Domain_Registration_with_Selected_Packages|Offering Free Domain Registration]].
−
*Refer to the [[Domains_Configuration#Offering_Free_Domain_Registration_with_Selected_Packages|Offering Free Domain Registration]] article for more details on how to configure it
 
  
 
===Other===
 
===Other===
  
−
The penultimate tab contains miscellaneous settings such as product affiliate rates, product downloads and overage billing.
+
The penultimate tab contains miscellaneous settings such as product affiliate rates, product downloads, and overage billing.
−
*'''Custom Affiliate Payout''' - These settings allow you to specify a custom payout rate for this specific product if using the built in affiliate system, this setting overrides the system default commission rate, it can even be disabled.
+
 
−
*'''Affiliate Pay Amount''' - Based on your setting above to either percentage or fixed amount, this is the percentage or amount paid for a purchase of this product
+
*'''Custom Affiliate Payout''' — The custom payout rate for this specific product if using the built-in affiliate system. This setting overrides or disables the system default commission rate.
−
*'''One Time Payout''' - Tick this if you want to pay only a one off commission
+
*'''Affiliate Pay Amount''' — The percentage or amount paid for a purchase of this product, depending on your choice for the setting above.
−
*'''Subdomain Options''' - Enter a domain in the format ".yourdomain.com" if you want to offer a free subdomain option for the domain at signup. You can offer more than one by entering a comma separated list, eg. ".yourdomain.com,.yourdomain.net"
+
*'''One Time Payout''' — Whether to pay only a one-time commission.
−
*'''Product Downloads''' - Lets you offer files to be automatically released to the customer when the product is activated. See [[Product Downloads Distribution]] for more information
+
*'''Subdomain Options''' — Enter a domain in the format ".yourdomain.com" if you want to offer a free subdomain option for the domain at signup. You can offer more than one by entering a comma separated list (for example, ".yourdomain.com,.yourdomain.net").
−
*'''Overage Billing''' - Allows you to bill for the product based on disk and bandwidth usage for the month. Refer to [[Disk Space and Bandwidth Overage Billing]] for more information.
+
*'''Product Downloads''' — Whether to offer files to automatically release to the customer when the product is activated. See [[Product Downloads Distribution]] for more information.
 +
*'''Overage Billing''' — Allows you to bill for the product based on disk and bandwidth usage for the month. Refer to [[Disk Space and Bandwidth Overage Billing]] for more information.
  
 
===Links tab===
 
===Links tab===
  
−
The final tab contains some ready-made URLs to add to a webpage linking to this product.
+
The final tab contains some ready-made URLs to add to linking to this product.
−
*Each URL will add the product to the shopping cart and jump straight to the configuration step
+
 
−
*There are many more possible variations, refer to [[Linking to WHMCS]].
+
*Each URL will add the product to the shopping cart and jump straight to the configuration step.
 +
*There are many more possible variations. For more information, see [[Linking to WHMCS]].
  
 
==Sorting==
 
==Sorting==
Line 146: Line 154:
 
[[File:Drag_and_drop_sorting.png|center|850x250px]]
 
[[File:Drag_and_drop_sorting.png|center|850x250px]]
  
−
After moving, a success message will appear on the top right of the page to show the sort order has saved.
+
After moving, a success message will appear on the top right of the page to confirm that the system saved the sort order.
  
 
[[File:Product_drag_and_drop_success.png]]
 
[[File:Product_drag_and_drop_success.png]]
  
−
It is not possible to move products between groups using the drag and drop method.
+
It is not possible to move products between groups using the drag-and-drop method.
  
 
==Feature Highlights==
 
==Feature Highlights==
 
   
 
   
−
Feature Highlights allow you to define features and their values for products in a way that WHMCS can interpret for comparison based display.
+
Feature Highlights allow you to define features and their values for products in a way that WHMCS can interpret for comparison-based display.
 
   
 
   
−
Feature Highlights are supported by most order form templates.  For more information [[Standard_Order_Form_Templates#Templates|refer to this page]].
+
The system supports Feature Highlights for most order form templates.  For more information, see [[Standard_Order_Form_Templates#Templates|Standard Order Form Templates]].

Revision as of 18:32, 6 May 2020

Configure products via the Setup > Products/Services > Products/Services page.

For basic instructions for creating your first product group and product, see Setting Up Your First Product. This page explains all the advanced options available, including hiding products, stock control, and upgrades.

Watch Video Tutorial

Product Groups

Products organize on the order form by group. Each group has a separate page, so you can split products into categories or across several pages for ease of display. For example, you may wish to list your shared hosting plans on a separate page to the reseller plans. Clients can switch between groups on the order form or you can link to them directly (see #Links Tab).

To create a product group:

  • Click the Create a New Group link.
  • Enter a name for the group. This will display on the order form.
  • Under normal circumstances, all product groups will use the system default order form template in the general settings. However, if you wish to use a different template for just this group, select it from the Order Form Template option here.
    The carttpl variable in the link URL can't overwrite any order form templates that you select.
  • Use the checkboxes to select which payment gateways to offer on the checkout page for products within this group.
  • To hide this group from the order form, check the Hidden checkbox.
  • Click Create Group. To edit the group at a later date, click the corresponding Edit icon on the Products/Services page.

To customise display sorting, see Sorting

Products

To create a product, click the Create a New Product link. You will see these three options:

  • Product Type — There are four options to choose from, which WHMCS uses to determine how to handle the product. This is only for system use; you use the groups to divide products into categories for your own use.
    • Shared Hosting — For web hosting accounts.
    • Reseller Hosting — For web hosting reseller accounts.
    • Dedicated/VPS Server — For servers. This displays the server hostname, nameserver, and root password fields on signup.
    • Other — For anything else.
  • Product Group — The group the product belongs to for display on the order form.
  • Product Name — The name to display to customers and throughout the admin area.

After you create the product, the following options will be available for configuration. To edit a product at a later date, click the corresponding Edit icon on the Products/Services page.

To customise display sorting, see Sorting.

Details Tab

This is the first tab you see. It contains general information about a product, including its name and product group.

  • Product Type, Product Group and Product Name — See the Products section above.
  • Product Description — The detailed information on the order form, which relates to this product.
    • Note: The system maintains line breaks when you format a description. When using HTML, we recommend avoiding new lines unless you want them to appear in the end result.
  • Welcome Email — The email template to send when activating the product. You can create custom email templates to use on different products. For more information, see Email Templates.
  • Require Domain — The domain registration options on ordering. You should always enable this for hosting and disable it for any other products that don't require a domain name.
  • Stock Control — The specific available quantity of an item (for example, servers) or a limited special-offer product. Check this to enable it, and then enter the remaining quantity. WHMCS will stop orders when it reaches zero.
  • Sort Order — A number that overrides the default product ordering of alphabetical names. For example, a product with sort order of 0 will appear in the list first, with 1 will be beneath that and 2 beneath that.
  • Apply Tax — Whether to apply tax rules to this product. For more information, see Tax/VAT Rules.
  • Hidden — Whether to show the product on the order form. Customers will still be able to order this using the direct order links.
  • Retire — Whether to hide the product from admin area lists, such as the Products/Services menu in the client's Products/Services tab.

Pricing Tab

This second tab lets you specify the prices and duration of the product.

Price Grid
  • Payment Types — Free, One Time, and Recurring options.
    • When you select One Time or Recurring payment types, the pricing grid will appear for entry of the product price. Enable each billing cycle by checking the corresponding Enable checkbox.
    • For Free products, the grid will not appear, since you cannot specify a price for a free product.
    • For One Time products, enable the One Time/Monthly column and enter your prices into that column.
    • For Recurring pricing types, you can choose from several billing cycles depending on how often you want to bill clients. You can enable as many or as few as you like.
    • The setup fee in each column allows you to specify different setup fees depending on the cycle you choose. For example, you may charge setup fees on monthly cycles and offer free setup for yearly cycles.
    • If you do not wish to offer a particular billing cycle, deselect the Enable checkbox to disable it. In this screenshot, the product will only be available monthly or annually with no setup fee.
  • Allow Multiple Quantities — When you enable it, this option allows clients to choose the quantity of this product they wish to order. This is available on the checkout page. The product must require no additional configuration (like product custom fields or configurable options).
  • Recurring Cycles Limit — For Recurring payment types, the default value (0) will invoice indefinitely until cancelled. However, by entering a value in this field, you can limit the number of times this product will invoice the client. For example, entering 5 on a monthly product would keep the system from generating an invoice in the 6th month after ordering.
  • Auto Terminate/Fixed Term — You can set up products that automatically terminate after a set number of days from the service's Registration Date. Use this to offer free trial products for a certain period of time or time-limited products that should only recur for a certain number of cycles before stopping.
    • To enable this, enter the number of days to wait before terminating and choose an email template to send to the client when the termination occurs (for example, an up-selling email to promote your paid products in the case of a trial, or confirmation of payment completing for installment payments). Set the Auto Terminate/Fixed Term value to 0 to disable this feature.
    • Entering a number in this field terminate the product when the cron job runs that many days after the product registration date.
  • Termination Email — When you enable the above option, choose an email to send to the client at product termination.

Note:
The Termination Email menu only includes custom product type email templates. For more information on creating a custom email template, see Email Templates

  • Prorata Billing — This allows you to bill products on a specific day of the month and charge a prorata amount at the initial time of order. If you enable this, the system will charge all clients on one exact day each month. Otherwise, the product will use the default anniversary billing system (for example, Jun 15–Jul 15).

Note:
Prorata billing is not compatible with the free domain logic or having domain renewal invoices that the system generates further in advance than other products.

  • Prorata Date — If you set this to 1, the system will charge all clients on the 1st of each month.
  • Charge Next Month — After this day of the month, the system will also charge a client for the next month in their initial payment when signing up on a monthly billing cycle. Without enabling this, if you have set the prorata date to 1, and a client signs up on the 30th of the month, they would only pay a small amount. If you enable this, they would pay the prorated amount plus the next month in advance.
    TIP: If you wish to prorate a product but not to enable this feature, set "Prorata Date" to a normal value and "Charge Next Month" to 32.

Module Settings (aka Provisioning)

This tab specifies which server type the product will use and how WHMCS will behave when someone orders this product.

  • From the Module Name menu, select the type of server you're using.
  • Select your desired options. The options you will see depend upon the module chosen. For more information about each module, see the Provisioning Modules section.
  • If a product has no specific module to link to, set it to "Autorelease" in order to simulate the activation and send a welcome email automatically.
  • Select one of the four automation settings for product activation:
    • Automatically setup the product as soon as an order is placed — Set it up instantly. Usually, you would use this for free products.
    • Automatically setup the product as soon as the first payment is received — Perform the setup as soon as the customer pays for the order.
    • Automatically setup the product when you manually accept a pending order — Perform the setup only when an admin has manually reviewed and accepted the order.
    • Do not automatically setup this product — Never auto-set up the product. Admins can still initiate manually from the product details page under a clients profile.

Metric Billing

Usage-billing-module-settings-metric-config.png

The Metric Billing section displays when you select a module that supports this feature (WHMCS version 7.9 and above).

To enable a metric for billing or display purposes, set the toggle to On. If you enable a metric, 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 for a product that reports metrics.

To configure pricing for a metric, click "Configure Pricing" under the given metric name.

For usage and configuration instructions, see Usage Billing.

Custom Fields

From this tab you can create custom fields for this product. This allows you to collect additional order form information that you need to supply the product.

  • Field types consist of text boxes, menus, yes-or-no checkboxes, memo text boxes, and password fields. Text in password fields appear as asterisks (****).
  • You can set fields as admin-only for private data, required or optional on the order form, displayed on the order form, displayed in the client area, or displayed on invoices (such as VAT numbers).

For more information, see Custom Fields.

Configurable Options

Use this tab to select which configurable options to associate with the product. You can display them on the order form or in the client area.

  • Configurable Options allow you to give your clients options that alter the price of the product.
  • For more information, see Addons & Configurable Options.

Upgrades

The sixth tab allows you to specify whether the client can upgrade or downgrade from this product to another.

  • WHMCS can fully automate upgrades and downgrades for many of the modules.
  • In this tab, select the products that the product can be upgrade or downgrade to.
  • Use Ctrl+Click to select multiple products.
  • Select the checkbox to enable the upgrades of configurable options, if there are any on the product.
  • Select an email template to use when a client upgrades to this product from the Upgrade Email menu. You will first need to create a new Product email template under Setup > Email Templates.
  • For more information about how WHMCS calculates and processes upgrades and downgrades, see Automated Upgrades and Downgrades.

Free Domain

Use this tab to configure the offer of a free domain with a product.

  • WHMCS lets you offer free domains with your packages when customers purchase them with certain payment terms. For example, you might want to offer a free domain when someone purchases a package annually.
  • For more information on how to configure this, see Offering Free Domain Registration.

Other

The penultimate tab contains miscellaneous settings such as product affiliate rates, product downloads, and overage billing.

  • Custom Affiliate Payout — The custom payout rate for this specific product if using the built-in affiliate system. This setting overrides or disables the system default commission rate.
  • Affiliate Pay Amount — The percentage or amount paid for a purchase of this product, depending on your choice for the setting above.
  • One Time Payout — Whether to pay only a one-time commission.
  • Subdomain Options — Enter a domain in the format ".yourdomain.com" if you want to offer a free subdomain option for the domain at signup. You can offer more than one by entering a comma separated list (for example, ".yourdomain.com,.yourdomain.net").
  • Product Downloads — Whether to offer files to automatically release to the customer when the product is activated. See Product Downloads Distribution for more information.
  • Overage Billing — Allows you to bill for the product based on disk and bandwidth usage for the month. Refer to Disk Space and Bandwidth Overage Billing for more information.

Links tab

The final tab contains some ready-made URLs to add to linking to this product.

  • Each URL will add the product to the shopping cart and jump straight to the configuration step.
  • There are many more possible variations. For more information, see Linking to WHMCS.

Sorting

Groups and Products are sortable using the crosshair icon on the appropriate row. This is on the left for Groups and the right for Products.

Drag and drop sorting.png

After moving, a success message will appear on the top right of the page to confirm that the system saved the sort order.

Product drag and drop success.png

It is not possible to move products between groups using the drag-and-drop method.

Feature Highlights

Feature Highlights allow you to define features and their values for products in a way that WHMCS can interpret for comparison-based display.

The system supports Feature Highlights for most order form templates. For more information, see Standard Order Form Templates.

Retrieved from "http://3.17.75.209/index.php?title=Products_and_Services&oldid=28419"