Cancel service
cancel_serviceCancel a Blesta service immediately, at end of the current term, or on a specified date, with optional module deprovisioning and client notification.
Instructions
Cancel a service now, at end of the current term, or on a given date. Wraps Services.cancel. when: 'end_of_term' (default, safest), 'now' (immediate, module deprovisions if use_module), or an ISO 8601 date with timezone. Scheduled cancellations are executed by Blesta's cron and can be undone before then with blesta_call services/unCancel.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| when | No | 'end_of_term', 'now', or ISO 8601 date with timezone | end_of_term |
| reason | No | Cancellation reason | |
| service_id | Yes | ||
| use_module | No | Deprovision on the module when cancelling immediately | |
| notify_client | No | Email the client about the cancellation |