Documentation

GET /service/api/ecom/shop/products/{keycode}

Gets a license by its keycode.

Request Information

URI Parameters

Name	Description	Type	Additional Information
keycode	The product keycode.	string	Required

URI Sample(s)

GET	https://unityapi.webrootcloudav.com/service/api/ecom/shop/products/C1BF911474A9464DA6BE

Body Parameters

None.

Response Information

Resource Description

The license which represents a set of subscriptions to particular products.

GetProductLicenseResponseServiceModel

Name	Description	Type	Additional Information
LicenseId	A unique identifier for the license that was queried.	integer	None.
Keycode	Keycode identifying the license.	string	None.
ProductLineDescription	Description of the associated product line.	string	None.
ParentLicenseId	Unique identifier for the parent license.	integer	None.
ParentKeycode	The keycode for the parent license.	string	None.
ChildLicenseActivations	Number of activations in child licenses.	integer	None.
PartnerStartDate	Start date of the partner.	date	None.
CustomAttribute	Custom value which may be set by eCom depending on the use case.	string	None.
Profile	A dictionary of profiles.	Dictionary of string [key] and GetProductLicenseResponseServiceModel_LicenseProfile [value]	None.
Customer	The customer associated to this license.	GetProductLicenseResponseServiceModel_Customer	None.

Sample Response

{
  "LicenseId": 174646260,
  "Keycode": "61D44F58541648ACAD33",
  "ProductLineDescription": "Webroot Business",
  "ParentLicenseId": 168959224,
  "ParentKeycode": "46BD53CCDDEF4EEAB826",
  "ChildLicenseActivations": 3,
  "PartnerStartDate": "2024-04-22T15:56:56",
  "CustomAttribute": null,
  "Profile": {
    "SAEP": {
      "LicenseCategoryName": "SAEP",
      "LicenseCategoryDescription": "Webroot Endpoint Protection",
      "LicenseSeats": 924,
      "LicenseKeycodeTypeId": 3,
      "StartDate": "2024-04-15T18:35:47",
      "ExpirationDate": "2026-02-23T21:15:50",
      "LicenseAttributeValue": null,
      "LicenseAttributeValueDescription": null,
      "LicenseAttributeDescription": null,
      "CategoryTypeName": "full",
      "ItemHierarchyId": 1,
      "ItemHierarchyName": "primary",
      "LicenseStatusId": 0,
      "LicenseStatusDescription": "inactive",
      "UsagePricingModelId": null,
      "UsagePricingModelName": null,
      "UsageCheckDay": 15,
      "VaultId": null,
      "VaultName": null,
      "Vaults": null,
      "ProductPlatformId": null,
      "ProductPlatformName": null,
      "RetentionModelId": null,
      "RetentionModelName": null
    },
    "SDNS": {
      "LicenseCategoryName": "SDNS",
      "LicenseCategoryDescription": "Webroot DNS Protection",
      "LicenseSeats": 117,
      "LicenseKeycodeTypeId": 3,
      "StartDate": "2024-03-23T07:06:33",
      "ExpirationDate": "2026-01-17T16:48:23",
      "LicenseAttributeValue": null,
      "LicenseAttributeValueDescription": null,
      "LicenseAttributeDescription": null,
      "CategoryTypeName": "trial",
      "ItemHierarchyId": 2,
      "ItemHierarchyName": "secondary",
      "LicenseStatusId": 1,
      "LicenseStatusDescription": "active",
      "UsagePricingModelId": null,
      "UsagePricingModelName": null,
      "UsageCheckDay": 15,
      "VaultId": null,
      "VaultName": null,
      "Vaults": null,
      "ProductPlatformId": null,
      "ProductPlatformName": null,
      "RetentionModelId": null,
      "RetentionModelName": null
    },
    "SECA": {
      "LicenseCategoryName": "SECA",
      "LicenseCategoryDescription": "Webroot Security Awareness",
      "LicenseSeats": 386,
      "LicenseKeycodeTypeId": 3,
      "StartDate": "2024-01-26T00:19:39",
      "ExpirationDate": "2027-05-19T06:21:13",
      "LicenseAttributeValue": null,
      "LicenseAttributeValueDescription": null,
      "LicenseAttributeDescription": null,
      "CategoryTypeName": "full",
      "ItemHierarchyId": 2,
      "ItemHierarchyName": "secondary",
      "LicenseStatusId": 0,
      "LicenseStatusDescription": "inactive",
      "UsagePricingModelId": null,
      "UsagePricingModelName": null,
      "UsageCheckDay": 15,
      "VaultId": null,
      "VaultName": null,
      "Vaults": null,
      "ProductPlatformId": null,
      "ProductPlatformName": null,
      "RetentionModelId": null,
      "RetentionModelName": null
    }
  },
  "Customer": {
    "VendorCustomerCode": "19920",
    "CompanyName": "Sample Company"
  }
}

<GetProductLicenseResponseServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
  <ChildLicenseActivations>3</ChildLicenseActivations>
  <CustomAttribute i:nil="true" />
  <Customer>
    <CompanyName>Sample Company</CompanyName>
    <VendorCustomerCode>19920</VendorCustomerCode>
  </Customer>
  <Keycode>61D44F58541648ACAD33</Keycode>
  <LicenseId>174646260</LicenseId>
  <ParentKeycode>46BD53CCDDEF4EEAB826</ParentKeycode>
  <ParentLicenseId>168959224</ParentLicenseId>
  <PartnerStartDate>2024-04-22T15:56:56</PartnerStartDate>
  <ProductLineDescription>Webroot Business</ProductLineDescription>
  <Profile xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringGetProductLicenseResponseServiceModel_LicenseProfilefLvholdK>
      <d2p1:Key>SAEP</d2p1:Key>
      <d2p1:Value>
        <CategoryTypeName>full</CategoryTypeName>
        <ExpirationDate>2026-02-23T21:15:50</ExpirationDate>
        <ItemHierarchyId>1</ItemHierarchyId>
        <ItemHierarchyName>primary</ItemHierarchyName>
        <LicenseAttributeDescription i:nil="true" />
        <LicenseAttributeValue i:nil="true" />
        <LicenseAttributeValueDescription i:nil="true" />
        <LicenseCategoryDescription>Webroot Endpoint Protection</LicenseCategoryDescription>
        <LicenseCategoryName>SAEP</LicenseCategoryName>
        <LicenseKeycodeTypeId>3</LicenseKeycodeTypeId>
        <LicenseSeats>924</LicenseSeats>
        <LicenseStatusDescription>inactive</LicenseStatusDescription>
        <LicenseStatusId>0</LicenseStatusId>
        <ProductPlatformId i:nil="true" />
        <ProductPlatformName i:nil="true" />
        <RetentionModelId i:nil="true" />
        <RetentionModelName i:nil="true" />
        <StartDate>2024-04-15T18:35:47</StartDate>
        <UsageCheckDay>15</UsageCheckDay>
        <UsagePricingModelId i:nil="true" />
        <UsagePricingModelName i:nil="true" />
        <VaultId i:nil="true" />
        <VaultName i:nil="true" />
        <Vaults i:nil="true" />
      </d2p1:Value>
    </d2p1:KeyValueOfstringGetProductLicenseResponseServiceModel_LicenseProfilefLvholdK>
    <d2p1:KeyValueOfstringGetProductLicenseResponseServiceModel_LicenseProfilefLvholdK>
      <d2p1:Key>SDNS</d2p1:Key>
      <d2p1:Value>
        <CategoryTypeName>trial</CategoryTypeName>
        <ExpirationDate>2026-01-17T16:48:23</ExpirationDate>
        <ItemHierarchyId>2</ItemHierarchyId>
        <ItemHierarchyName>secondary</ItemHierarchyName>
        <LicenseAttributeDescription i:nil="true" />
        <LicenseAttributeValue i:nil="true" />
        <LicenseAttributeValueDescription i:nil="true" />
        <LicenseCategoryDescription>Webroot DNS Protection</LicenseCategoryDescription>
        <LicenseCategoryName>SDNS</LicenseCategoryName>
        <LicenseKeycodeTypeId>3</LicenseKeycodeTypeId>
        <LicenseSeats>117</LicenseSeats>
        <LicenseStatusDescription>active</LicenseStatusDescription>
        <LicenseStatusId>1</LicenseStatusId>
        <ProductPlatformId i:nil="true" />
        <ProductPlatformName i:nil="true" />
        <RetentionModelId i:nil="true" />
        <RetentionModelName i:nil="true" />
        <StartDate>2024-03-23T07:06:33</StartDate>
        <UsageCheckDay>15</UsageCheckDay>
        <UsagePricingModelId i:nil="true" />
        <UsagePricingModelName i:nil="true" />
        <VaultId i:nil="true" />
        <VaultName i:nil="true" />
        <Vaults i:nil="true" />
      </d2p1:Value>
    </d2p1:KeyValueOfstringGetProductLicenseResponseServiceModel_LicenseProfilefLvholdK>
    <d2p1:KeyValueOfstringGetProductLicenseResponseServiceModel_LicenseProfilefLvholdK>
      <d2p1:Key>SECA</d2p1:Key>
      <d2p1:Value>
        <CategoryTypeName>full</CategoryTypeName>
        <ExpirationDate>2027-05-19T06:21:13</ExpirationDate>
        <ItemHierarchyId>2</ItemHierarchyId>
        <ItemHierarchyName>secondary</ItemHierarchyName>
        <LicenseAttributeDescription i:nil="true" />
        <LicenseAttributeValue i:nil="true" />
        <LicenseAttributeValueDescription i:nil="true" />
        <LicenseCategoryDescription>Webroot Security Awareness</LicenseCategoryDescription>
        <LicenseCategoryName>SECA</LicenseCategoryName>
        <LicenseKeycodeTypeId>3</LicenseKeycodeTypeId>
        <LicenseSeats>386</LicenseSeats>
        <LicenseStatusDescription>inactive</LicenseStatusDescription>
        <LicenseStatusId>0</LicenseStatusId>
        <ProductPlatformId i:nil="true" />
        <ProductPlatformName i:nil="true" />
        <RetentionModelId i:nil="true" />
        <RetentionModelName i:nil="true" />
        <StartDate>2024-01-26T00:19:39</StartDate>
        <UsageCheckDay>15</UsageCheckDay>
        <UsagePricingModelId i:nil="true" />
        <UsagePricingModelName i:nil="true" />
        <VaultId i:nil="true" />
        <VaultName i:nil="true" />
        <Vaults i:nil="true" />
      </d2p1:Value>
    </d2p1:KeyValueOfstringGetProductLicenseResponseServiceModel_LicenseProfilefLvholdK>
  </Profile>
</GetProductLicenseResponseServiceModel>