As a provider, you are able to handle all details of your reseller groups and set up pricing rates for each product in a particular group effortlessly.
Moreover, your resellers grant all crucial information about placed orders along with API documentation. As for end clients, they are able to buy preferred products and perform basic actions on them later.

In the most recent versions of the module, you will find only one package that supports PHP 7.4 and later.

The content of the package to upload should look like this.

File is located in 'modules/addons/ProductsReseller/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

This folder is available at 'yourWHMCS/modules/addons/ProductsReseller/'.

Log in to your WHMCS admin area. Go to 'WHMCS Admin Area' → 'System Settings' → 'Addon Modules' . Afterwards, find 'Products Reseller' and press the 'Activate' button.

To do so click on the 'Configure' button, tick 'Full Administrator' and press 'Save Changes'.

You can access your module at 'Addons' → 'Products Reseller'.

Here you may set up general options but still, you will be able to change them per single group. If you skip group settings, this configuration will be taken into account.

Global API related section:

• API Status - enable/disable Products Reseller API.
  
• IP Addresses Restriction - enable/disable restricting connection to Products Reseller API only for IP addresses specified in the 'Allowed IP Addresses' field.
  
• API Requests Restriction - enable option to restrict the number of API requests.
  

• Low Credit Notification - a notification to your client will be sent when credit balance on client's account falls below entered value.
  You may view and edit the "Low Credit Notification" custom email template sent to clients at 'WHMCS' → 'Setup' → 'Email Templates'. This email message is sent with the main WHMCS cron job.

• Low Credit Amount - amount of credits, when reached a notification will be sent.
  

• Payment Type options:
  • After Create - resellers must have sufficient credits amount, but he is charged only after a product has been successfully created.
  • After Order - resellers must settle the payment just after the order, the amount due is taken from his account instantly.

• Block Unsuspend Action for - enter phrases, one per line; if any phrase is used as a suspension reason, the related product will not be automatically unsuspended

• Skip Successful Actions - select from available actions which you do not need to be logged on the 'Logs section.
  Note that only successful messages will be omitted, all unsuccessful action will be still logged.
  

Remember to submit the changes, once you have finished.

• API Status - enable/disable Products Reseller API for Resellers assigned to this very group only
  
• IP Address Restriction - enable/disable restricting connection to Products Reseller API only for IP addresses specified in the 'Allowed IP Addresses' field.
• API Requests Restriction - enable option to restrict the number of API requests.
• Show API Documentation - toggle to allow resellers access to API documentation directly from their Reseller Area.
• Low Credit Notification - turn on sending notifications to your client when credit balance on client's account falls below entered value.
  You may view and edit the "Low Credit Notification" custom email template sent to clients at 'WHMCS' → 'Setup' → 'Email Templates'. This email message is sent with the main WHMCS cron job.
• Low Credit Amount - amount of credits, when reached a notification will be sent
• Payment Type options:
  • After Create - resellers must have sufficient credits amount, but he is charged only after a product has been successfully created.
  • After Order - resellers must settle the payment just after the order, the amount due is taken from his account instantly.

Note: Please remember that upon unsuccessful product creation, the module does not take any credits from the Reseller Account.

Save the changes when ready.

Press 'Add Integration' to begin.

• Enter your module unique name

• Type in a short description of the module, it will be visible on the activation page of the registrar

• Upload a file with documentation if you have prepared any - you may use any format.
  The provided documentation may be a form of guidebook for Resellers on how to install and configure the module.
  It is the responsibility of Providers to inform their Resellers about essential reselling tips and others.

1. Edit its details (change name, description, or file) at any time
2. Download the documentation
3. Download the integration package
4. Delete the integration

Press the 'Assign Product' button to begin.

• Settings
• Set Pricing
• Unassign Product

