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/746C72E03B6D479983DF
|
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": 125530302,
"Keycode": "1ABB822177224841B1C5",
"ProductLineDescription": "Webroot Business",
"ParentLicenseId": 146976970,
"ParentKeycode": "707A5D3DEF1E42E9A610",
"ChildLicenseActivations": 5,
"PartnerStartDate": "2024-04-16T19:42:30",
"CustomAttribute": null,
"Profile": {
"SAEP": {
"LicenseCategoryName": "SAEP",
"LicenseCategoryDescription": "Webroot Endpoint Protection",
"LicenseSeats": 906,
"LicenseKeycodeTypeId": 3,
"StartDate": "2023-06-29T20:39:28",
"ExpirationDate": "2028-12-05T04:39:41",
"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": 632,
"LicenseKeycodeTypeId": 3,
"StartDate": "2024-03-26T20:01:13",
"ExpirationDate": "2027-08-01T22:10:07",
"LicenseAttributeValue": null,
"LicenseAttributeValueDescription": null,
"LicenseAttributeDescription": null,
"CategoryTypeName": "trial",
"ItemHierarchyId": 2,
"ItemHierarchyName": "secondary",
"LicenseStatusId": 3,
"LicenseStatusDescription": "manually disabled",
"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": 202,
"LicenseKeycodeTypeId": 3,
"StartDate": "2025-07-06T14:44:17",
"ExpirationDate": "2028-02-25T14:26:05",
"LicenseAttributeValue": null,
"LicenseAttributeValueDescription": null,
"LicenseAttributeDescription": null,
"CategoryTypeName": "full",
"ItemHierarchyId": 2,
"ItemHierarchyName": "secondary",
"LicenseStatusId": 3,
"LicenseStatusDescription": "manually disabled",
"UsagePricingModelId": null,
"UsagePricingModelName": null,
"UsageCheckDay": 15,
"VaultId": null,
"VaultName": null,
"Vaults": null,
"ProductPlatformId": null,
"ProductPlatformName": null,
"RetentionModelId": null,
"RetentionModelName": null
}
},
"Customer": {
"VendorCustomerCode": "70371",
"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>5</ChildLicenseActivations>
<CustomAttribute i:nil="true" />
<Customer>
<CompanyName>Sample Company</CompanyName>
<VendorCustomerCode>70371</VendorCustomerCode>
</Customer>
<Keycode>1ABB822177224841B1C5</Keycode>
<LicenseId>125530302</LicenseId>
<ParentKeycode>707A5D3DEF1E42E9A610</ParentKeycode>
<ParentLicenseId>146976970</ParentLicenseId>
<PartnerStartDate>2024-04-16T19:42:30</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>2028-12-05T04:39:41</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>906</LicenseSeats>
<LicenseStatusDescription>inactive</LicenseStatusDescription>
<LicenseStatusId>0</LicenseStatusId>
<ProductPlatformId i:nil="true" />
<ProductPlatformName i:nil="true" />
<RetentionModelId i:nil="true" />
<RetentionModelName i:nil="true" />
<StartDate>2023-06-29T20:39:28</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>2027-08-01T22:10:07</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>632</LicenseSeats>
<LicenseStatusDescription>manually disabled</LicenseStatusDescription>
<LicenseStatusId>3</LicenseStatusId>
<ProductPlatformId i:nil="true" />
<ProductPlatformName i:nil="true" />
<RetentionModelId i:nil="true" />
<RetentionModelName i:nil="true" />
<StartDate>2024-03-26T20:01:13</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>2028-02-25T14:26:05</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>202</LicenseSeats>
<LicenseStatusDescription>manually disabled</LicenseStatusDescription>
<LicenseStatusId>3</LicenseStatusId>
<ProductPlatformId i:nil="true" />
<ProductPlatformName i:nil="true" />
<RetentionModelId i:nil="true" />
<RetentionModelName i:nil="true" />
<StartDate>2025-07-06T14:44:17</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>