Cancellations

Get cancel request by device

get/cancellation/device/{deviceId}

Request

  • Base URL
    https://core.hivelocity.net/api/v2
  • URL
    https://core.hivelocity.net/api/v2/cancellation/device/{deviceId}
  • Auth
    API key in header X-API-KEY

Headers

X-Fieldsstring mask

An optional fields mask

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.

Changes

No recorded changes to this operation across all 1 revision of this API.