License Termination Request

This request is used to terminate a license.

In this chapter:

Request

Response

Examples

 

Request

The HTTP POST is made for a specified endpoint with the following parameters:

Name Size (Characters) Descrition

APS_ACTION

up to 30

Always TERMINATE for terminate requests.

APS_TEST_MODE

1

See the description in License Creation/Renewal/Upgrade Request > Request

PURCHASE_ID

up to 10

See the description in License Creation/Renewal/Upgrade Request > Request

PRODUCT_ID

up to 30

See the description in License Creation/Renewal/Upgrade Request > Request

APS_TERMINATION_DATE

 

The date of termination in the format DD/MM/YYY, e.g., 18/09/2016.

This is the date when KA received a request to terminate the license.

PREVIOUS_LICENSE_BODY

unlimited

See the description in License Creation/Renewal/Upgrade Request > Request

Notes:

  • Ordering of the fields is not guaranteed.
  • Additional fields might be added in future. In case an unknown field is encountered while processing the request, the implementation should ignore it (i.e., process the request as if such field is absent).
 

Response

In case the request is successfully processed, the implementation should send a response with the status code 200 OK or 204 No content.

In case the request fails, the implementation should return an appropriate status code and a brief explanation on the reasons of the failure.

The recommended response codes are:

Status Code Possible Reasons KA Responsibility

200 OK

License termination is successful

 

Mark the license key as "terminated"

 

204 No content

4xx

See the description in License Creation/Renewal/Upgrade Request > Response

 

5xx

 

Examples

Correct request:

POST /handler.php HTTP/1.1
Accept: */*
Content-Type: application/x-www-form-urlencoded
Host: isv.endpoint.example.org
Authorization: Basic am9objpxd2UxMjM=

APS_ACTION=TERMINATE&APS_TEST_MODE=N&PURCHASE_ID=12345678&PRODUCT_ID=someproduct1&APS_TERMINATION_DATE=18%2f09%2f2016&PREVIOUS_LICENSE_BODY=NCA4IDE1IDE2IDIzIDQy

Successful response with a body:

HTTP/1.1 200 OK
Date: Sun, 18 Sep 2016 15:02:10 GMT
Server: Web Server
Content-Type: text/plain; charset=UTF-8

License 12345678 is terminated.

Successful response without a body:

HTTP/1.1 204 No content
Date: Sun, 18 Sep 2016 15:02:10 GMT
Server: Web Server
 

Leave your feedback on this topic here

If you have questions or need support, please visit the Plesk forum or contact your hosting provider.
The comments below are for feedback on the documentation only. No timely answers or help will be provided.