Note 1: Please remember that ' First Payment' does not stand for ' Setup Fee' .
Note 2: If you decide to set pricing for a particular period, keep in mind that you need to complete both fields - 'First Payment' as well as 'Recurring'
in order for the pricing to be displayed in the Reseller Area.
Note 3: The module does not support 'Free' billing cycle. If you wish to offer a product for free please ensure that you configure the product price as a one-time charge, set to 0.00; One Time = 0.00.
It is crucial that the reseller's product settings align with this configuration to prevent any issues for end-clients in relation to their purchased products.

Press 'Assign Group' to begin.

• Update Pricing (1)
• Unassign Configurable Options Group (2)

Important: It is not possible to disable the config option from sale by entering '-1' in contrast to products.
Important 2: If you change the config option price to 0.00 such config option will be free of charge.

• Select one of your previously created groups, to which the reseller should be assigned.

• Then select one of your clients from the dropdown, start typing to see a list of clients

• Generate an API Key for the Reseller, it will be necessary when configuring the integration module with the Reseller's platform

• Prepare a list of allowed IP addresses, use comma or space to separate - note that this option must have been enabled previously in the module general settings here

• API Status - toggle to allow reseller generate the API key in the Reseller Area

• API Limits - toggle to be able to define precise limits
  • API Interval [Min] - enter a time interval in minutes in which a number of API requests provided below can be called
  • API Requests Limit - maximum number of API requests in the time interval

Apart from them, you may preview the API Email Address and API Key required to activate and configure the integration module.

In order to add a new response template press the 'Create Template' button and then follow the below instructions.

• For Text type, simply provide a string like 'Error Response'.
  
• For Regular Expression type, you need to provide a regular expression which will be replaced.
  For example, if you want to replace any dollar price in the response provide '\$\d+\.\d+', in this case it will replace strings like '$8.25'.
  
• If you want to replace any response, simply type '.+' in here.

• choose 'Text' or 'Regular Expression' from Type dropdown menu.
  

It will specify if provided text in the first field should be treated as a text or a regular expression while searching for a pattern.

• Registrar Action - must be chosen from dropdown menu as well to specify upon which action provided patterns will be searched for.

Remember, to finish successfully you need to press the 'Confirm' button.

This API documentation has been prepared to allow you to write your own integration modules for platforms other than WHMCS.

The 'Information' subtab contains:

• Endpoint - URL to which all the API requests are directed

• Authorization - Username and token parameters to authenticate the client in the API request

• Example - exemplary request to API to renew a product

Important! Please remember that the following API Calls: 'Start', 'Reboot', 'Stop', 'Details', 'Graphs' are currently available only for Proxmox VE VPS products
while actions such as 'SSL Step One', 'SSL Step Two', 'SSL Step Three', 'Get Info' work only for SSL Certificates products.

Note: The screen below does not capture all the supported functions.
Full API functionality can be found on the module features list at the top of this documentation.

Go to 'Services' → 'Reseller Area' to access them.

This API documentation has been prepared to allow you to write your own integration modules for platforms other than WHMCS.

'Information' tab contains:

• Endpoint - URL to which all the API requests are directed

• Authorization - Username and token parameters to authenticate the client in the API request

• Example - exemplary request to API to renew a product

Important! Please remember that the following API Calls: 'Start', 'Reboot', 'Stop', 'Details', 'Graphs' are currently available only for Proxmox VE VPS products
while actions such as 'SSL Step One', 'SSL Step Two', 'SSL Step Three', 'Get Info' work only for SSL Certificates products.

Please refer to section Integrations to learn how to generate an integration module for your resellers.

Once you have uploaded the integration module, you should find a new folder with this module in 'resellerWHMCS/modules/servers/' directory as presented below.
Important: The folder and module name as well as a description of the extracted integration module are customized by the provider and will be different than the one presented in the example below.

To do so, move to 'System Settings' → 'Servers'. Once you are there, press 'Add New Server'.

• Name - server free name
• Hostname - provide any hostname
• Module - your integration module name
• Username - API email address
• Password - API Key
• Access Hash - Endpoint

At this point, you need to create a new group for your server. For that purpose, press 'Create New Group'.

