license.cancel

Examples

Cancel a cPanel License

Try it Out
{
    "cuid": "L1",
    "reason": "Customer requested cancelation",
    "when": "endofcycle"
}
{
    "code": 5000,
    "message": "License \"L1\" was not found."
}

Parameters

Name Type Default
cuid cuid[License,Addon] Required

License ID retrieved from licenses.list

reason string Required

Reason for cancelation.
Example: "No longer needed", "Non payment from customer"

when enum "now"

Specify now to cancel license immediately.
Specify endofcycle to terminate at the end of the current billing cycle for the license

Values: now, endofcycle

Errors

Code Name
5000 LicenseNotFound
0 LicenceCancelFailed