---
updatedAt: 2026-05-27T19:42:41.000Z
agentTools:
  projectIndex: https://developers.hivelocity.net/llms.txt
---

# Get cancel request by service

This method pulls the cancel request details for the service ID specified.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/cancellation/service/{serviceId}": {
      "get": {
        "operationId": "get_cancellation_service_resource",
        "parameters": [
          {
            "description": "An optional fields mask",
            "in": "header",
            "name": "X-Fields",
            "schema": {
              "type": "string",
              "format": "mask"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Cancellation"
                }
              }
            }
          },
          "403": {
            "description": "You have not been granted permission to complete this action. Please contact your account manager to grant the proper permission."
          },
          "404": {
            "description": "Service not found"
          }
        },
        "summary": "Get cancel request by service",
        "tags": [
          "Cancellations"
        ]
      },
      "parameters": [
        {
          "in": "path",
          "name": "serviceId",
          "required": true,
          "schema": {
            "type": "integer"
          }
        }
      ]
    }
  },
  "info": {
    "description": "Interact with Hivelocity",
    "title": "Hivelocity API",
    "version": "2.0"
  },
  "security": [
    {
      "apiKey": []
    }
  ],
  "tags": [
    {
      "description": "Cancellation information",
      "name": "Cancellations"
    }
  ],
  "servers": [
    {
      "url": "https://core.hivelocity.net/api/v2"
    }
  ],
  "components": {
    "securitySchemes": {
      "apiKey": {
        "in": "header",
        "name": "X-API-KEY",
        "type": "apiKey"
      }
    },
    "schemas": {
      "Cancellation": {
        "properties": {
          "activeMonths": {
            "description": "The number of months the target device has been active.",
            "type": "integer"
          },
          "cancelDate": {
            "description": "Date of cancellation.",
            "format": "date-time",
            "type": "string"
          },
          "cancelled": {
            "description": "True if cancel completed.",
            "type": "boolean"
          },
          "clientId": {
            "description": "Unique ID of a client.",
            "type": "integer"
          },
          "comments": {
            "description": "Details why the device is being cancelled",
            "type": "string"
          },
          "couponCode": {
            "description": "Code of the coupon.",
            "type": "string"
          },
          "couponName": {
            "description": "Name of the coupon used.",
            "type": "string"
          },
          "couponType": {
            "description": "Type of the coupon.",
            "type": "string"
          },
          "couponValue": {
            "description": "Value of the coupon.",
            "type": "integer"
          },
          "deletedAt": {
            "description": "Date of cancellation completion.",
            "format": "date-time",
            "type": "string"
          },
          "deviceId": {
            "description": "Unique ID of a device.",
            "type": "integer"
          },
          "id": {
            "description": "Unique ID of the cancellation request.",
            "type": "integer"
          },
          "ipAddress": {
            "description": "List of IP assignments related to the device.",
            "type": "string"
          },
          "monthlyPayment": {
            "description": "The monthly cost of the cancelled device.",
            "type": "integer"
          },
          "name": {
            "description": "Name of user who submitted the request",
            "type": "string"
          },
          "planId": {
            "description": "Deprecated.",
            "type": "integer"
          },
          "reason": {
            "description": "Reason",
            "type": "string"
          },
          "requestDate": {
            "description": "The requested cancellation date, if specified.",
            "format": "date-time",
            "type": "string"
          },
          "salesRepId": {
            "description": "Sales Rep ID.",
            "type": "integer"
          },
          "salesRepName": {
            "description": "Sales Rep Name.",
            "type": "string"
          },
          "service": {
            "allOf": [
              {
                "$ref": "#/components/schemas/FastService-load"
              }
            ],
            "description": "Service information"
          },
          "serviceId": {
            "description": "Unique ID of a service.",
            "type": "integer"
          },
          "startDate": {
            "description": "Date of cancel request submission.",
            "format": "date-time",
            "type": "string"
          }
        },
        "type": "object"
      },
      "FastService-load": {
        "properties": {
          "bandwidthBilling": {
            "$ref": "#/components/schemas/ServiceBandwidthBilling"
          },
          "billedPricePerPeriod": {
            "type": "number"
          },
          "billingInfoId": {
            "type": "integer"
          },
          "cancelAfter": {
            "type": "integer"
          },
          "contractTerm": {
            "type": "integer"
          },
          "created": {
            "type": "integer"
          },
          "discount": {
            "type": "number"
          },
          "discountType": {
            "type": "string"
          },
          "discountedCost": {
            "type": "number"
          },
          "endDate": {
            "type": "integer"
          },
          "expectedCancellationDate": {
            "type": "integer"
          },
          "facilityName": {
            "type": "string"
          },
          "ipAddress": {
            "type": "string"
          },
          "lastRenew": {
            "type": "integer"
          },
          "orderId": {
            "type": "integer"
          },
          "period": {
            "type": "string"
          },
          "productId": {
            "type": "integer"
          },
          "productName": {
            "type": "string"
          },
          "quantity": {
            "type": "number"
          },
          "renewDate": {
            "type": "integer"
          },
          "reseller": {
            "type": "string"
          },
          "resellerBmaasCharge": {
            "type": "number"
          },
          "serviceDiscount": {
            "type": "number"
          },
          "serviceDiscountPerPeriod": {
            "type": "number"
          },
          "serviceId": {
            "type": "integer"
          },
          "serviceOptions": {
            "items": {
              "$ref": "#/components/schemas/ServiceOptionData"
            },
            "type": "array"
          },
          "serviceType": {
            "type": "string"
          },
          "startDate": {
            "type": "integer"
          },
          "status": {
            "type": "string"
          },
          "typeCode": {
            "description": "The service type code. The list of service types can be accessed on https://core.hivelocity.net/api/v2/service/types .",
            "type": "string"
          }
        },
        "type": "object"
      },
      "ServiceBandwidthBilling": {
        "properties": {
          "billingMethod": {
            "type": "string"
          },
          "includedTransferUnit": {
            "type": "string"
          },
          "notification": {
            "type": "string"
          },
          "overageUnit": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ServiceOptionData": {
        "properties": {
          "groupName": {
            "type": "string"
          },
          "invoiceHide": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "optionId": {
            "type": "integer"
          },
          "serviceOptionId": {
            "type": "integer"
          },
          "upgradeId": {
            "type": "integer"
          },
          "upgradeName": {
            "type": "string"
          }
        },
        "type": "object"
      }
    }
  }
}
```