Views:
Last updated: 12/3/2024 3:36:32 PM
Note
Note
Business role: Distributor (T1), ISP (T1), MSP (T2), and Reseller (T2)
This API enables partner to suspend an enabled customer subscription.
After you suspend the subscription:
  • Auto-renewal is automatically disabled.
  • Licenses expire immediately or on the specified expiration date.
  • The subscription cannot be updated.
You can use the Customers :: Subscription :: Unsuspend API to resume a suspended subscription.
Note
Note
Subscriptions with auto-renewal disabled do not support subscription suspension and resumption functions.
You can access auto-renewal information using the Customers :: Subscription :: Get API.

Request

HTTP Request

[PUT] /LMPI/v3/customers/{customer_id}/subscriptions/{subscription_id}/suspend

Parameters

Name
Type
Description
Validation
Required Parameters
customer_id
string
The unique identifier of the customer company that owns the subscription.
GUID format
subscription_id
string
The unique identifier of the subscription.
GUID format

Request Body

{
"license_expiration_date":"2022-05-10T18:18:38Z"
}
Name
Type
Description
Validation
Optional Parameters
license_expiration_date
date
The updated expiration date of the license, between license start date and the original expiration date.
ISO 8601 standard with format "yyyy-MM-ddTHH:mm:ssZ"

Response

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
N/A