Manage service contract renewal

Schedule a service contract renewal or remove a scheduled service contract renewal.

Schedule service contract renewal

Schedule a service contract renewal.

Request

Endpoint: /api/services/<service_id>/service/renew
Method: POST
Headers: Accept: application/vnd.cloudlx.v1+json
Authorization: Bearer <access_token>

Example Request:

                                
    {
        "renewal_date": "2024-05-16",
        "product_id": 11045
    }
                                
                            

Request Values

renewal_date Description The date on which you wish the contract to renew.
Type Date
Example 2024-05-16
product_id Description The product_id for the type of service being ordered which can be looked up from the service pricing endpoint
Type Integer
Example 11045

Response

Example:

                                
    {
        "success": true,
        "message": "Service updated successfully"
    }
                                
                            

Back to top

Remove scheduled service contract renewal

Remove a scheduled a service contract renewal.

Request

Endpoint: /api/services/<service_id>/renew
Method: POST
Headers: Accept: application/vnd.cloudlx.v1+json
Authorization: Bearer <access_token>

Example Request:

                                
    {
        "renewal_date": null,
        "product_id": null
    }
                                
                            

Request Values

renewal_date Description The date on which you wish the contract to renew.
Type Null
Example null
product_id Description A null value
Type Null
Example null

Response

Example:

                                
    {
        "success": true,
        "message": "Service updated successfully"
    }
                                
                            

Back to top