Last updated: 3/12/2025 8:36:29 AM
Note
Note
Business role: Distributor (T1), ISP (T1), MSP (T2), and Reseller (T2)
This API is used to create a subscription with specified service plan of product or service.
Each product or service may have one or more service plans. Before creating a subscription, you must confirm the specific service plan that you need. You can access service plan information from the Partners :: Service Plans :: List API.
You can specify the start date of the license for subscription. If you do not provide the start date when creating the subscription, the license will be activated immediately when subscription is created successfully.

Cross Grade

When customer subscribes to a SaaS or Suite service, the subscription might trigger a Cross Grade process in LMPI.
Cross Grade is designed to deal with license conflicts, which occur when you subscribe to a service or suite for your customer, but one or more of the specified services overlap with services the customer already owns. If the specified service or suite is separate from services the customer already owns, the subscription does not cause Cross Grade.
If a Cross Grade process is triggered, the existing license is cross-graded into a suite product automatically, if circumstances allow.
Tip
Tip
Be sure to save the subscription ID returned by the API for future use in updating and disabling subscriptions and sending customer notifications.

Request

HTTP Request

[POST] /LMPI/v2/customers/{customer_id}/subscriptions

Parameters

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

Request Body

{
  "service_plan_id" : "6338528F-E0BE-4A7A-AB6A-C22FDE023AE9",
  "license_start_date" : "2013-01-01T13:01:01Z",
  "units_per_license" : 30
}
Name
Type
Description
Validation
Required Parameters
service_plan_id
string
The unique identifier of service plan.
Important
Important
This function does not support creating Trend Vision One subscriptions.
Trend Vision One users can use LMPI v3.0 starting November 27, 2024.
GUID format
units_per_license
integer
The total number of licenses under current created subscription. For trial service plans, the number of subscribed licenses depends on backend configuration of license. You can confirm settings of available number of trial licenses with your integration contact window.
Positive integer (1-999,999)
Optional Parameters
license_start_date
date
The start date of license. If service plan satisfies one or more of the following conditions, you do not need to provide this parameter.
  • Service plan is a trial.
  • Service plan is configured to activate when customer first signs in to Customer Licensing Portal.
The start date of license must be the same as or later than the current time.
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:
{
  "subscription_id" : "3CB3C2A5-94C5-4D57-9B97-CF4FCC47FF77",
  "product_name" : "Worry Free Business Security Service",
  "licenses" : [{
      "product_id" : "WFBSSVC",
      "version" : "full",
      "ac_code" : "SD-UPTQ-3Z2NK-2T65B-7UC8R-CAVAB-ATMAN",
      "units" : 30,
      "license_start_date" : "2013-01-01T13:01:01Z",
      "license_expiration_date" : "2013-02-01T13:01:01Z",
      "start_charge_date" : "2013-01-01T13:01:01Z"
    }]
}
Name
Type
Description
Length
subscription_id
string
The unique identifier of subscription.
GUID format
product_name
string
The name of product or service subscribed to.
1-150 characters
service_url
string
The URL of Customer Licensing Portal, where customer can sign in for profile management and single sign-on to the product website.
0-300 characters
licenses[].product_id
string
The code representing specific product or service.
9 characters
licenses[].version
string
The type of license version.
Possible values include:
  • Trial
  • Full
1-10 characters
licenses[].ac_code
string
The activation code of license.
For SaaS products and services, the license is activated through a specific condition, not by activation code.
38 characters
licenses[].units
integer
The number of licenses that current subscription allocates for.
Positive integer (1-999,999)
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 expiration date and time of license.
After license expiration date, the customer enters the license grace period. The grace period of different products are as follows:
  • Cloud App Security: 90 days
  • Worry Free Business Security Service: 90 days
  • Hosted Email Service 2.0: N/A
ISO 8601 standard with format "YYYY-MM-DDThh:mm:ssZ"
licenses[].start_charge_date
date
The date and time when customer company begins to be charged for license.
ISO 8601 standard with format "YYYY-MM-DDThh:mm:ssZ"