Difference between revisions of "Bulk Pricing Updater Addon"

Latest revision as of 09:53, 10 November 2022

About this Addon Module

You can use the Bulk Pricing Updater addon to apply system-wide price changes to existing clients' products, addons, and domains based on criteria you set, like the product, billing cycle, status, current price, or addons.

By default, changes to the pricing of products, addons, and domain TLDs in WHMCS do not apply to existing clients. Existing clients will remain at the prices they agreed to at the time of placing an order.

Addon Name	Latest Release	Current Version	Compatible With	Included in WHMCS
Bulk Pricing Updater	20th November 2020	3.0	WHMCS 5.2.0 and later	Yes

You can use the Bulk Pricing Updater addon to apply system-wide price changes to existing clients' products, addons, and domains.

Installation

Because this addon ships with WHMCS by default, you only need to activate the addon through the Admin Area.

To do this:

Go to Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.
Click Activate for Bulk Pricing Updater.
Click Configure.
Select the admin role groups who will have access to this addon.
Click Save Changes.

Using this Addon

You can access and use this addon by navigating to Addons > Bulk Pricing Updater and following the displayed instructions.

The available options depend on the type of item you choose to update.
You cannot provide a new price and an amount to increase existing prices. You must only choose one of these options.
Unchecking all of the Addon checkboxes will only update domains with no active addons. Checking multiple options will perform an AND search.
The new recurring amount is the service price including discounts and configurable options.

Updating Domain TLD Pricing

Once you proceed with an update, you cannot undo the action. Check your settings carefully.

To perform a pricing update:

Go to Addons > Bulk Pricing Updater.
Choose the type of item you wish to make a pricing update to.
Specify the criteria for identifying the items you wish to change the pricing on by checking the corresponding TLD checkboxes.
Select the statuses you want to apply the change to.
- We recommend only Pending, Pending Transfer, and Active statuses.
- Expired and Cancelled domains won't receive invoices again.
Select the Registration Period you want to apply the change to (for example, one or two years). You will need to run an update for each pricing term you offer.
If you only wish to change the price of domains with specific addons active, check the relevant Domain Addons checkboxes. This is useful for adjusting the price of the individual addons (for example, to increase the price of ID Protection, select the ID Protection checkbox).
The currency and current price are optional. If you run multiple currencies then you would need to do a separate update request for each currency, and if you have certain clients on older or special pricing, you can use the current price field to restrict a change to only users with a specific current price, thus allowing you to keep the users on different pricing.
The system will prompt you to provide either a New Price to assign matching items to, or an amount to Increase Existing Prices By. You should only ever specify one or the other of these (never both).
Confirm that the displayed summary is correct. Once you proceed, you can't undo the action, so be sure to check the proposed changes and criteria.

The system will perform the update and the addon will tell you the number of items that the system adjusted. Upon completion of an update, if you find it didn't apply to as many items as you had expected, you can go back and refine your criteria further.

You can repeat this process as many times as needed to cover all the different product or domain registration periods and domain addon combinations you wish to change.

When you select the TLDs to update pricing for, only select TLDs that will have the same price. You must perform this action separately for separate prices.
When updating prices for domain TLDs, do not select Annually or Biennially. They are product billing cycles. You will need to run an update for each pricing term you offer.

Recommendations

We recommend applying changes only to the Pending and Active statuses. Expired and Cancelled domains won't be billed again.
If you use multiple currencies, perform a separate update for each currency.
If you have clients on older or special pricing that you do not want to change, you can use the current price field to restrict a change to only users with a specific current price.

Troubleshooting

N/A

Changelog

Version 3.0 - 5th September 2014

Added support for performing updates based on Domain Addons
Added support to perform price increases by a relative amount
Redesigned interface for improved workflow
Various other bug fixes

Version 2.0 - 25th September 2011

Add Triennial support
Add currency selection options
Fixed Typo

Version 1.0 - 15th August 2009

Initial Release

