CancellationRequest
A service cancellation request
Should a Client decide to cancel a Service, they create a CancellationRequest.
CancellationRequests can either be handled immediately, or at the end of a billing cycle, per the client's request.
The CancellationRequest exists as a record for the WHMCS site operator for why the client requested the billing system to cancel their product.
class
CancellationRequest extends AbstractModel
Properties summary
| Type | Property | Description | |
|---|---|---|---|
| protected | $table | ||
| protected | $columnMap | ||
| protected | $dates | ||
| int | $id | Unique ID Number for this cancellation request. | |
| Carbon | $date | The date this cancellation was originally created. | |
| int | $serviceId | Unique ID number of the service the client is requesting cancelled. | |
| string | $reason | A customer provided reason for the cancellation. | |
| string | $whenToCancel | English language internal name specifying when the cancellation should take place from this set: 'Immediately', 'End of Billing Cycle' | |
| Carbon | $createdAt | Timestamp of when this cancellation request was created. | |
| Carbon | $updatedAt | Timestamp of when this cancellation request was last modified. | |
| Service | $service |
Methods summary
| Return Type | Method Name | Description | |
|---|---|---|---|
| BelongsTo | service() | Each cancellation request belongs to one service. |
Details
BelongsTo
service ()
Each cancellation request belongs to one service.