comecerodocs
Licenses

Get a license

GET
/licenses/{license_id}

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.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

license_id*string

The license id.

Query Parameters

expand?string

Comma-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?string

Comma-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?string

Comma-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?boolean

When 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.

Defaultfalse

Response Body

The license.

application/json
  1. 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.

Value in"license"
url*string

The URL of this license in the API.

Formaturi
license_id*string

The id of the license.

date_created*string

When the license was issued.

Formatdate-time
date_modified*string

When the license was last changed.

Formatdate-time
test*boolean

True for a test-mode license.

item_id*string

The order item the license is for. The same as the product id.

account_id*string

The account the license belongs to.

label*string

What 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.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/licenses/string'
Example Response
{  "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."}

Create a license POST

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.

Overview

Next Page