@@ Line 1: / Line 1: @@
-''' - Addon Name:''' Bulk Pricing Updater<br />
+== About this Addon Module ==
-''' - Latest Release:''' 20th November 2020<br />
-''' - Current Version:''' 3.0<br />
-''' - Compatible With:''' WHMCS V5.2.0 & Later
-The Bulk Pricing Updater Addon utility can be used to apply system wide price changes to existing clients' product, addons and domains.
+You can use the '''Bulk Pricing Updater''' addon to apply system-wide price changes to existing clients' products, addons, and domains based on criteria you set, like the product, billing cycle, status, current price, or addons.
-==Questions & Answers==
+By default, changes to the pricing of products, addons, and domain TLDs in WHMCS do '''not''' apply to existing clients. Existing clients will remain at the prices they agreed to at the time of placing an order.
-'''What does the addon do?'''
+<table class="table" style="text-align:center;margin:1em 1em 1em 0;background:#F9F9F9;border:1px #AAA solid;border-collapse:collapse;width:100%;">
+<tr>
+<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Addon Name</th>
+<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Latest Release</th>
+<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Current Version</th>
+<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Compatible With</th>
+<th style="border:1px #AAA solid;padding:0.2em;background:#F2F2F2;text-align:center;">Included in WHMCS</th>
+</tr>
+<tr>
+<td style="border:1px #AAA solid;padding:0.2em;">Bulk Pricing Updater</td>
+<td style="border:1px #AAA solid;padding:0.2em;">20th November 2020</td>
+<td style="border:1px #AAA solid;padding:0.2em;">3.0</td>
+<td style="border:1px #AAA solid;padding:0.2em;">WHMCS 5.2.0 and later</td>
+<td style="border:1px #AAA solid;padding:0.2em;color:darkgreen;">Yes</td>
+</tr>
+</table>
-This addon allows you to make changes to your existing clients' product, addon and domain renewal prices based on a number of criteria including product, billing cycle, status, current price, addons, etc...
+You can use the '''Bulk Pricing Updater''' addon to apply system-wide price changes to existing clients' products, addons, and domains.
-'''When should I use this?'''
+==Installation==
-You will need to use this addon any time you want to increase the pricing for your existing clients.
+Because this addon ships with WHMCS by default, you only need to activate the addon through the Admin Area.
-This is necessary because by default, changing the pricing of products, addons and domain TLDs in WHMCS does not cascade to existing clients. That is, existing customers always remain at the prices they were shown and agreed to at the time of placing an order.
+To do this:
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
+# Click '''Activate''' for '''Bulk Pricing Updater'''.
+# Click '''Configure'''.
+# Select the admin role groups who will have access to this addon.
+# Click '''Save Changes'''.
-'''How do I get it?'''
+=== Using this Addon ===
-The module is included as standard in the WHMCS full release files.
+You can access and use this addon by navigating to '''Addons > Bulk Pricing Updater''' and following the displayed instructions.
-==Installation==
+* The available options depend on the type of item you choose to update.
+* You '''cannot''' provide a new price ''and'' an amount to increase existing prices. You must '''only''' choose one of these options.
+* Unchecking all of the '''Addon''' checkboxes will only update domains with no active addons. Checking multiple options will perform an <tt>AND</tt> search.
+* The new recurring amount is the service price including discounts and configurable options.
-This module already comes standard in WHMCS. Simply log in to your WHMCS admin area and navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Addon Modules]]''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''. You will find the module "Bulk Pricing Updater" available to Activate.
+=== Updating Domain TLD Pricing ===
-==Usage==
-Once activated, the addon can be accessed by navigating to Addons > Bulk Pricing Updater within your WHMCS admin area.
 <div class="docs-alert-warning">
