whmcs_module_suspend
Suspend a WHMCS service account by specifying the service ID and optional suspension reason to temporarily disable access.
Instructions
Suspend a service account
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| accountid | Yes | Service ID | |
| suspendreason | No | Suspension reason |
Implementation Reference
- src/whmcs-client.ts:1105-1110 (handler)Core handler implementation: WhmcsApiClient.moduleSuspend method that calls the WHMCS ModuleSuspend API action to suspend the service.async moduleSuspend(params: { accountid: number; suspendreason?: string; }) { return this.call<WhmcsApiResponse>('ModuleSuspend', params); }
- src/index.ts:910-925 (registration)MCP tool registration including input schema (using Zod) and thin async handler that delegates to WhmcsApiClient.moduleSuspend'whmcs_module_suspend', { title: 'Module Suspend', description: 'Suspend a service account', inputSchema: { accountid: z.number().describe('Service ID'), suspendreason: z.string().optional().describe('Suspension reason'), }, }, async (params) => { const result = await whmcsClient.moduleSuspend(params); return { content: [{ type: 'text', text: JSON.stringify(result, null, 2) }], }; } );
- src/index.ts:914-917 (schema)Zod input schema definition for the tool parameters: required accountid (service ID) and optional suspendreason.inputSchema: { accountid: z.number().describe('Service ID'), suspendreason: z.string().optional().describe('Suspension reason'), },