Cancel an Order
The Cancel an Order method is used to start the process of cancelling an Order for a Subscription for the current Reseller or any of its downstream Resellers. The standard logic of the platform is used (see Cancelling an order).
Access to the current Reseller and downstream Resellers is determined by the Manager's token in the API request.
POST {base_url}/api/v3/resellers/{reseller_id}/orders/{order_id}/cancel_operationArguments
Name | Parameter Type | Data type | Required/Optional | Description | ||||
|---|---|---|---|---|---|---|---|---|
| X-Api-Token | header | string | Required | API token of the Manager that performs the operation (see Viewing and updating manager's information) | ||||
| Content-Type | header | string | Required | Indicates the media type (text/html or text/JSON) of the request that is sent to the server by the client (browser) | ||||
| Accept | header | string | Required | Information about data types that the client (browser) supports | ||||
| reseller_id | path | integer | Required | ID of the current Reseller or any of its downstream Resellers (see Viewing and updating reseller general information) | ||||
| order_id | path | integer | Required | Information about the attributes of the operation | ||||
Response model
If no errors are encountered, the method returns the empty response with the 200 OK status.
Request example
POST /api/v3/resellers/1/orders/10914/cancel_operation
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+jsonResponse example