-<span class="title">Don't See It?</span><br />
+Once you proceed with an update, you '''cannot''' undo the action. Check your settings carefully.
-If you do not see this option, ensure you have granted access to use it to your admin role group in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Addon Modules''' or, prior to WHMCS 8.0, '''Setup > Addon Modules'''.
 </div>
-Upon visiting the Addons > Bulk Pricing Updater page you will be guided through the process of performing a price update using a stepped wizard interface as shown below.
+To perform a pricing update:
+# Go to '''Addons > Bulk Pricing Updater'''.
-[[File:Bulkpricingupdater-step1.png]]
+# Choose the type of item you wish to make a pricing update to.
+# Specify the criteria for identifying the items you wish to change the pricing on by checking the corresponding TLD checkboxes.
-*'''Step 1''' - Choose the type of item you wish to make a pricing update to - this is one of either Products/Services, Addons or Domains. In this example we are going to modify domain pricing, so we'll hit the Domains button.
+# Select the statuses you want to apply the change to.
+#* We recommend only Pending, Pending Transfer, and Active statuses.
-*'''Step 2''' - Specify the criteria for identifying the items you wish to change the pricing on
+#* Expired and Cancelled domains won't receive invoices again.
+# Select the Registration Period you want to apply the change to (for example, one or two years). You will need to run an update for each pricing term you offer.
-[[File:Bulkpricingupdater-step2.png]]
+# If you only wish to change the price of domains with specific addons active, check the relevant Domain Addons checkboxes. This is useful for adjusting the price of the individual addons (for example, to increase the price of ID Protection, select the ID Protection checkbox).
+# The currency and current price are optional. If you run multiple currencies then you would need to do a separate update request for each currency, and if you have certain clients on older or special pricing, you can use the current price field to restrict a change to only users with a specific current price, thus allowing you to keep the users on different pricing.
-* The options available to you here will vary depending upon the type of item you have requested to update
+# The system will prompt you to provide either a New Price to assign matching items to, or an amount to Increase Existing Prices By. You should only ever specify one or the other of these (never both).
+# Confirm that the displayed summary is correct. Once you proceed, you can't undo the action, so be sure to check the proposed changes and criteria.
-* You will also be asked to provide either a New Price to assign matching items to, or an amount to Increase Existing Prices By. You should only ever specify one or the other of these - never both.
-* Select the TLD(s) at the top you would like to change the price for by ticking the checkbox next to the specific TLD, remember, you may want to do each TLD individually if you are wanting to charge different prices for each.
-* Next it's onto selecting the Billing Cycles you want to apply the change to. Don't make the mistake of selecting Annually or Biennially here, those are product billing cycles, instead you're looking for the "Domain" related terms which are a bit further down the list - Domain: 1 Year, Domain: 2 Years, etc... You will need to run an update for each pricing term you offer.
-*Next select the statuses you want to apply the change to, just Pending and Active statuses are what we recommend as Expired and Cancelled domains won't be billed again
-*Tick the appropriate Addon checkboxes; leaving all the tick boxes empty will update only the domains with no active addons. Ticking multiple options will perform an AND search.
-*The next 2 fields are optional - they are currency and current price. If you run multiple currencies then you would need to do a separate update request for each currency, and if you have certain clients on older or special pricing, you can use the current price field to restrict a change to only users with a specific current price, thus allowing you to keep the users on different pricing
-*Last, you enter the new recurring price in the field that you want to assign to the customers. Note: The new recurring price is inclusive of configurable options.
-*'''Step 3''' - Review - This step provides a summary of your criteria and the change that will be made and asks you to confirm everything is correct. If you're happy with the summary, click Perform Update to begin the changes.
-[[File:Bulkpricingupdater-step3.png]]
-* Once you proceed, the action cannot be undone, so be sure to check the proposed changes and criteria.
-*'''Step 4''' - Perform Update - The updates will be performed and the addon will tell you the number of items that were adjusted.
-[[File:Bulkpricingupdater-stepcomplete.png]]
+The system will perform the update and the addon will tell you the number of items that the system adjusted. Upon completion of an update, if you find it didn't apply to as many items as you had expected, you can go back and refine your criteria further.
-* Upon completion of an update, if you find it didn't apply to as many items as you had expected, you will be given the option to go back and refine your criteria further should you wish to edit the choices you made and try again.
+You can repeat this process as many times as needed to cover all the different product or domain registration periods and domain addon combinations you wish to change.
+* When you select the TLDs to update pricing for, only select TLDs that will have the same price. You must perform this action separately for separate prices.
+* When updating prices for domain TLDs, do not select ''Annually'' or ''Biennially''. They are product billing cycles. You will need to run an update for each pricing term you offer.
-You can repeat this process as many times as needed to cover all the different product and/or domain registration periods and domain addon combinations you wish to change.
+=== Recommendations ===
+* We recommend applying changes only to the ''Pending'' and ''Active'' statuses. ''Expired'' and ''Cancelled'' domains won't be billed again.
+* If you use multiple currencies, perform a separate update for each currency.
+* If you have clients on older or special pricing that you do not want to change, you can use the current price field to restrict a change to only users with a specific current price.
-The process for updating product pricing is almost exactly the same as updating the pricing for domains. The difference is that you will need to select the Product Names and Billing Cycles instead of TLDs and Registration Periods. The user interface you are presented with is shown below.
+== Troubleshooting ==
-[[File:Bulkpricingupdater-criteria.png|720px]]
+''N/A''
 ==Changelog==

Documentation