Stop a QoS Subscription
# Stop the ThingSpace Quality of Service API Subscription ### `DELETE /api/m2m/v1/device/actions/enhanceQoS` Use this endpoint to stop the ThingSpace Quality of Service API subscription. ## Header Parameters The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit [Getting Started](https://thingspace.verizon.com/documentation/api-documentation.html#/http/connectivity-management/guides/getting-started/introduction-to-the-connectivity-management-api). |Parameter Name|Data Type|Description| |-----|-----|-----| | **Authorization** *(required)* | string | HTTP Authorization request header containing a valid Bearer token: `Authorization: Bearer {token}` | | **VZ-M2M-Token** *(required)* | string | A valid session token returned by a Connectivity Management `POST /session/login` request. | | **Content-Type** *(required)* | string | Must be `application/json`. | ## HTTP Request [DELETE https://thingspace.verizon.com/api/m2m/v1/device/actions/enhanceQoS](/docs/specialized-apis/automotive-oem/thingspace-quality-of-service/api-endpoints/thingspace-quality-of-service-api-actions/stopathingspacequalityofserviceapisubscription) ## Request Parameters |Parameter Name|Data Type|Description| |-----|-----|-----| | **accountName** *(required)* | string | The name of a billing account. This value is numeric and must include any leading zeroes. | | **qosSubscriptionId** *(required)* | string | The id of the QoS subscription that should be stopped. | ## Request Body Example Request ```json { "accountName":"0000123456-00001", "qosSubscriptionId":"QoS subscription ID value" } ``` ## Success Responses **Status 201** ```json { "requestId": "be36accb-eeee-ffff-gggg-0af6c4ed256a" } ``` ## Callback example ```json { "requestId": "be36accb-eeee-ffff-gggg-0af6c4ed256a", "deviceResponse": { "qoS": [ { "accountName": "0000123456-00001", "qosSubscriptionId": "QoS subscription ID value", "reportedTime": "2023-02-17T19:02:54.127Z", "qosEvent": "QoSChangeTerminated", "status": "SUCCESS" } ] }, "callbackCount": 1, "maxCallbackThreshold": 4 } ``` Or, if the request fails: ```json { "requestId": "be36accb-eeee-ffff-gggg-0af6c4ed256a", "deviceResponse": { "qoS": [ { "accountName": "0000123456-00001", "reportedTime": "2023-02-17T19:02:54.127Z", "qosEvent": "QoSChangeFailed", "status": "FAILED", "reason": "device not found" } ] }, "callbackCount": 1, "maxCallbackThreshold": 4 } ``` ## Callback Parameters |Parameter Name|Data Type|Description| |-----|-----|-----| | **requestId** | string | This is the same `requestId` in the response to the original request. | | **deviceResponse** | object | The device response object. | | **qoS** | array | The array containing the QoS status for this subscription and account. | | **accountName** | string | The name of a billing account. This value is numeric and must include any leading zeroes. | | **qosSubscriptionId** | string | The subscription id of the QoS request. | | **reportedTime** | string ($datetime) | Identifies the absolute time at which the reachability report is received from the Service Capability Exposure Function (SCEF). The format is aligned with RFC3339. | | **qosEvent** | string | This will show either: **QoSChangeTerminated** (QoS elevation has been stopped) or **QoSChangeFailed**. | | **status** | string | This will show either: **SUCCESS** or **FAILED**. | | **reason** | string | This line will have a reason or description of why the request failed. If the status is "**SUCCESS**", this line will not be output. | | **callbackCount** | integer | The number of responses in the callback request. | | **maxCallbackThreshold** | integer | The maximum number of callback responses allowed for this request. | ## Failure Responses All error messages are returned in this format: ```json { "errorCode": "error code string", "errorMessage": "error message string" } ```