WHMCS Documentation - User contributions [en]

Bulk Pricing Updater

2017-12-04T17:22:31Z

StephenU:

This page explains how to adjust the renewal prices for existing products, addons and domains using the Bulk Pricing Updater Tool.

Instructions for how to adjust the price for a single TLD can be found at [[Domain Pricing]].

In WHMCS, to cascade changes in pricing to existing clients requires making use of the bulk pricing updater. In WHMCS it is easy to cascade your price changes out to existing clients using the Bulk Pricing Updater Tool.

1. Begin by navigating to ''Setup > Addon Modules''

2. Locate and Activate the addon named Bulk Pricing Updater (it may already be active in which case you can skip this step)

[[File:Bulkpricingupdater-activate.png]]

4. Next navigate to ''Addons > Bulk Pricing Updater'''. You will be presented with the interface below.

[[File:Bulkpricingupdater-step1.png]]

5. Begin by choosing the type of bulk pricing update you wish to perform. In this example we are going to modify domain pricing, so we'll hit the ''Domains'' button.

5. Next you'll be asked to set the criteria for the update.

[[File:Bulkpricingupdater-step2.png]]

*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

6. The next step will show you a preview of the changes allowing you to confirm your selections before confirming and performing the change. If you're happy with the summary, click ''Perform Update'' to begin the changes.

[[File:Bulkpricingupdater-step3.png]]

The system will confirm success with a report something along the lines of the following:

[[File:Bulkpricingupdater-stepcomplete.png]]

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.

File:Licensingaddonproductconfig.png

2017-11-30T22:41:47Z

StephenU: StephenU uploaded a new version of File:Licensingaddonproductconfig.png

File:Licensingaddonproductconfig.png

2017-11-30T22:34:30Z

StephenU: StephenU uploaded a new version of File:Licensingaddonproductconfig.png

File:Licensingaddonproductconfig.png

2017-11-30T22:32:42Z

StephenU: StephenU uploaded a new version of File:Licensingaddonproductconfig.png

Clients:Summary Tab

2017-03-27T15:25:09Z

StephenU: /* Credit Card Information */

<br/><br/>{{Client Management}}

The Summary tab is first displayed when viewing a client's Profile. It's accessed via the '''Clients > View/Search Clients''' page. It contains an overview of the client's details, some quick billing and service statistics, quick links to many common management actions as well as a list of all their services, domains and addons. This page describes each option available under the Summary tab.
[[File:client_summary.png|thumb|Client Summary Tab]]

==Summary Actions==

The very first thing in the top-left corner of the page is the client's unique ID number and their name. To the right of this are the summary actions, these allow for quick management of billing-related settings. By clicking the red "No" or green "Yes" text you can instantly toggle the status of the available options:

*Exempt From Tax - If Yes the client will not be charged tax even if they meet a tax rule
*Auto CC Processing - If Yes the client's credit card stored in WHMCS will automatically be charged on invoice due dates
*Send Overdue Reminders - If Yes the client will receive overdue reminder emails when their invoices become overdue.
* Apply Late Fees - If Yes the client will be charged a late fee when their invoices become overdue. Late fees must be activated and configured in [[Invoice_Tab#Late_Fee_Type|General Settings]] and [[Automation_Settings#Add_Late_Fee_Days|Automation Settings]]

==Clients Information==

This section displays the client's contact information; name, address and phone number. In addition there are the following links:

===Reset & Send Password===

Clicking this link will instantly generate a new client area password for the client and email it to them.

Clients can also request a password reset themselves by clicking the the '''Forgotten Password''' link on the login form to begin the reset process:

*After entering their email address, if a security question answer is specified they will be prompted to provide the answer, then an email is sent containing a confirmation link to ensure they are actually the one who requested the reset. The reset link is valid for 2 hours from the time of request
**If no security question answer is set, the email will be sent immediately upon entering a valid email address.
*When they click the link in the email, clients will be taken to the password reset validation page where a new password can be specified. They can then login immediately using the new password. If the client didn't request the reset they are advised to simply ignore the email and not click the link.

===Credit Card Information===

Displays a popup containing the client's credit card information (if using a merchant payment gateway) or the Token ID (if using a tokenisation payment gateway).

====Adding a New Card====

You can replace the existing card stored for a client or add one (if none is already stored) at the bottom of this page. Simply enter the card details (card issue and start date are optional) and click '''Save Changes'''.

====Viewing Full Card Number====

In order to view the full card number, on this screen you will see a text area asking for the CC Encryption Hash. This is the random hash key unique to your WHMCS installation which you can find in the configuration.php file. Enter the hash into the text area and click submit, the page will reload showing the full number.

====Removing Card Details====

If you would like to remove card details from a client, simply click the '''Clear Details''' button located at the bottom of the screen.

===Login as Client===

View the client area exactly as this client would see it and even perform actions on their behalf (placing orders, opening tickets etc.) Once you are finished be sure to click the "Return to Admin Area" link in the top-right corner.

==Contacts/Sub-Accounts==

If a client has created Contacts or Sub-Accounts, they will be listed here. Click the contact's name to edit the record. This is explained in more detail on the [[Clients:Contacts_Tab|Contact Tab]] page.

===Add Contact===

Click here to create a new contact or sub-account for this client.

==Invoices/Billing==

In this section quick invoice and billing statistics are displayed; the number of invoices in each status along with the total value of each in brackets. The Total Income statistic shows the total of all transactions paid by the client, whilst the Credit Balance shows the current amount of credit available to the client to spend.

===Create Invoice===

This link creates a [[Invoicing#Creating_Custom_Invoices|custom invoice]]. Clicking the link immediately creates an empty invoice to which line items can be added as desired. This link will not trigger the sending of an email to the client.

===Create Add Funds Invoice===

You can create invoices in this way to allow a client to deposit funds to their account, or to charge a specific amount from a clients credit card. A popup will appear allowing the amount of credit to be specified. [[Add_Funds|More Information]].

===Generate Due Invoices===

Click here to generate any invoices due for the client's services, billable items, domains or addons. Useful if one of the aforementioned items has been modified and a new invoices needs to be generated without the need to run the entire automation cron job. A popup will appear asking whether you wish to send the invoice notification email.

===Add Billable Item===

This link will take you directly to the Add Billable Item interface. Read more about [[Billable_Items|Billable Items here]].

===Manage Credits===

Displays a popup displaying the client's credit history; how credits were earned and spent. Credit can also be manually added and removed using the appropriate buttons. You also have the option to delete entries if you wish and they will then be deducted from the credit balance.

Read more about [[Transactions#Managing_Credit|Managing Credit]] here.

==Create New Quote==

This link will take you directly to the Quote creation interface. Read more about [[Quotes|Quotes here]].

==Other Information==

In this section, miscellaneous information is displayed; the client's status, their client group, signup date, length of time since signup and the IP address, hostname + time of their last login.

==Products/Services==

In this section the numbers all the services, domains quotes, support tickets and affiliate signups for this client are displayed. The active service count is displayed first, with the total - including services in suspended, terminated and cancelled statuses - in brackets.

===View Orders===

Click this link to see a list of all orders placed by this client. Read more about [[Order_Management|Order Management]] here.

===Add New Order===

This link will take you to the admin order form. This allows orders to be placed on behalf of the client, and for products and promotional codes to be used in combinations not possible on the public order form.

==Files==

The files section in a client's summary allows you to upload files specific to that customer.

* This can be used for documents, agreements or other downloads specific to the individual
* Files can be set as Admin Only to only be viewed by admins, otherwise they show on the Client Area Homepage for the client to be able to download
* Files are uploaded to the /attachments directory and can be added and managed from the Client Summary page in the admin area

==Recent Emails==

Displayed here are the last five emails sent to the client by WHMCS. A longer email history can be viewed under the Emails tab.

==Other Actions==

Within this section are a number of miscellaneous links which perform a variety of tasks.

===View Account Statement===

Provides a statement of account for this client accounts between a date range. Displays Type (add funds, transaction, invoice), date, description, credits, debits and a running balance

===Open New Support Ticket===

This link enables you to open a support ticket under the client's account. Useful for initiating correspondence with the client and keeping a full record of the conversation.

===View all Support Tickets===

Click here to see see a list of all support tickets assigned to the client in the departments to which your administrator account is assigned. If the client had tickets in departments of which you are not a member, they would not be displayed here.

===Activate as Affiliate===

If enabled clients can join the affiliate program from within the client area. Staff members can also add the client to the affiliate program by clicking this link.

===View Affiliate Details===

Once the client has been activated as an affiliate, the 'View Affiliate Details' link will be displayed in its place. Click it to see the client's referrals, commissions pending and paid, as well as your payments to them. Read more about [[Affiliates|Affiliates here]].

==Merge Client Accounts==

Merging clients combines 2 separate client accounts in WHMCS into one. This merges everything relating to the 2 separate entities into one including but not limited to products, invoices, transactions, tickets, etc...
[[File:Merge clients.png|thumb|Merge Clients Popup]]
#Begin by locating the first of the clients you want to merge
#Click the '''Merge Client Accounts''' link on the Client Summary page
#In the popup that appears, you will be asked to enter the Client ID. If you don't know the client's ID the Search field can be used to search by name, company or email address. Click the client's name and the ID will be filled in.
#After specifying the second client, you can choose which profile you want to keep, so either merge into the first client, or second client - this determines which profile data is kept - ie. name, email address, etc...
#Once happy, click the submit button to complete the process

===Close Clients Account===

Closing a client's account will prevent them from being able to login to the client area. This link will also change the status of unpaid invoices to cancelled, and all services to cancelled. It will not run any module termination functions.

===Delete Clients Account===

Deleting a client removes everything related to that client from the WHMCS database - except for transactions - they are considered income and that isn't being refunded just because the client is being removed. You will be asked to confirm the deletion, the user will be removed and you will be returned to the Clients List. Should you wish to remove their transactions as well, this should be done via the Transactions tab before deleting the client.

==Send Email==

Use this dropdown to send any 'General' type email templates to clients, or select the "New Message" option to compose a new email from scratch. Product and Domain type emails can be sent using the dedicated dropdowns under the corresponding tabs.

==Admin Notes==

Here staff can enter private notes about the client to be displayed to whoever views this Summary tab. Separate notes sections are available available under the Products/Services , Domains and Notes tab.

==Filtering Products==
[[File:filtering_products.png|thumb|Product Filtering]]
There may be situations where it's desirable to filter the client's product/services list to only display items in certain statuses. For example if a client has lots of old cancelled services you may wish to only display the active, pending and fraud products (hiding the cancelled ones).

To achieve this click the '''Status Filter''' button under the Admin Notes section within the client's Summary tab. A prompt will appear allowing you to select which statuses should be displayed.

The button will turn green so you can tell at-a-glance when the filter is applied.

'''Note:''' The filter selected here will apply across all clients and will be remembered until the web browser is closed.

==Services, Addon, Domains, Quotes==

The Services, Addons, Domains and Quotes lists will often take up the majority of the client's Summary tab. They provide a comprehensive list of all the client's services with you alongside key information for each (such as price, signup date, status and next due date).

The lists are ordered based upon the item's ID number. Click the ID number of the Edit icon to see the full details of the item from where you can make changes.

The Current Quotes section displays quotes with a Valid Until Date up to and included today's date. When this is passed they can be viewed under the [[Clients:Quotes_Tab|Quotes tab]]

==Mass Updating Services/Addons/Domains==

[[File:Mass update.png|thumb|Mass Update Tool]]
The mass update tool in WHMCS allows you to perform changes to 2 or more products inside a clients profile at the same time. The changes can consist of changes in the price, billing cycle, next due date, status and/or payment method and setting an override auto-suspend date. For example you can use this if you want to reduce a clients price on a number of separate products to the same level, execute module commands in bulk or if you would like to bring multiple services in line to a matching due date.

To use this feature from the Clients Summary page:

#Tick the checkboxes next to the Products/Services, Addons and/or Domains you want to update,
#Below the item lists click the '''Mass Update Items''' button which will reveal the options which you can set.
#Make your selections (leaving blank any fields you don't want to change),
#Finally submit to complete the changes.

[[File:Videotutorial.png‎|center|link=http://www.youtube.com/watch?v=WLLsQML6rEU|Watch Video Tutorial]]

===Create Prorata Invoice===
This useful feature means that when changing the Next Due Date of a product/service/addon/domain a pro-rated invoice is created covering the period between the current next due date and the new one. It even works when the various products have different next due dates to start with and will pro-rate each accordingly as separate line items on the invoice.

To use simply specify the new Next Due Date and tick the '''Create Prorata Invoice''' checkbox before clicking Submit.

For example take two products that the client now wishes to pay on the 10th of the month going forward:

Product A - Next Due Date 01/01/2012 @ $30/month
Product B - Next Due Date 05/01/2012 @ $60/month

Set the Next Due Date to 10/01/2012 and tick the checkbox, an invoice with the following line items will be generated:

Product A (01/01/2012 - 09/01/2012) $8.00
Product B (05/01/2012 - 09/01/2012) $10.00
Total Due Today $18.00

Only once paid will the Next Due Dates for both products be updated and in future both products would be invoiced on the 10th January.

==Invoice Selected Items==

There may be times where a client asks for you to invoice them for the next renewal date early. To do this in WHMCS,

#Begin by navigating to the '''Clients Summary''' page for the client you want to invoice
#Now tick the boxes of the '''Products/Services/Addons''' and/or '''Domains''' you want to generate an invoice for
#To complete, click the '''Invoice Selected Items''' button to create the invoice(s) for them
#Multiple invoices may be created if the due dates and payment methods differ as invoicing rules are obeyed as normal

'''Note:''' You won't be able to generate another invoice if an invoice has already been made for the next due date.

'''Note:''' If the Separate Invoices option is enabled in the client's Profile or Client Group, when selecting multiple items here with the same Next Due Date, it will not apply and all possible items will be invoiced together. If you need to split them up, you can edit the resulting invoices and use the Split Invoice function.

==Delete Selected Items==

This button can be used to delete multiple items en-mass. Tick the checkboxes next to the services, domains, addons or quotes you wish to remove from WHMCS and click the Delete Selected Items button.

This will remove the record form WHMCS, but will not trigger any module commands (ie. a hosting account associated with a service will stay on the server).

Payment Gateways

2017-01-16T02:37:32Z

StephenU: /* Supported Gateway Modules */

==Setting Up Gateway Modules==

[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]

Payment gateways can be configured in '''Setup > Payment Gateways'''. Each gateway has their own specific API requirements in order to process transactions so they will vary from gateway to gateway. However, all gateways have 3 core options:

*'''Show on Order Form''' – Checking this box will mean it can be shown on the order form as an option – subject to product group gateway restrictions
*'''Visible Name''' – The name that is used for this gateway throughout the system and to clients (eg. gateway can be Authorize.net, visible name might be Credit Card)
*'''Convert To For Processing''' – This option is for when using multiple currencies. It is possible that not every gateway you use will accept all the currencies you offer on your site and so for those that don’t, you can choose a currency here for WHMCS to convert to before sending to them. For example if using Google Checkout with a UK account but offering prices in GBP & USD, you would need to select GBP in the Convert To box. This will use the rates set in '''Setup > Payments > Currencies''' to do the conversion which can be set to auto update daily.

==Supported Gateway Modules==

The following is a list of all the payment gateways that are included in WHMCS by default. '''Merchant Gateways''' store credit card information securely in the WHMCS database whilst '''Third Party Gateways''' take the client to the provider's website to process payments off-site. '''Tokenisation Gateways''' are a happy medium where repeat billing is possible by storing the original transaction details or a reference number, not the full credit card number, thus reducing your PCI liabilities.

Please note that for tokenisation gateways, the client will need to pay an invoice manually using their credit card details before their information is transmitted to the merchant provider and a profile is created in their systems. They then send back a token to WHMCS which will be used for managing the card detail update requests via the client area and recurring payments.

The type of payment gateway selected influences which invoice notification email template it sent; Third Party Gateways will send the "Invoice Created" email template, whilst Merchant and Tokanisation Gateways will send the "Credit Card Invoice Created" email template. This allows you to customise the payment instructions to clients for the different payment processes.

The type of payment gateway also influences the behaviour of the '''Attempt Capture''' button on the invoice page in the admin area. With Third Party Gateways the button will be deactivated as the client needs to click the payment button on the invoice to send payment. For Merchant Gateways and Tokanisation Gateways the button will be active and staff can click Attempt Capture to instantly capture payment from the client's credit card.

Any gateways showing in blue below indicates further information relating to the setup & use of that gateway is available by clicking on the name.

It is also possible to create your own gateway modules for WHMCS should you want to integrate with a gateway that isn't offered by default. Please refer to our [https://developers.whmcs.com/ Developer Resources] section for more details.

===Merchant Gateways===

<div class="row">
<div class="col-sm-4">

[[AsiaPay]]<br />
[[Authorize.net]]<br />
[[BluePay]]<br />
[[CamTech]]<br />
[[Cyberbit]]<br />
[[eMatters]]<br />
[[eProcessingNetwork]]<br />
[[eWay]]<br />
[[FastHosts]]<br />
[[IMSP]]<br />
[[InternetSecure]]<br />
[[IP.Pay]]<br />
[[Kuveytturk|Kuveytturk Bank]]<br />

</div>
<div class="col-sm-4">

[[LinkPoint]]<br />
[[Merchant Partners]]<br />
[[Moneris]]<br />
[[Merchant Warrior]]<br />
[[NaviGate]]<br />
[[NETbilling]]<br />
[[Netregistry Pay]]<br />
[[NTPNow]]<br />
[[Offline Credit Card]]<br />
[[Optimal Payments]]<br />
[[Payflow Pro]]<br />
[[Pay Junction]]<br />
[[PayPal Payments Pro]]<br />

</div>
<div class="col-sm-4">

[[Planet Authorize]]<br />
[[PSIGate]]<br />
[[Quantum Gateway]]<br />
[[Secure Trading]]<br />
[[SagePay]]<br />
[[SecPay]]<br />
[[SecurePay]]<br />
[[SecurePay AU]]<br />
[[TrustCommerce]]<br />
[[USA ePay]]<br />
[[WorldPay Invisible]]<br />
[[WorldPay Invisible|WorldPay Invisible XML]]

</div>
</div>

===Tokenisation Gateways===

For token type gateways, which store a token to use for processing credit card payments through the merchant gateway module, the token will not be added into WHMCS until a payment has been submitted through the module. This will lead to the credit card details being stored in the database directly until the client makes a payment on an invoice through one of the token type gateway modules. Once the payment is made, the token is then fetched and replaces the credit card details within the database. Storage of the credit card details can also happen when the client updates their credit card details or when placing an order and it does not process the payment immediately.

{| width="100%" cellpadding="2" style="width:100%;"
|-
| width="33%" | [[Authorize.net CIM]]
| width="33%" | [[BluePay#BluePay_Remote|Bluepay Remote]]
| width="33%" | [[Moneris#Moneris_Vault|Moneris Vault]]
|-
| [[PayPal_Website_Payments_Pro#Reference_Payments|PayPal Pro Reference Payments]]|| [[Quantum Vault]] || [[SagePay#SagePay_Tokens|SagePay Tokens]]
|-
| [[WorldPay#FuturePay_Specific_Items|WorldPay FuturePay]] || [[eWay Tokens]]
|}

===Third Party Gateways===

{| width="100%" cellpadding="2" style="width:100%;"
|-
| width="33%" | [[2CheckOut]]
| width="33%" | [[AlertPay]]
| width="33%" | [[Amazon Simple Pay]]
|-
| [[Authorize.net#Echeck_Module|Authorize.net Echeck]] || [[Bank Transfer]] || [[BidPay]]
|-
| [[BluePay|BluePay Echeck]] || [[Boleto]] || [[CC Avenue]]
|-
| [[CashU]] || [[ChronoPay]] || [[Direct Debit]]
|-
| [[F2B|Cobrança - F2b]] || [[Forte]] || [[E-Gold]]
|-
| [[e-Path]] || [[EWAY_UK]] || [[Gate2Shop]]
|-
| [[GoCardless]] || [[iDEAL]] || [[iDEALMollie|iDEAL via Mollie]]
|-
| [[inpay]] || [[Mail In Payment]] || [[Modulo Moip]]
|-
| [[Skrill]] || [[NoChex]] || [[PagSeguro]]
|-
| [[PayPal]] || [[PayPal Express Checkout]] || [[PayPoint|PayPoint.net (SecPay)]]
|-
| [[Payson]] || [[Paymate_AU_and_NZ]] || [[Payment Express]]
|-
| [[Paymex]] || [[Payza]] || [[Planet Authorize]]
|-
| [[ProtX VSP Form]] || [[Finansbank|Turkish Finansbank]] || [[GarantiBank|Turkish Garanti Bank]]
|-
| [[WorldPay]]
|}

==Deactivating Gateway Modules==

[[File:Deactivate.png|thumb|Deactivate Gateway]]
Should you no longer wish to use a particular payment gateway clicking the red ''(Deactivate)'' link beside the name will gracefully remove the gateway from the system. This will prevent any further payments being made using this gateway and automatically reassign any products/services/invoices assigned to that payment method to another option. Upon clicking the deactivate link, a popup window will appear prompting for the selection of the alternative payment gateway to which any currently assigned items should be changed to.

==Test Credit Card Numbers==

Gateways often have test modes where you can use test card numbers. The common test card numbers are below and should generate successful test transactions but they can vary from gateway to gateway. You may use any expiration date in the future.

4007000000027 - Visa Test Card
4012888818888 - Visa Test Card II
4000000000000002 - Visa Test Card III
5424000000000015 - MasterCard Test Card
370000000000002 - American Express Test Card
6011000000000012 - Discover Test Card
3088000000000017 - JCB Test Card (Use expiration date 0905)
38000000000006 - Diners Club/Carte Blanche Test (Use expiration date 0905)

==Troubleshooting==
The documentation for troubleshooting problems processing payments with WHMCS are split into two sections; Gateway Specific Troubleshooting. and General Troubleshooting. We first recommend checking the [[Payment_Processing_Issues|General Troubleshooting]] section which explains how to check and correct problems which can occur with many different payment gateways.

If that does not contain the solution to the problem, the next stop should be the [[Payment_Gateways#Merchant_Gateways|dedicated page]] of the documentation relating to your payment gateway. Many contain Troubleshooting sections which explain errors that relate specifically to that payment gateway.