comecerodocs
License services

Create a license service

POST
/license_services

Creates a license service. Link it to a product with the product's license_service_id, and every sale of that product gets a license key from it. Secret and trusted tokens may call it.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Query Parameters

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

Request Body

The new license service.

application/json
  1. body

The fields you can set on a license service. On create, name, label, type and configuration are required (for a list, with at least one key). On update, send only the fields you want to change; inside configuration, only the fields you send change.

name*string

Your name for the service.

Lengthlength <= 75
label*string

What the key is called when shown to the customer, for example License Code or Registration Code.

Lengthlength <= 75
description?|

Your notes about the service.

Lengthlength <= 256
instructions?|

How to use the key, shown to the customer with it. Basic HTML is kept; anything else is stripped.

Lengthlength <= 1024
type*string

Where keys come from: remote_url asks your license server, list hands out keys you uploaded.

Value in"remote_url""list"
expand?|

For remote_url: the child objects to expand in the order sent to your server, as in the expand query parameter. customer is always expanded.

show?|

For remote_url: the only order fields to send to your server. Cannot be used with hide.

hide?|

For remote_url: order fields to leave out of what is sent to your server. Cannot be used with show.

configuration*|

The settings for the service's type.

Response Body

The new license service.

application/json
  1. response

The source of license keys for a product: a list of keys you upload, or your own license server that Comecero calls after each sale.

object*"license_service"

The object type. Always license_service.

Value in"license_service"
url*string

The URL of this license service in the API.

Formaturi
license_service_id*string

The id of the license service.

date_created*string

When the service was created.

Formatdate-time
date_modified*string

When the service was last changed.

Formatdate-time
test*boolean

True for a test-mode service.

account_id*string

The account the service belongs to.

name*string

Your name for the service.

Lengthlength <= 75
label*string

What the key is called when shown to the customer, for example License Code or Registration Code.

Lengthlength <= 75
description*|

Your notes about the service.

Lengthlength <= 256
instructions*|

How to use the key, shown to the customer with it. Basic HTML is kept; anything else is stripped.

Lengthlength <= 1024
type*string

Where keys come from: remote_url asks your license server, list hands out keys you uploaded.

Value in"remote_url""list"
expand*|

For remote_url: the child objects to expand in the order sent to your server, as in the expand query parameter. customer is always expanded.

show*|

For remote_url: the only order fields to send to your server. Cannot be used with hide.

hide*|

For remote_url: order fields to leave out of what is sent to your server. Cannot be used with show.

configuration*|

The settings for the service's type.

formatted?

Present only when you send formatted=true.

curl -X POST 'https://api.comecero.com/api/v1/license_services' \  -H 'Content-Type: application/json' \  -d '{  "name": "Widget Pro keys",  "label": "License Code",  "type": "list",  "instructions": "Open Widget Pro, choose Help, then Enter License, and paste the code.",  "configuration": {    "licenses": [      "AAAA-BBBB-CCCC-0001",      "AAAA-BBBB-CCCC-0002"    ],    "per_quantity": false,    "notify_at_count": 10  }}'
Example Response
{  "object": "license_service",  "url": "https://api.comecero.com/api/v1/license_services/0095012789659LsuOeAWLC",  "license_service_id": "0095012789659LsuOeAWLC",  "date_created": "2026-11-02T16:26:29Z",  "date_modified": "2026-11-02T16:45:25Z",  "test": true,  "account_id": "AB1234",  "name": "Widget Pro keys",  "label": "License Code",  "description": null,  "instructions": "Open Widget Pro, choose Help, then Enter License, and paste the code.",  "type": "remote_url",  "expand": null,  "show": null,  "hide": null,  "configuration": {    "url": "https://licenses.example.com/issue",    "format": "json",    "http_authorization_username": null,    "http_authorization_password": null,    "custom_header_name": null,    "custom_header_value": null  }}

List license services GET

Returns your license services, oldest first unless you choose another `sort_by`. For `list` services, only the first 15 keys of a long list come back here; read the service itself for all of them. Secret and trusted tokens may call it.

Get a license service GET

Returns one license service, with every key of a `list` service. Secret and trusted tokens may call it.