Create license type

This endpoint is used to create a new license type.

License types are used to group licenses and define billing behavior. Each license type has a name and a grouping key that determines how metrics are aggregated for billing purposes.

POST /license_types

Create license type

cURL

curl --request POST \
  --url https://api.withorb.com/v1/license_types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "grouping_key": "<string>"
}
'

201

{
  "id": "<string>",
  "name": "<string>",
  "grouping_key": "<string>"
}

Authorizations

Authorization · string · header · required

API Keys can be issued in the Orb's web application.

Body

application/json

name · string · required

The name of the license type.

Minimum string length: 1

grouping_key · string · required

The key used for grouping licenses of this type. This is typically a user identifier field.

Minimum string length: 1

Response

201

application/json

Created

The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key.

id · string · required

The Orb-assigned unique identifier for the license type.

name · string · required

The name of the license type.

grouping_key · string · required

The key used for grouping licenses of this type. This is typically a user identifier field.