PHP WHMCS CancelOrder用法及代碼示例

取消掛單

請求參數

參數	類型	說明	必需的
action	string	“CancelOrder”	Required
orderid	int	掛單ID	Required
cancelsub	bool	嘗試取消與產品關聯的訂閱	Optional
noemail	bool	設置為 true 以在發票已付款時停止發送發票付款電子郵件	Optional

響應參數

參數	類型	說明
result	string	操作結果：成功或錯誤

示例請求 (CURL)

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/includes/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
    http_build_query(
        array(
            'action' => 'CancelOrder',
            // See https://developers.whmcs.com/api/authentication
            'username' => 'IDENTIFIER_OR_ADMIN_USERNAME',
            'password' => 'SECRET_OR_HASHED_PASSWORD',
            'orderid' => '1',
            'responsetype' => 'json',
        )
    )
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close($ch);

示例請求(本地 API)

$command = 'CancelOrder';
$postData = array(
    'orderid' => '1',
);
$adminUsername = 'ADMIN_USERNAME'; // Optional for WHMCS 7.2 and later

$results = localAPI($command, $postData, $adminUsername);
print_r($results);

示例響應 JSON

{
    "result": "success"
}

錯誤響應

可能的錯誤條件響應包括：

• 未找到訂單 ID 或狀態未待處理
• 訂閱取消失敗 - 請查看網關日誌以獲取更多信息