ghl_invoice_schedule_cancel
Cancel a scheduled or recurring invoice by schedule ID to stop all remaining unsent occurrences; already-sent invoices remain unaffected.
Instructions
Stops all remaining not-yet-sent occurrences of this recurring/scheduled invoice. Already-sent invoices are unaffected. Cancel an scheduled invoice API to cancel a scheduled invoice by schedule id Endpoint: POST /invoices/schedule/{scheduleId}/cancel (Version header: v3; source: v3/invoices-v3.json) Requires an Agency or Sub-Account token. OAuth scopes: invoices/schedule.write
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"scheduleId": "<scheduleId>",
"body": "<body>"
},
"name": "ghl_invoice_schedule_cancel"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Request body (schema carried verbatim from the official OpenAPI spec). | |
| scheduleId | Yes | Schedule Id |