Last updated: 3/12/2025 8:37:23 AM
![]() |
NoteBusiness role: Distributor (T1), ISP (T1), and MSP (T2)
|
This API is used to create a service plan for a product license.
Each subscription must be associated with a valid service plan, meaning that every
partner must create one or more service plans before starting business.
You can retrieve all request parameters required for this API from the Partners :: Product :: List API.
This API is only for creating a service plan for a single product. Creating a service
plan for a suite of products is not supported by this API.
Request
HTTP Request
[POST] /LMPI/v2/partners/serviceplan
Parameters
Request Body
{ "partner_id":"6c25b1f5-8af7-45ea-8291-5fe0ca0a5d22", "product_id":"5953bc26-9b96-448b-89a7-ef00f2a38790", "service_plan_name":"Worry Free Business Security Service", "type":"SaaS", "version":"1", "period":"12", "activation_type":"0", "price_type":"U", "dc_code":"22", "auto_renewal_month":"12", "managed":"true", "chargeable_month":"1" }
Name
|
Type
|
Description
|
Validation
|
||
Required Parameters
|
|||||
partner_id
|
string
|
The unique identifier of partner company.
|
GUID format
|
||
product_id
|
string
|
The unique identifier of product.
|
GUID format
|
||
service_plan_name
|
string
|
The name of service plan.
|
1-150 characters
|
||
type
|
string
|
The type of product.
Possible values include:
|
Valid product type
|
||
version
|
string
|
The version of license.
Possible values include:
|
Valid version type
|
||
period
|
integer
|
The initial period of license.
The license period is measured in months. For example, for a service plan with a monthly
period, the value of this field must be "1." For an annual period, the value of this
field must be "12."
For trial service plans, you can only set a monthly period ("1").
|
Positive integer (1-66)
|
||
activation_type
|
integer
|
The activation type of service plan, when the license becomes chargeable.
Possible values include:
|
Valid activation type
|
||
price_type
|
string
|
The price type of service plan, determined by product.
Possible values include:
The value "U" indicates a service plan priced by provisioned seats or units.
|
Valid price type
|
||
Optional Parameters
|
|||||
dc_code
|
string
|
The code of data center of product.
Possible values include:
Possible region codes include:
|
Valid data center code
|
||
auto_renewal_month
|
integer
|
The month of automatic renewal for created service plan.
If you provide a value, automatic renewal is enabled for service plan.
This field is only for service plans for full licenses, not trial versions.
|
Positive integer (1-66)
|
||
managed
|
boolean
|
The status of the Remote Manager Service for created service plan.
If the Remote Manager Service is enabled, all subscriptions based on created service
plan can be remotely managed by reseller through the Remote Manager portal.
|
true/false
|
||
chargeable_month
|
integer
|
The number of months after license start date that license becomes chargeable.
|
Positive integer
|
Response
Response
If successful, this method returns an HTTP 200 OK status code and a response body
with the following structure:
{ "service_plan_id": "9eada398-cff2-41a7-9c5a-8ad21c96282b", "service_plan_name": "Worry Free Business Security Service", "type": "SaaS", "version": "full", "auto_renewal_month": "12", "managed": "true", "period": "12", "price_type": "U", "dc_code": "22" }
Name
|
Type
|
Description
|
Length
|
service_plan_id
|
string
|
The unique identifier of service plan.
|
GUID format
|
service_plan_name
|
string
|
The name of service plan.
|
GUID format
|
type
|
string
|
The type of product.
This value must match the value provided in the request.
|
1-8 characters
|
version
|
string
|
The version of license.
This value must match the value provided in the request.
|
1-10 characters
|
auto_renewal_month
|
string
|
The month of automatic renewal for created service plan.
If created service plan is for a trial version, the value for this field must be
"0."
|
Integer
|
managed
|
boolean
|
The status of the Remote Manager Service for created service plan.
This value must match the value provided in the request.
|
true/false
|
period
|
string
|
The period of license.
This value must match the value provided in the request.
|
Positive integer
|
price_type
|
string
|
The price type of service plan.
This value must match the value provided in the request.
|
1-10 characters
|
dc_code
|
string
|
The code of data center of product.
This value must match the value provided in the request.
|
1-2 characters
|