Create a license
Gets a new license key from a license service for one item of an order, saves it and adds it to the order item. Use it to issue a key by hand. A license request is recorded either way. For a remote_url service your server is called during this request, and its failure is returned as 502. Send save: false to fetch a key without saving it. Secret and trusted tokens may call it.
AuthorizationBearer <token>A secret, trusted or limited token. See Authentication.
expand?stringComma-separated child objects to return in full instead of as a URL, for example customer,payments. Use dot notation for nested objects (items.product), up to four levels deep. A single object takes up to 12 paths; a list takes up to 2, applied to every item. Extra paths are dropped without an error. See Expanding objects.
show?stringComma-separated fields to return; all others are left out. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.
hide?stringComma-separated fields to leave out of the response. Use dot notation for child fields (customer.email). You cannot send show and hide together (400). See Customizing output.
formatted?booleanWhen true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.
falseWhich service, order and item the key is for.
application/json- body
Asks a license service for a key for one item of an order, for example to issue a key by hand or to replace one.
license_service_id*stringThe license service to get the key from. Must be one of yours.
order_id*stringThe order the key is for. Must be one of your orders.
product_id*stringThe product of the order item the key is for. It must be an item of the order.
item_id?stringThe order item the key is for. When left out, product_id is used.
account_id?stringYour account id. Send it: the order is looked up with the account id in the body, and without it the request fails.
save?booleanWhen false, the key is fetched and returned but not saved or added to the order. The license request is still recorded. The default is true.
The new license.
application/json- response
A license key issued for one item of an order, from the product's license service. A limited token may read a license only when it is bound to it, such as the customer's own order.
object*"license"The object type. Always license.
"license"url*stringThe URL of this license in the API.
urilicense_id*stringThe id of the license.
date_created*stringWhen the license was issued.
date-timedate_modified*stringWhen the license was last changed.
date-timetest*booleanTrue for a test-mode license.
item_id*stringThe order item the license is for. The same as the product id.
account_id*stringThe account the license belongs to.
label*stringWhat the key is called, copied from the license service, for example License Code.
license_service?|The license service that issued the key, as a link, or the full object when you send expand=license_service. Not returned to limited tokens.
order?|The order, as a link, or the full object when you send expand=order.
product?|The product, as a link, or the full object when you send expand=product.
text*|The key as plain text, with any HTML removed.
html*|The key as HTML, with line breaks turned into <br>.
instructions*|How to use the key, from the license service or your license server.
formatted?Present only when you send formatted=true.
curl -X POST 'https://api.comecero.com/api/v1/licenses' \ -H 'Content-Type: application/json' \ -d '{ "license_service_id": "0095012789659LsuOeAWLC", "order_id": "7393-GMRFY-954", "product_id": "widget-pro.test"}'{ "object": "license", "url": "https://api.comecero.com/api/v1/licenses/0142130710581LiRr8sT2c", "license_id": "0142130710581LiRr8sT2c", "date_created": "2026-11-02T00:45:11Z", "date_modified": "2026-11-02T00:45:11Z", "test": true, "item_id": "widget-pro.test", "account_id": "AB1234", "label": "License Code", "license_service": "https://api.comecero.com/api/v1/license_services/0095012789659LsuOeAWLC", "order": "https://api.comecero.com/api/v1/orders/6622-NXKHE-858", "product": "https://api.comecero.com/api/v1/products/widget-pro.test", "text": "AAAA-BBBB-CCCC-0001", "html": "AAAA-BBBB-CCCC-0001", "instructions": "Open Widget Pro, choose Help, then Enter License, and paste the code."}List licenses GET
Returns the license keys issued for your orders, oldest first unless you send `desc=true`. Secret and trusted tokens may call it.
Get a license GET
Returns one license key. A limited token may read it only when the license is bound to the token, such as a license on the signed-in customer's order. Secret, trusted and limited tokens may call it.