Forward to 'System settings' → 'Products/Services' → 'Products/Services' and create a new group.

To create a product, click on 'Create a New Product'.

Welcome emails are sent to the end-client once the product creation is completed and contain important details such as account/service credentials, server information, assigned IP addresses etc.
Before you choose or create your own product's 'Welcome Email' , please make sure which of the merge fields variables in the email template are currently supported by the product.
You can find more information about setting up email templates and using merge fields variables here.

Note that if you select Auto, original billing cycle from your WHMCS will be assigned to this product.

Please remember that actions visible on the below screen are available only for Proxmox VE VPS products.
Every other integration module has its own options, see the features list to check options of every integration.

Remember to save the changes in the end.
Please note that the below screen stands for Proxmox VE VPS integration product module settings.

The following picture presents a Proxmox VE VPS product. As you can see, the enabled options appear in the side menu with additional information about the product at the bottom of the page:

• Get VM Details
• Get VM Graphs
• Start VM
• Stop VM
• Reboot VM
• Reinstall VM
• Access noVNC, Xterm.js and Spice Console

You may find details of the Configurable Options assigned to this product in the next tab.

Note: Please remember that the options presented below are dedicated to Proxmox VE VPS products.
Important! For other modules, the side menu section with supported features will look like for products based on the 'Auto Release' module. For more info click here.

For now, have a look below for the picture of the client area view in the case of the EasyDCIM Dedicated Servers product.

Supported actions:

• Get VM Details
• Get VM Graphs
• Boot VM
• Reboot VM
• Shutdown VM

If the resold product is an SSL certificate, here that of GoGetSSL, you are allowed to manage the product in the client area as shown below:

When OpenStack Projects product is resold, the client area will look as below.

Supported actions:

• Get Project Details
• Log In To Control Panel

The picture below presents what the client area looks like in the case of the Plesk Key Administrator product.

Dedicated integration between Products Reseller For WHMCS and the Virtualizor WHMCS Module allows provisioning of servers and access to VNC console and selected graphs.

• Start
• Reboot
• Stop
• Power Off
• Graphs
• VNC Console
• Request Cancellation

• Reissue License
• Request Canellation

Follow the steps below to create and configure the Products Reseller product:

1. In order to create a new Products Reseller product, go to 'System Settings' → 'Products/Services'.
Press 'Create New Group' to add a new one.

Note that there is no server that shall be selected. Your product is ready to order!

• Create - once a client orders the product, go to Client's Products/Services and run the 'Create' action.
  When successful, the client appears on the list of resellers in your addon (see the screen below)

• Suspend - after successful Suspend action in the Client's Products/Services, the ' API Key Status ' of this reseller is switched off

• Unsuspend - run 'Unsuspend ' command to again switch on the reseller's 'API Key Status '

• Terminate - when the product is terminated, the Reseller's 'API Key Status' is again switched off

They will get access to 'Reseller Area', where from they can resell the products, that belong to the pricing group, further.

In a basic workflow 3 users take part:
Provider – a person with Products Reseller For WHMCS installed on the WHMCS system.
Reseller - a provider's client who aims at reselling products offered to him by the provider.
The reseller must own a system with integration module generated for him by the provider with Products Reseller For WHMCS.
End Client – a person with a client account in the Reseller's WHMCS.

Provider's Part
Let us start from the beginning. Provider installs Products Reseller For WHMCS in the system.
He already has some products in the offer and wishes to allow the reseller to resell them.
Now, the provider configures Products Reseller For WHMCS, creates groups, configures them and assigns products, config options and defines their pricing for the reseller who is assigned to one of the groups.
Finally, selects which of the clients will become resellers, assigns them to previously created groups and generates access details.

