---
title: "Get cancel request by device"
method: GET
path: "/cancellation/device/{deviceId}"
tags: ["Cancellations"]
---

# Get cancel request by device

`GET /cancellation/device/{deviceId}`

## Headers

- `X-Fields` string, mask

## Response `200`

Success

- Cancellation
  - `activeMonths` integer — The number of months the target device has been active.
  - `cancelDate` string, date-time — Date of cancellation.
  - `cancelled` boolean — True if cancel completed.
  - `clientId` integer — Unique ID of a client.
  - `comments` string — Details why the device is being cancelled
  - `couponCode` string — Code of the coupon.
  - `couponName` string — Name of the coupon used.
  - `couponType` string — Type of the coupon.
  - `couponValue` integer — Value of the coupon.
  - `deletedAt` string, date-time — Date of cancellation completion.
  - `deviceId` integer — Unique ID of a device.
  - `id` integer — Unique ID of the cancellation request.
  - `ipAddress` string — List of IP assignments related to the device.
  - `monthlyPayment` integer — The monthly cost of the cancelled device.
  - `name` string — Name of user who submitted the request
  - `planId` integer — Deprecated.
  - `reason` string — Reason
  - `requestDate` string, date-time — The requested cancellation date, if specified.
  - `salesRepId` integer — Sales Rep ID.
  - `salesRepName` string — Sales Rep Name.
  - `service` FastServiceLoad
    - `bandwidthBilling` ServiceBandwidthBilling
      - `billingMethod` string
      - `includedTransferUnit` string
      - `notification` string
      - `overageUnit` string
    - `billedPricePerPeriod` number
    - `billingInfoId` integer
    - `cancelAfter` integer
    - `contractTerm` integer
    - `created` integer
    - `discount` number
    - `discountType` string
    - `discountedCost` number
    - `endDate` integer
    - `expectedCancellationDate` integer
    - `facilityName` string
    - `ipAddress` string
    - `lastRenew` integer
    - `orderId` integer
    - `period` string
    - `productId` integer
    - `productName` string
    - `quantity` number
    - `renewDate` integer
    - `reseller` string
    - `resellerBmaasCharge` number
    - `serviceDiscount` number
    - `serviceDiscountPerPeriod` number
    - `serviceId` integer
    - `serviceOptions` ServiceOptionData[]
      - `groupName` string
      - `invoiceHide` string
      - `name` string
      - `optionId` integer
      - `serviceOptionId` integer
      - `upgradeId` integer
      - `upgradeName` string
    - `serviceType` string
    - `startDate` integer
    - `status` string
    - `typeCode` string — The service type code. The list of service types can be accessed on https://core.hivelocity.net/api/v2/service/types .
  - `serviceId` integer — Unique ID of a service.
  - `startDate` string, date-time — Date of cancel request submission.

## Other responses

- `403` — You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission.
- `404` — Device not found

---

[API](https://skmtc.net/hivelocity/apis/hivelocity-api.md) · [All operations](https://skmtc.net/hivelocity/apis/hivelocity-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hivelocity/hivelocity-api/revisions/ee6b717b5015/schema)