Cpanel Api Code Syntax And
CPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output.The cPanel Licensing addon offers further configuration settings concerning Data and API Permissions, as well as Invoice and Cart Display Options.The easiest way to get familiar with the cPanel API is to call a function using your browser. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. So the function sets aren’t compartmentalized into modules.cPanel Tag System (deprecated) Warning: In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. While the XML-API covers a lot of functionality, the breadth of utility does not cover as much ground as API1 and API2. That means that a developer must make an HTTP query to invoke the desired function. The XML-API was written specifically for remote interactions with cPanel & WHM.
Here you will see the logged in user, as well as a Logout button. Manage2 Account - Your Manage2 Registered Email. Its not their official API but its well documented, From what I understood is you want to make a discord. The settings seen on this page are detailed below.Hi Everyone I just moved to Plesk from CPanel. These can be accessed by navigating to Addons > cPanel Licensing, and then clicking on the Settings tab. During your use of the WHM interface you’ve likely noticed additional data after the typical URL of and we can manipulate that data.
Cpanel Api License Configurable Options
Option Info Tooltip - Optional tooltip text to display near license configurable options during checkout. Only used by Packages that offer bulk cPanel Accounts. Invoicing Line Item Format - The line item description used for invoicing. Permissions - Access controls for functionality within this addon.
Autoscale Notification Email - The email template to be sent upon an Autoscale Change. Autoscale Label - The label to be displayed on the order form. Only used by Packages that offer bulk cPanel Accounts.
isUsageUpgrade - A boolean indicating whether or not the upgrade is due to usage activity.Once the custom email template has been created, it can be set as the Autoscale Notification Email template. oldOption - The display name of the configurable option being upgrade from. newOption - The display name of the configurable option being upgraded to. More information about templates can be found via the Email Templates documentation page.The custom template to be used will have access to the following merge fields: This custom email template must be either the Product or Notification Email Type. This can be done via the Setup > Email Templates section of the WHMCS Admin Area.
This should be used when you want WHMCS to automatically upgrade a license to the next tier based on usage. It is within this modal that you can modify options within the group, as well as modify the cPanel related options themselves.This modal is made up of three elements: the Configurable Option Settings section in the top-left, the Selectable Options section in the bottom-left, and the Selectable Option Content panel on the right.The Configurable Option Settings section provides the ability to alter the Configurable Option Type, and toggle both the Visibility and Autoscale Option.The Autoscale Option toggle allows the cPanel Licensing addon module to dynamically adjust a service's configurable option based on the number of licenses associated with its cPanel account. This is the Manage button, and clicking on this button will bring up the Option & Price Management modal. Default Visibility - Toggles whether or not the option is visible from the Order Form.Once the settings have been completed, clicking on the Create button will generate the Configurable Option Group, create Configurable Options if the Auto-Populate option was selected, and display the option group in the Pricing tab of the module.Within the Manage column for each associated option a button with a wrench icon exists. Hardware Type - Offers a selection between the Dedicated/Metal and VPS/Cloud options. Auto-Populate - Automatically populate the new option with the default cPanel license package offerings and recommended retail pricing.
Additionally, the Configurable Option ID is displayed in the top-left corner.The Pricing section is offers the ability to configure pricing for the option. The Name, Visibility, and Package details are immediately displayed at the top, and can all be altered as desired. All changes made in this section are automatically saved.The Selectable Option Content section provides both an overview of that option, as well as the ability to configure it further. Clicking on an option from this list will display that option's content within the Selectable Option Content panel.Additionally, in Version 7.7 and later, dragging the options allow you to rearrange their order as desired.
This is done to ensure that changes can be made to a package's metric pricing without affecting existing customer orders.If you need to ensure that the pricing snapshot is updated to the current metric pricing, then this can be achieved by selecting the Auto Recalculate on Save checkbox and saving the service. This snapshot is then stored, and used when generating renewal invoices for the customer's service in the future. This setting provides the ability to set a per-account value that the customer will be billed for, as well as a threshold to define the number of accounts a customer must have before they are billed on a per-account basis.When a customer orders a package, with the Metric: cPanel Accounts offering, a snapshot of the current price is taken. Inversely, clicking on the Delete button will delete the configurable option.The Metric: cPanel Accounts setting is displayed when configuring pricing for packages that offer an unlimited number of cPanel accounts. The Metric: cPanel Accounts and Threshold values can also be modified for packages that support them.The Auto populate other billing cycles based on monthly pricing toggle will render the Billing Cycle tabs un-clickable and will automatically populate their pricing based on the pricing present in the Monthly pricing tab.Changes to this section are not automatically saved, and clicking on the Save button will commit the changes.
Navigate to ' Setup > Products/Services > Products/Services When used a service's Recurring Amount will be populated with current pricing based on the service and configurable options selected.To present a standalone product which can be ordered to provision a cPanel license, the cPanel Licensing Module can be used in conjunction with the Auto Release provisioning module: At this time, the cPanel Licensing Addon doesn't have historical snapshot capabilities that can augment this canonical data source.The Auto Recalculate on Save option will continue to function as normal. Manage2 doesn't provide the historical data necessary to calculate any prior month's usage. This is to ensure use of the most accurate value relative to Manage2, to which the license reseller is accountable.
Finally, configure any other options are desiredWhen this product is ordered, clients will be presented with the cPanel License Tier configurable option at the product configuration stage of the shopping cart and a license provisioned upon payment. Click the Configurable Option Group for the cPanel license types (created by the cPanel Licensing Addon as described above) Choose the Automatically setup the product as soon as the first payment is received option
Sync IP - Change the license's IP Address to the value displayed in the Dedicated IP field or IP Address custom field. This allows you to quickly review and action your Manage2 data without leaving WHMCS.Services associated with a cPanel Licensing related Option Group will see a panel labeled cPanel Licensing when viewing that service via the Admin Area.When a service is associated with a cPanel license, an overview if the license details is displayed along with the following buttons: This information is located within the Licenses, Groups, and Packages tabs.