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 Cart) for the next generation Ecommerce API functionality.

PUT /service/api/ecom/licenses/{keycode}

Updates (renew license, increase seats etc.) a license, child license, or trial license by its keycode.

When renewing a license, pass the appropriate PartnerProductId in the request.

Note: If only the "Seats" field is specified under the "Item" element and the number being specified is less than the present seat number of the license, the request is interpreted as a license downgrade (decrease seats). Downgrading a license does not create a new order and thus the order element of the response will be null and the response body will look like { "Order": null }.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
keycode

The keycode of the license.

string

Required

URI Sample(s)

PUT
https://unityapi.webrootcloudav.com/service/api/ecom/licenses/2218B7FFFA8E4419A876

Body Parameters

UpdateLicenseRequestServiceModel
NameDescriptionTypeAdditional Information
Order

Order element.

UpdateLicenseRequestServiceModel_Order

None.

Sample Request

{
  "Order": {
    "PartnerOrderCode": null,
    "PartnerOrderDate": null,
    "LanguageCode": "EN",
    "LocationCode": "USA",
    "PurchaseOrder": null,
    "Item": {
      "Modules": [
        {
          "Code": "DNS",
          "Seats": 50
        },
        {
          "Code": "WSAT",
          "Seats": 50
        }
      ],
      "PartnerProductId": "113400101",
      "Seats": 50,
      "ListPrice": null,
      "UnitPrice": null,
      "StartDate": null,
      "ExpirationDate": null
    },
    "Customers": [
      {
        "ExternalAccountId": "MyAccountRef5055",
        "FirstName": "John",
        "LastName": "Doe",
        "CompanyName": "Incorporated Inc.",
        "CustomerEmail": "jdoe@incorporated.com",
        "PhoneNumber": "07161646",
        "Address1": "Samplestreet 5",
        "Address2": null,
        "City": "Denver",
        "State": "CO",
        "Country": "USA",
        "PostalCode": "80123",
        "OrderCompanyTypeId": 1
      }
    ]
  }
}                    
<UpdateLicenseRequestServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
  <Order>
    <Customers>
      <UpdateLicenseRequestServiceModel_Customer>
        <Address1>Samplestreet 5</Address1>
        <Address2 i:nil="true" />
        <City>Denver</City>
        <CompanyName>Incorporated Inc.</CompanyName>
        <Country>USA</Country>
        <CustomerEmail>jdoe@incorporated.com</CustomerEmail>
        <ExternalAccountId>MyAccountRef5055</ExternalAccountId>
        <FirstName>John</FirstName>
        <LastName>Doe</LastName>
        <OrderCompanyTypeId>1</OrderCompanyTypeId>
        <PhoneNumber>07161646</PhoneNumber>
        <PostalCode>80123</PostalCode>
        <State>CO</State>
      </UpdateLicenseRequestServiceModel_Customer>
    </Customers>
    <Item>
      <ExpirationDate i:nil="true" />
      <ListPrice i:nil="true" />
      <Modules>
        <UpdateLicenseRequestServiceModel_Module>
          <Code>DNS</Code>
          <Seats>50</Seats>
        </UpdateLicenseRequestServiceModel_Module>
        <UpdateLicenseRequestServiceModel_Module>
          <Code>WSAT</Code>
          <Seats>50</Seats>
        </UpdateLicenseRequestServiceModel_Module>
      </Modules>
      <PartnerProductId>113400101</PartnerProductId>
      <Seats>50</Seats>
      <StartDate i:nil="true" />
      <UnitPrice i:nil="true" />
    </Item>
    <LanguageCode>EN</LanguageCode>
    <LocationCode>USA</LocationCode>
    <PartnerOrderCode i:nil="true" />
    <PartnerOrderDate i:nil="true" />
    <PurchaseOrder i:nil="true" />
  </Order>
</UpdateLicenseRequestServiceModel>                    

Response Information

Resource Description

Details about the updated license.

UpdateLicenseResponseServiceModel
NameDescriptionTypeAdditional Information
Order

Order element.

UpdateLicenseResponseServiceModel_Order

None.

Sample Response

{
  "Order": {
    "VendorOrderCode": "PSV0079029063",
    "VendorOrderDate": "2023-02-08T21:44:53.64291Z",
    "CurrencyCode": "USD",
    "TotalAmount": 5000.0,
    "SubTotalAmount": 5000.0,
    "TaxTotal": 0.0,
    "Items": [
      {
        "ProductId": "113400101",
        "Quantity": 1,
        "Seats": 50,
        "Years": 1,
        "ListPrice": 100.0,
        "UnitPrice": 100.0,
        "LicenseId": 164391321,
        "Keycode": "4B74DFDE7EE24FDEAC8E",
        "Modules": [
          {
            "ProductId": "113400101",
            "Quantity": 1,
            "Seats": 50,
            "Years": 2,
            "ListPrice": 200.0,
            "UnitPrice": 250.0
          }
        ]
      }
    ],
    "Customer": {
      "FirstName": "John",
      "LastName": "Doe",
      "CompanyName": "Incorporated Inc.",
      "CustomerEmail": "jdoe@incorporated.com",
      "PhoneNumber": "07830885",
      "Address1": "Samplestreet 5",
      "Address2": null,
      "City": "Denver",
      "State": "CO",
      "PostalCode": "80123",
      "Country": "USA"
    }
  }
}                    
<UpdateLicenseResponseServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
  <Order>
    <CurrencyCode>USD</CurrencyCode>
    <Customer>
      <Address1>Samplestreet 5</Address1>
      <Address2 i:nil="true" />
      <City>Denver</City>
      <CompanyName>Incorporated Inc.</CompanyName>
      <Country>USA</Country>
      <CustomerEmail>jdoe@incorporated.com</CustomerEmail>
      <FirstName>John</FirstName>
      <LastName>Doe</LastName>
      <PhoneNumber>07830885</PhoneNumber>
      <PostalCode>80123</PostalCode>
      <State>CO</State>
    </Customer>
    <Items>
      <UpdateLicenseResponseServiceModel_Item>
        <Keycode>4B74DFDE7EE24FDEAC8E</Keycode>
        <LicenseId>164391321</LicenseId>
        <ListPrice>100</ListPrice>
        <Modules>
          <UpdateLicenseResponseServiceModel_Module>
            <ListPrice>200</ListPrice>
            <ProductId>113400101</ProductId>
            <Quantity>1</Quantity>
            <Seats>50</Seats>
            <UnitPrice>250</UnitPrice>
            <Years>2</Years>
          </UpdateLicenseResponseServiceModel_Module>
        </Modules>
        <ProductId>113400101</ProductId>
        <Quantity>1</Quantity>
        <Seats>50</Seats>
        <UnitPrice>100</UnitPrice>
        <Years>1</Years>
      </UpdateLicenseResponseServiceModel_Item>
    </Items>
    <SubTotalAmount>5000</SubTotalAmount>
    <TaxTotal>0</TaxTotal>
    <TotalAmount>5000</TotalAmount>
    <VendorOrderCode>PSV0079029063</VendorOrderCode>
    <VendorOrderDate>2023-02-08T21:44:53.64291Z</VendorOrderDate>
  </Order>
</UpdateLicenseResponseServiceModel>