v1

latestOpenAPI 3.1.02026-07-261444991.2 MB
License

Create a new license for a user

This endpoint is used to create a new license for a user.

If a start date is provided, the license will be activated at the start of the specified date in the customer's timezone. Otherwise, the activation time will default to the start of the current day in the customer's timezone.

post/licenses

Request body

subscription_idstring required
license_type_idstring required
external_license_idstring required

The external identifier for the license.

start_datestring date nullable

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

end_datestring date nullable

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

Example request

{
  "start_date": "2026-01-27",
  "end_date": "2026-01-27"
}

Response

Created

idstring required
subscription_idstring required
license_type_idstring required
external_license_idstring required
status'active' | 'inactive' required
start_datestring date-time required
end_datestring date-time nullable required