Stop subscription | en.docs.activeplatform

The Stop subscription method is used to initiate the process of stopping a subscription for the current reseller or any of its downstream resellers according to the standard logic of the platform (see ).

POST {base_url}/api/v3/resellers/{reseller_id}/subscriptions/{subscription_id}/stop_operation

Arguments

Name			Parameter Type	Data type	Required/Optional	Description
X-Api-Token			header	string	Required	API token of a manager that performs the operation (see )
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 )
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 )

Status

Error text

Comment

403

This action is forbidden

Check the list of available operations for the subscription (see

Get subscription

)

Request example

XML

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

JSON

{
    "data":
    {
        "attributes":
        {
            "reason" : "reason",
            "comment" : "comment"
        }
    }
}