Skip to main content
POST
Create a new license for a user

Authorizations

Authorization
string
header
required

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

Body

application/json
subscription_id
string
required
license_type_id
string
required
external_license_id
string
required

The external identifier for the license.

start_date
string<date> | null

The start date of the license. If not provided, defaults to start of day today in the customer's timezone.

Example:

"2026-01-27"

end_date
string<date> | null

The end date of the license. If not provided, the license will remain active until deactivated.

Example:

"2026-01-27"

Response

Created

id
string
required
subscription_id
string
required
license_type_id
string
required
external_license_id
string
required
status
enum<string>
required
Available options:
active,
inactive
start_date
string<date-time>
required
end_date
string<date-time> | null
required