Cancel-VPS.

To cancel a VPS product, provide either the KVM ID or service ID, along with the type of cancellation you wish to proceed with.

post/kvm/v2/cancel/product

Request

Request body application/x-www-form-urlencoded

emailstring

Your WHMCS email address.

pwstring

Your WHMCS password.

kvmidstring

The KVM ID to cancel if the service ID is unknown.

serviceidstring

The service ID to cancel if the KVM ID is unknown.

typestring

The type of cancellation. Either 'Immediate' or 'End of Billing Period'.

Example request

{
  "email": "yourwhmc_email",
  "pw": "yourwhmcs_password",
  "kvmid": "kvm_xxxxx_yyyyy",
  "serviceid": "1234",
  "type": "End of Billing Period"
}

Response

Successfully canceled the product.

statusstring
serviceidinteger
clientidinteger nullable

Example response

{
  "status": "success",
  "serviceid": 123456
}

Changes

No recorded changes to this operation across all 1 revision of this API.