# API: Add account cancellation
# addAccountCancellation
Create new cancellation request
# Required parameters
| Parameter | Description |
|---|---|
id | Account ID |
type | Cancellation type, one of: Admin submitted, Immediate or End of billing period |
reason | Either id of cancellation reason or other to post reason in other_reason field |
submission_date | Submission date |
submission_time | Submission time |
# Optional parameters
| Parameter | Description |
|---|---|
other_reason |
# Request
GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=addAccountCancellation&id=ID&type=TYPE&reason=REASON&submission_date=SUBMISSION_DATE&submission_time=SUBMISSION_TIME
# PHP Samples
$url = 'http://url_to_hb.com/admin/api.php';
$post = [
'call' => 'addAccountCancellation',
'api_id' => $API_ID,
'api_key' => $API_KEY,
'id' => $ID,
'type' => $TYPE,
'reason' => $REASON,
'submission_date' => $SUBMISSION_DATE,
'submission_time' => $SUBMISSION_TIME,
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
$data = curl_exec($ch);
curl_close($ch);
$return = json_decode($data, true);
print_r($return);
include 'class.hbwrapper.php';
HBWrapper::setAPI('http://url_to_hb.com/admin/api.php','API ID','API Key');
$params = [
'id' => $ID,
'type' => $TYPE,
'reason' => $REASON,
'submission_date' => $SUBMISSION_DATE,
'submission_time' => $SUBMISSION_TIME,
];
$return = HBWrapper::singleton()->addAccountCancellation($params);
print_r($return);
/* Use this method to access HostBill api from HostBill modules */
$api = new ApiWrapper();
$params = [
'id' => $ID,
'type' => $TYPE,
'reason' => $REASON,
'submission_date' => $SUBMISSION_DATE,
'submission_time' => $SUBMISSION_TIME,
];
$return = $api->addAccountCancellation($params);
print_r($return);
# Response
{
"success": true,
"call": "addAccountCancellation",
"server_time": 1684237266,
"info": [
"Cancelation request submitted"
]
}