Delete subscription
The Delete subscription method is used to initiate the process of deleting a subscription for the current reseller or any of its downstream resellers.
The period when deleting a subscription can be available is defined by the Deletion period of subscription by manager (days) setting in the linked service term (see Creating a service term).
An API token of a manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating manager's information.
The manager's API token specified in an API request determines:
- The role and access level of the manager, which determine the availability of a method.
- The current reseller and downstream resellers accessible within a method.
POST {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}/delete_operationArguments
Name | Parameter Type | Data type | Required/Optional | Description | ||
|---|---|---|---|---|---|---|
| X-Api-Token | header | string | Required | API token of a manager that performs the operation (see Viewing and updating manager's information) | ||
| Content-Type | header | string | Required | Media type of the request. Specify the following: application/vnd.api+json | ||
| Accept | header | string | Required | Supported media types of the answer. Specify the following: application/vnd.api+json | ||
| base_url | path | string | Required | ActivePlatform URL | ||
| reseller_id | path | integer | Required | ID of the current reseller or any of its downstream resellers (see Viewing and updating reseller general information) | ||
| subscription_id | path | integer | Required | ID of the subscription | ||
Response model
If no errors are encountered, the method returns the empty response with the 200 OK status.
Errors
| Status | Error text | Comment |
|---|---|---|
| 403 | This action is forbidden | Check the list of available operations for the subscription (see Get subscription) |
Request example
POST /api/v3/resellers/1/subscriptions/3007255/delete_operation
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+jsonResponse example