Last updated: 12/3/2024 3:05:06 PM
Note
Note
Business role: Distributor (T1), ISP (T1), MSP (T2), and Reseller (T2)
This API is used to retrieve details of a specified subscription, including subscribed service plan, number of licenses provisioned, status of automatic renewal, expiration date of license, and more.
If you cannot locate the subscription ID, the Customers :: Subscription :: GetID API allows you to retrieve any subscription ID under the specified customer company.

Request

HTTP Request

GET /LMPI/v3/customers/{customer_id}/subscriptions/{subscription_id}

Parameters

Name
Type
Description
Validation
Required Parameters
customer_id
string
The unique identifier of the customer company that the subscription belongs to.
GUID format
subscription_id
string
The unique identifier of the subscription you want to query.
GUID format

HTTP Request Example

[GET] https://{lmpi-fqdn}/LMPI/v3/customers/bd369fc5-61ad-4d40-8d68-11a757369a8f/subscriptions/f81d2435-ec82-4a69-8d47-357bb0bd52c1
Do not supply a request body with this method.

Response

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{
  "subscription_id" : "050c20ca-033d-412e-94f3-cfcfc3d61cb7",
  "name" : "Worry Free Business full version (yearly)",
  "enabled" : true,
  "is_auto_renewal":true,
  "auto_renewal_month":1,
  "service_url":"https://clp.trendmicro.com/Dashboard?T=xxxxx",
  "expiration_notification" : 30,
  "licenses" : [{
      "ac_code" : "WF-YEZ5-N2A97-CF68K-NE9QT-28NQ3-UEU5M",
      "product_id" : "WFSBWXE3X",
      "license_start_date" : "2013-03-05T01:23:34Z",
      "license_expiration_date" : "2014-03-05T01:23:34Z",
      "start_charge_date": "2013-03-05T01:23:34Z",
      "grace_period" : 1,
      "units" : 50,
      "enabled" : true
    }]
}
Name
Type
Description
Length
subscription_id
string
The unique identifier of the subscription.
GUID format
name
string
The display name of the service plan associated with the current subscription.
1-150 characters
enabled
boolean
The status of the current subscription.
Possible values include:
  • true: Subscription is enabled
  • false: Subscription is disabled
true/false
is_auto_renewal
boolean
The status of automatic renewal.
Possible values include:
  • true: Automatic renewal is enabled
  • false: Automatic renewal is disabled
true/false
auto_renewal_month
integer
The number of months that automatic renewal is enabled for.
Positive integer (0-36)
expiration_notification
integer
The number of days until the approaching expiration reminder notification in Licensing Management Platform.
Note
Note
You can modify this setting when configuring the service plan.
Positive integer (1-30)
service_url
string
The URL of Customer Licensing Portal, where the customer can sign in for profile management and single sign-on to product websites.
0-300 characters
licenses[].ac_code
string
The license activation code.
Note
Note
For SaaS products and services, the license is activated through specific conditions, not via an activation code.
38 characters
licenses[].product_id
string
The code representing the specific product or service.
9 characters
licenses[].license_start_date
date
The start date and time of license activation.
ISO 8601 standard with format "YYYY-MM-DDThh:mm:ssZ"
licenses[].license_expiration_date
date
The date and time of license expiration.
After the license expiration date, the license grace period begins.
ISO 8601 standard with format "YYYY-MM-DDThh:mm:ssZ"
licenses[].start_charge_date
date
The date and time when the customer company begins to be charged for the license.
ISO 8601 standard with format "YYYY-MM-DDThh:mm:ssZ"
licenses[].grace_period
integer
The grace period of the license.
The grace periods represented by different values are as follows:
  • 1: 30 days
  • 2: 60 days
  • 3: 90 days
When a license expires, the license enters the grace period. During the grace period, customer still can renew license and preserve all preferred product settings. After the grace period ends, customer cannot continue to use service or directly renew license.
The grace periods of different products are as follows:
  • Cloud App Security: 30 days
  • Worry Free Business Security Service: 30 days
  • Hosted Email Service 2.0: N/A
Positive integer (1-3)
licenses[].units
integer
The number of license units that the current subscription provisions for.
Positive integer (1-999,999)
licenses[].enabled
boolean
The status of the activation code.
Possible values include:
  • true: License is activated
  • false: License is not activated
true/false