Cancel Managed Service

Cancel a managed service for an account:
POST /managedaccount/actions/cancel

Deactivates a managed billing service relationship between a managed account and the primary account.

NOTE: The accounts must be enabled for Aggregated Billing Services before you can use this request. See About Aggregated Billing Services for more information.

Contents

See also:
About Aggregated Billing Services
Add accounts for managed billing
Activate a managed service for an account
Get a list of managed accounts

Uses and Requirements

This request must be sent with a VZ-M2M-Token created with the managed account’s UWS credentials.

NOTE: This method uses the /subsc/v1 basepath, not /loc/v1 used by other Device Location API requests.

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/subsc/v1/managedaccounts/actions/cancel

Resource Path and Query Parameters

None.

Header Parameters

The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.

Parameter Name Data Type Description
Authorization
required
string HTTP Authorization bearer token.
VZ-M2M-Token
required
string A valid session token returned by POST /api/m2m/v1/session/login using the managed account’s UWS credentials.
Content-Type
required
string Must be application/json.

Request Body

Parameter Name Data Type Description
accountName
required
string The name of the managed account, which is usually in the format of 10 digits, a hyphen, and then five more digits. Must include any leading zeros.
paccountName
required
string The name of the primary billing account. Must include any leading zeros.
serviceName
required
string The name of the managed service to cancel. Must be “Location” for the Device Location Service.
type
required
string The SKU of the service that you want to cancel.
TxId
required
string The transaction ID that was returned when the managed service was added/provisioned. You can also obtain the transaction ID with the GET /managedaccounts request.

Example Request Body

{
  "accountName": "1223334444-00001",
  "paccountName": "1234567890-00001",
  "serviceName": "Location",
  "type": "TS-LOC-COARSE-CellID-5K",
  "TxId": "d4fbff33-ece4-9f02-42ef-2c90bd287e3b"
}

Success Responses

Status 200

A success response is a confirmation of the cancellation, or a reason why the service could not be canceled.

Parameter Name Data Type Description
txid string A unique transaction ID for the cancellation request.
accountName string The name of the account for which the service was canceled.
paccountName string The name of the primary billing account.
serviceName string The name of the managed service.
status string The status of the cancellation request, either “Success” or “Fail”.
reason string Either “success” or additional information about a failure.

Example Success Response

{
  "TxId": "4fbff332-ece4-42ef-9f02-7e3bdc90bd28",
  "accountName": "1223334444-00001",
  "paccountName": "1234567890-00001",
  "serviceName": "Location",
  "status": "Success",
  "reason": "Success"
}

Failure Responses

Status 400

All error messages are returned in this format:

{
  "errorCode": "The type of error, such as INVALID_REQUEST.",
  "errorMessage": "Additional error information."
}

Error codes and messages are listed on the Error Codes page, along with explanations and suggestions for corrective actions.

Try It Out!