Appearance

Licenses Object ​


id
string
REQUIRED · 

Unique identifier for the license.

name
string

Name of the license.

description
string

Description for the license.

available_quantity
number

Total number of licenses that can be assigned to users.

assigned_quantity
number

Number of licenses that have been assigned to users.

unit_amount
number

Unit amount for the license.

roles
object[]

Valid Roles for the license.

id
string

Unique identifier for the role.

name
string

Name of the role.

is_paid
boolean

Whether the license is paid or not.

currency
string

Currency for the license.

status
string

Status for the license

All possible enum values:
  • active
  • inactive
products
object[]

The products that are part of the license.

id
string

Unique identifier for the product

name
string

The name of product

status
string

Status for the product within the license. Usually denotes the provisioning status.

All possible enum values:
  • active
  • inactive
  • errored
  • needs_input
  • needs_confirmation
  • pending
created_at
string · date-time

Date and time when the license was created.

updated_at
string · date-time

Date and time when the license was last updated.

remote_data
object

Raw data returned from the remote API call.