Updates (renew license, increase seats etc.) a license, child license, or trial license by its keycode.
PUT {{baseUrl}}/api/ecom/licenses/:keycode
[DEPRECATED: 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.] 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 Body
{"Order"=>{"PartnerOrderCode"=>nil, "PartnerOrderDate"=>nil, "LanguageCode"=>"EN", "LocationCode"=>"USA", "PurchaseOrder"=>nil, "Item"=>{"Modules"=>[{"Code"=>"DNS", "Seats"=>50}, {"Code"=>"WSAT", "Seats"=>50}], "PartnerProductId"=>"113400101", "Seats"=>50, "ListPrice"=>nil, "UnitPrice"=>nil, "StartDate"=>nil, "ExpirationDate"=>nil}, "Customers"=>[{"ExternalAccountId"=>"MyAccountRef5639", "FirstName"=>"John", "LastName"=>"Doe", "CompanyName"=>"Incorporated Inc.", "CustomerEmail"=>"jdoe@incorporated.com", "PhoneNumber"=>"07817650", "Address1"=>"Samplestreet 5", "Address2"=>nil, "City"=>"Denver", "State"=>"CO", "Country"=>"USA", "PostalCode"=>"80123", "OrderCompanyTypeId"=>1}]}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"Order":{"VendorOrderCode":"PSV0055936718","VendorOrderDate":"2022-11-29T10:36:05.8254862Z","CurrencyCode":"USD","TotalAmount":5000,"SubTotalAmount":5000,"TaxTotal":0,"Items":[{"ProductId":"113400101","Quantity":1,"Seats":50,"Years":1,"ListPrice":100,"UnitPrice":100,"LicenseId":174402247,"Keycode":"DE5C7F01F5C54F739555","Modules":[{"ProductId":"113400101","Quantity":1,"Seats":50,"Years":2,"ListPrice":200,"UnitPrice":250}]}],"Customer":{"FirstName":"John","LastName":"Doe","CompanyName":"Incorporated Inc.","CustomerEmail":"jdoe@incorporated.com","PhoneNumber":"07441083","Address1":"Samplestreet 5","Address2":null,"City":"Denver","State":"CO","PostalCode":"80123","Country":"USA"}}}