Partners :: Service Plan :: Create

Views:

Last updated: 12/5/2024 11:24:23 AM

Note

Business 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/v3/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 the partner company.

GUID format

product_id

string

The unique identifier of the product.

GUID format

service_plan_name

string

The name of the service plan.

1-150 characters

type

string

The type of product.

Possible values include:

SaaS
Software

Valid product type

version

string

The version of the license.

Possible values include:

0: Trial
1: Full

Valid version type

period

integer

The initial period of the 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."

Note

For trial service plans, you can only set a monthly period ("1").

Positive integer (1-66)

activation_type

integer

The activation type of the service plan, when the license becomes chargeable.

Possible values include:

0: Activates when the vendor assigns the service plan to a customer.
1: Activates when the customer first signs in.

Valid activation type

price_type

string

The pricing type of the service plan, determined by the product.

Possible values for different products include:

Cloud App Security: U
Hosted Email Security 2.0: U
Worry Free Business Security Service: U

Note

The value "U" indicates a service plan priced by provisioned seats or units.

Valid pricing type

Optional Parameters

dc_code

string

The code of the data center of the product.

Important

This field is only applicable to SaaS products.

Possible values include:

Worry Free Business Security Service: 08/11/22
Cloud App Security: 06/11/22
Hosted Email Security 2.0: 08/11/22

Possible region codes include:

06: EU
08: Germany
11: Japan
22: USA

Valid data center code

auto_renewal_month

integer

The month of automatic renewal for the created service plan.

If you provide a value, automatic renewal is enabled for the service plan.

Note

This field is only for service plans for full licenses, not trial versions.

Positive integer (1-66)

managed

boolean

The Remote Manager Service status for the created service plan.

Possible values include:

true: The Remote Manager Service is enabled
false: The Remote Manager Service is disabled

Note

If the Remote Manager Service is enabled, all subscriptions based on the created service plan can be remotely managed by a reseller through the Remote Manager portal.

true/false

chargeable_month

integer

The number of months after the license start date that the license becomes chargeable.

Positive integer

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 the service plan.

GUID format

service_plan_name

string

The name of the 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 the license.

This value must match the value provided in the request.

1-10 characters

auto_renewal_month

string

The month of automatic renewal for the created service plan.

Note

If the created service plan is for a trial license, the value for this field must be "0."

Integer

managed

boolean

The Remote Manager Service status for the created service plan.

Possible values include:

true: The Remote Manager Service is enabled
false: The Remote Manager Service is disabled

This value must match the value provided in the request.

true/false

period

string

The period of the license.

This value must match the value provided in the request.

Positive integer

price_type

string

The pricing type of the service plan.

This value must match the value provided in the request.

1-10 characters

dc_code

string

The code of the data center of the product.

This value must match the value provided in the request.

1-2 characters