Deprecated

Announced Jun 1, 2020: APIs under the ECom.Licenses scope are scheduled for End of Life effective December 1, 2020. At that time this API will no longer be available. Please see ECom.Shop (e.g. Create Trial) for the next generation Ecommerce API functionality.

POST /service/api/ecom/licenses/createTrial

Creates a trial license.

Request Information

URI Parameters

None.

URI Sample(s)

POST
https://unityapi.webrootcloudav.com/service/api/ecom/licenses/createTrial

Body Parameters

CreateTrialRequestServiceModel
NameDescriptionTypeAdditional Information
CustomerEmail

The email address.

string

Required

LanguageCode

The ISO two-letter language code.

string

None.

LocationCode

The ISO three-letter country code.

string

None.

PartnerProductId

The product id.

string

Required

Seats

The number of seats on the trial license.

integer

Required

Country

The ISO three-letter country code.

string

Required

ExternalAccountId

The account number of the customer.

string

Required

Modules

The modules (e.g. DNS Protection or WSAT) to allocate with this license.

Collection of CreateTrialRequestServiceModel_Module

None.

Sample Request

{
  "Modules": [
    {
      "Code": "DNS",
      "Seats": 50
    },
    {
      "Code": "WSAT",
      "Seats": 50
    }
  ],
  "CustomerEmail": "jdoe@incorporated.com",
  "LanguageCode": "EN",
  "LocationCode": "USA",
  "PartnerProductId": "113400101",
  "Seats": 50,
  "Country": "USA",
  "ExternalAccountId": "MyAccountRef7293"
}                    
<CreateTrialRequestServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
  <Country>USA</Country>
  <CustomerEmail>jdoe@incorporated.com</CustomerEmail>
  <ExternalAccountId>MyAccountRef7293</ExternalAccountId>
  <LanguageCode>EN</LanguageCode>
  <LocationCode>USA</LocationCode>
  <Modules>
    <CreateTrialRequestServiceModel_Module>
      <Code>DNS</Code>
      <Seats>50</Seats>
    </CreateTrialRequestServiceModel_Module>
    <CreateTrialRequestServiceModel_Module>
      <Code>WSAT</Code>
      <Seats>50</Seats>
    </CreateTrialRequestServiceModel_Module>
  </Modules>
  <PartnerProductId>113400101</PartnerProductId>
  <Seats>50</Seats>
</CreateTrialRequestServiceModel>                    

Response Information

Resource Description

Details about the created trial license.

CreateTrialResponseServiceModel
NameDescriptionTypeAdditional Information
License

The License element.

CreateTrialResponseServiceModel_License

None.

Sample Response

{
  "License": {
    "LicenseId": 109056078,
    "Keycode": "DF6D2073ABCF4868B161",
    "ExternalAccountId": "MyAccountRef5170",
    "Seats": 50,
    "SeatsUsed": 0,
    "StorageGb": 50.0,
    "StartDate": "2023-02-09T06:12:51.3983514Z",
    "ExpirationDate": "2024-02-09T06:12:51.3983514Z",
    "Modules": [
      {
        "Seats": 50,
        "Name": "DNS Protection",
        "Code": "DNS",
        "LicenseType": "trial",
        "StartDate": "2023-02-09T06:12:51.3983514Z",
        "ExpirationDate": "2024-02-09T06:12:51.3983514Z"
      },
      {
        "Seats": 50,
        "Name": "Webroot Security Awareness Training",
        "Code": "WSAT",
        "LicenseType": "trial",
        "StartDate": "2023-02-09T06:12:51.3983514Z",
        "ExpirationDate": "2024-02-09T06:12:51.3983514Z"
      }
    ]
  }
}                    
<CreateTrialResponseServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
  <License>
    <ExpirationDate>2024-02-09T06:12:51.3983514Z</ExpirationDate>
    <ExternalAccountId>MyAccountRef5170</ExternalAccountId>
    <Keycode>DF6D2073ABCF4868B161</Keycode>
    <LicenseId>109056078</LicenseId>
    <Modules>
      <CreateTrialResponseServiceModel_Module>
        <Code>DNS</Code>
        <ExpirationDate>2024-02-09T06:12:51.3983514Z</ExpirationDate>
        <LicenseType>trial</LicenseType>
        <Name>DNS Protection</Name>
        <Seats>50</Seats>
        <StartDate>2023-02-09T06:12:51.3983514Z</StartDate>
      </CreateTrialResponseServiceModel_Module>
      <CreateTrialResponseServiceModel_Module>
        <Code>WSAT</Code>
        <ExpirationDate>2024-02-09T06:12:51.3983514Z</ExpirationDate>
        <LicenseType>trial</LicenseType>
        <Name>Webroot Security Awareness Training</Name>
        <Seats>50</Seats>
        <StartDate>2023-02-09T06:12:51.3983514Z</StartDate>
      </CreateTrialResponseServiceModel_Module>
    </Modules>
    <Seats>50</Seats>
    <SeatsUsed>0</SeatsUsed>
    <StartDate>2023-02-09T06:12:51.3983514Z</StartDate>
    <StorageGb>50</StorageGb>
  </License>
</CreateTrialResponseServiceModel>