whmcs_cancel_order
Cancel WHMCS orders by order ID, optionally terminating subscriptions and suppressing email notifications.
Instructions
Cancel an order
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| orderid | Yes | Order ID | |
| cancelsub | No | Cancel subscription | |
| noemail | No | Do not send email |
Implementation Reference
- src/whmcs-client.ts:1007-1016 (handler)Core handler method in WhmcsApiClient that performs the WHMCS API call to CancelOrder action with provided parameters./** * Cancel an order */ async cancelOrder(params: { orderid: number; cancelsub?: boolean; noemail?: boolean; }) { return this.call<WhmcsApiResponse>('CancelOrder', params); }
- src/index.ts:797-813 (registration)Tool registration in MCP server, including schema definition and thin wrapper handler that delegates to WhmcsApiClient.cancelOrder'whmcs_cancel_order', { title: 'Cancel Order', description: 'Cancel an order', inputSchema: { orderid: z.number().describe('Order ID'), cancelsub: z.boolean().optional().describe('Cancel subscription'), noemail: z.boolean().optional().describe('Do not send email'), }, }, async (params) => { const result = await whmcsClient.cancelOrder(params); return { content: [{ type: 'text', text: JSON.stringify(result, null, 2) }], }; } );
- src/index.ts:801-805 (schema)Zod input schema validation for the whmcs_cancel_order tool parameters.inputSchema: { orderid: z.number().describe('Order ID'), cancelsub: z.boolean().optional().describe('Cancel subscription'), noemail: z.boolean().optional().describe('Do not send email'), },