WHMCS icon

WHMCS

Interact with the WHMCS billing & automation API

Product / Service → Upgrade

AI-generated

Summary

Upgrades a WHMCS client service by calling the UpgradeProduct API action. Provide the service ID and any upgrade details; the node returns WHMCS's JSON response for each input item.

Inputs

  • Service ID (required) — ID of the client service (tblhosting.ID).
  • Upgrade Fields — Optional upgrade parameters: new billing cycle, new product ID, payment method, promo code, and type (product or configoptions).
  • Custom Parameters — Optional additional WHMCS API parameters. Names must match the WHMCS API reference exactly and are case-sensitive.

Output shape

One item per input item, containing the WHMCS API response as JSON.

Empty string values and a service ID of 0 are omitted from the request. Errors stop execution unless Continue On Fail is enabled; then an item with an error field is returned.

Examples

Example 1: Upgrade a service to a different product and billing cycle

Set Service ID to the client's service record ID. In Upgrade Fields, enter New Product ID and New Billing Cycle; optionally provide Payment Method, Promo Code, and Type.

Example 2: Change configurable options

Set Service ID and choose Configurable Options for Type. Supply any additional WHMCS-required values through Custom Parameters, since no configurable-option fields are provided in Upgrade Fields.

Links

Discussion