Stop subscription
The Stop subscription method is used to initiate the process of stopping a subscription for the current reseller or any of its downstream resellers.
Since the standard logic of the platform is used, if a subscription is linked to a prolong order or renewal order in the Waiting for payment or Waiting for provisioning status, this order and a linked payment that was paid from the account balance or is not completed (if it exists) are automatically cancelled with stopping the subscription (see Stopping a Subscription).
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}/stop_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 | ||
| data | form | object | Required | Information about the attributes of the operation | ||
| attributes | form | object | Required | Attributes of the operation | ||
| reason | form | string | Required | Reason for stopping the subscription | ||
| comment | form | string | Required | Comment | ||
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/stop_operation
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json{
"data":
{
"attributes":
{
"reason" : "reason",
"comment" : "comment"
}
}
}Response example