v1

latestOpenAPI 3.0.02026-07-26258182277.4 KB
Cancellations

Create cancel request

post/cancellation/cancellation

Headers

X-Fieldsstring mask

An optional fields mask

Request body

commentsstring

Details why the device is being cancelled

deviceIdinteger required

Unique ID of a device. Must be related to service_id.

reasonstring required

My current service is being upgraded|Hardware/software/network or power issues|I think I have found a better deal|I have experienced tech support problems|I am consolidating my Hivelocity accounts|I am a reseller and my customer cancelled|I am moving to a different technology solution: Public Cloud|I am moving to a different technology solution: Managed Hosting Company|A product difference (Example: AWS)

serviceIdinteger required

Unique ID of a service. Must be related to device_id.

Response

Success

activeMonthsinteger

The number of months the target device has been active.

cancelDatestring date-time

Date of cancellation.

cancelledboolean

True if cancel completed.

clientIdinteger

Unique ID of a client.

commentsstring

Details why the device is being cancelled

couponCodestring

Code of the coupon.

couponNamestring

Name of the coupon used.

couponTypestring

Type of the coupon.

couponValueinteger

Value of the coupon.

deletedAtstring date-time

Date of cancellation completion.

deviceIdinteger

Unique ID of a device.

idinteger

Unique ID of the cancellation request.

ipAddressstring

List of IP assignments related to the device.

monthlyPaymentinteger

The monthly cost of the cancelled device.

namestring

Name of user who submitted the request

planIdinteger

Deprecated.

reasonstring

Reason

requestDatestring date-time

The requested cancellation date, if specified.

salesRepIdinteger

Sales Rep ID.

salesRepNamestring

Sales Rep Name.

serviceIdinteger

Unique ID of a service.

startDatestring date-time

Date of cancel request submission.