Class: Addons

Addons(config)

Allows you to manage your Addons module in WHMCS.

Constructor

new Addons(config)

Parameters:
Name Type Description
config Object Object containing your API credentials.
Properties
Name Type Attributes Description
serverUrl string URL to your installation. Remember to point to /includes/api.php
username string <optional>
password string <optional>
identifier string <optional>
secret string <optional>
Source:

Extends

  • WHMCS

Methods

updateClientAddon(opts)

Updates a Client Addon - https://developers.whmcs.com/api-reference/updateclientaddon/
Parameters:
Name Type Description
opts Object
Properties
Name Type Attributes Description
id Number The id of the client addon to update
status String <optional>
 The status to change the addon to
terminationDate String <optional>
 The termination date of the addon Y-m-d
addonid Number <optional>
 The configured addon id to update the client addon to
name String <optional>
 The custom name to apply to the addon
setupfee Number <optional>
 The setup fee for the client addon
recurring Number <optional>
 The recurring amount for the client addon
billingcycle String <optional>
 The billing cycle for the addon
nextduedate String <optional>
 The next due date for the addon Y-m-d
nextinvoicedate String <optional>
 The next invoice date for the addon Y-m-d
terminationDate String <optional>
 The termination date of the addon Y-m-d
notes String <optional>
 The admin notes to associate with the addon
Source: