CreateCartRequestServiceModel_ItemByLicenseKey

Element for cart items based on license keys.

NOTE: Each partner account configuration can have different products set up (e.g. WIFI product for 1 year with 10 seats), which restrict the values that can be specified for the LicenseCategoryName, LicenseSeats, and Years fields. Please work with your Webroot e-commerce business partner to identify valid order combinations.

NameDescriptionTypeAdditional Information
LicenseSeats

The number of seats the license should have.

integer

None.

LicenseCategoryName

License category associated to this item.

Possible values are for example: WIFI, OTSF, CBEP, WSAV, WSAI, WSAC, SAEP, SDNS, SECA.

string

None.

Keycode

The license key with which to create either a renewal or an upgrade item.

string

Required

Years

The number of years the license should be valid.

Possible values are: 0, 0.083, 0.167, 0.5, 1, 1.25, 1.5, 2, 2.25, 2.5, 3, 3.25, 3.5.

string

Required

LicenseKeycodeTypeId

The identifier of a license's keycode type.

Possible values are: 1 = standard license, 3 = parent license. If not specified, a default of 1 is assumed.

integer

None.

ItemHierarchyId

An identifier specifying whether the cart item is a primary or secondary product. Secondary products have an ItemHierarchyId of 2 and represent products dependent on a primary product. Examples include SDNS (Webroot DNS Protection) and SECA (Webroot Security Awareness Training) products provisioned as part of an item whose primary product is SAEP.

Note that the ItemHierarchyId field cannot be used without a CartItemBundleId.

If not specified, a default of 1 is assumed.

integer

None.

ExpirationDate

The expiration date of this license. Although Years is a required input for the cart item, it is possible to define a custom expiration date by using this parameter. Specifying a custom expiration date needs to be enabled on your partner account. Please contact your Webroot representative, if you require this functionality.

date

None.

VendorOrderItemCode

The vendor specific order item code.

string

None.

CartItemBundleId

The bundle identifier for this item. Defines whether the items specified in the cart belong to the same license/keycode. If multiple items are associated with the same bundle, only one of them can have an ItemHierarchyId of 1.

integer

None.

LicenseAttributeValue

A value which indicates the product usage model for this item. Digit one defines the order type (1 = MSP, 2 = reseller). Digit two determines which terms a license is based on (1 = monthly, 2 = annually). Digit three refers to the associated billing model (0 = sold, 1 = overage, 2 = utility). As an example, 210 stands for "Reseller Monthly Sold". Please note that the exact values you can use are determined by your contract with Webroot.

integer

None.

UsagePricingModelId

A value which indicates how usage will be calculated for this item. Only applicable to certain license categories like OTSF (1 = Advanced, 2 = Capacity) and CBEP (1 = Advanced, 3 = Standard). If not specified, a default is assumed. Please speak with your Webroot e-commerce business partner for defaults/values specific to your contract.

integer

None.

VaultId

Defines which data center vault to use (applicable to OTSF and CBEP). Note that ids are associated to license categories. As an example, a value of '1' defines a data center in the US for CBEP. Supported values are:

  • CBEP:
    • 1 = US
    • 2 = EMEA
    • 3 = CA
    • 4 = FR
    • 5 = APAC
    • 15 = AU
    • 16 = UK
  • OTSF
    • 8 = East US 2 (Virginia)
    • 9 = Australia East (New South Wales)
    • 10 = Canada Central (Toronto)
    • 11 = France Central (Paris)
    • 12 = UK South (London)
    • 13 = Germany

integer

None.

ProductPlatformId

Platform to use for this item (applicable to CBEP only). If nothing is provided, a default value of 1 is assumed. Currently supported values are:

  • 1 = Carbonite. Valid for LicenseKeycodeTypeId 3 and 1.
  • 2 = Azure EA. Valid for Business Single Site in Reseller Cart (LicenseKeycodeTypeId=1).
  • 3 = OnPrem. Valid for Business Single Site in Reseller Cart (LicenseKeycodeTypeId=1).

integer

None.

RetentionModelId

Number of years data is retained (applicable to OTSF only). Legitimate values are 1 (for one year) or 2 (for seven years). Default is 1.

integer

None.

ProductPricingLevelId

Pricing level to use for this item (1 = Standard, 2 = EDU/Non Profit, 3 = Government). Only valid for resellers (not for MSP orders). Partners who are not configured will get a 'no pricing found' message.

integer

None.