Reseller Part
The Reseller has access to the Reseller Area once logged into the provider's client area.
There, he can download both the integration module and its documentation as well as generate and copy any API details required to activate the integration module in his own system.
Then, the reseller needs to set up products that the provider allows him to resell with the integration module delivered by the provider. Defines the pricing (prices must be higher than the ones the provider has set up to generate any income).
There is one step that separates the reseller from offering the product from his system.
The reseller must add funds to his credit balance in the provider system to be able to pay off the charges and settle the amounts owed to the provider for his resold products.
Provider creates an 'add funds invoice' for the Reseller, the Reseller pays the invoice and then again the Provider adds the same amount to Reseller's credit balance.
From now on, any product can be ordered.

End Client
End Client orders a product from his client area in the Reseller's system.
Once the payment is complete, details of the ordered product (i.e account credentials) are sent to the end-client mail address using the selected reseller's welcome email template.

Last Word About Payment
Now, that the End-Client has ordered and paid the reseller for the product, at the provider's system a new invoice for that product is created automatically (on behalf of the reseller).
Depending on the selected "Payment Type" configuration the invoice will be paid with credits and product attempted to be created or attempt to create the product and if successful, the invoice will be paid with credits.
In case the reseller does not have sufficient credits on his account to pay for the product creation, the process is stopped until the invoice is manually paid by the reseller.
The reseller's income is the difference between the price of the sold product to the End-Client and the price he paid to the provider.

• Product A (without any config options) → Product B (without any config options) - additional payment is required or adequate amount of money is returned, depending on the number of days remaining until the end of the billing cycle
• Product A (with config options) → Product B (without any config options) - additional payment is required or adequate amount of money is returned, depending on the number of days remaining until the end of the billing cycle
• Product A (without any config options) → Product B (with config options):
  • Case 1: products A and B have the same Configurable Options Group assigned - additional payment is required or adequate amount of money is returned, depending on the number of days remaining until the end of the billing cycle
  • Case 2: products A and B have different Configurable Options Groups assigned - this upgrade scenario is not supported
• Changing billing cycle within one product (with or without configurable options) - additional payment is required or adequate amount of money is returned, depending on the number of days remaining until the end of the billing cycle

You are able to easily prepare integration module for any system (Blesta, HostBill, Clientexec, BoxBilling, and many more) using Products Reseller For WHMCS API.
All you need is knowledge of for example PHP programming language and our module's API.

• Navigate to the ~/langs/ directory located within the following yourWHMCS/modules/servers/moduleName/langs/ path.
• Within this directory, create a new file or duplicate the language file you intend to modify. For instance, if you wish to create an override for the English language, establish the following directory structure:

 ~/langs/overrides/english.php.

• Open the newly created override file to edit its contents.
• At the beginning of the file, indicate the used code, for instance, you can use: <?php for PHP code.
• Adapt the file content according to your requirements. You can either selectively modify specific variables or opt to revise the entire content of the language file.

For example:

Original yourWHMCS/modules/servers/moduleName/langs/english.php:

 $_LANG['Search'] = 'Search';

Override yourWHMCS/modules/servers/moduleName/langs/overrides/english.php:

 $_LANG['Search'] = 'Look for';

Remember that some of the modules have more than one language file, located under /addons and /servers paths. You may create the override files for both of them.
Note that you do not need to paste all the original content of the lang file into the override file. Enter there only the lines that you wish to change, every other line will be fetched from the original module lang file.
Consequently, the override lang file might include only one or just a few lines.

Ensure successful completion of the module update by carefully following each step, thereby preventing data loss or any unforeseen issues.
Additionally, you will find a current list of supplementary actions necessary for a smooth update process there.

Opt for the Open Source version of your Products Reseller For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

• the product that is offered to the reseller has the 'Recurring' pricing set properly.
• the reseller has enough credits on his account to pay for the product
• the 'Automatic Credit Use' option is enabled in WHMCS → General Settings → Credit.
  

This can be e.g.:

        location /client/modules/addons/ProductsReseller/api/ {
                try_files $uri $uri /client/modules/addons/ProductsReseller/api/index.php;
        }

but may differ depending on your configuration (e.g. the '/portal/' path may be used instead of the '/client/' one).