License object

Internal license object with comprehensive feature and administrative details

name

string

Name of the license.

productId

string

Product ID of the license. This is ID of Product Stripe see this link for full documentation of Product Stripe https://stripe.com/docs/api/products/object

rule

object

Show child attributes

rule.taskLimit

string

Task limit per month.

rule.allowExtraTask

boolean

Flag to indicate if extra tasks are allowed.

rule.visitLimit

string

Routing limit per month.

rule.allowExtraVisit

boolean

Flag to indicate if extra visits are allowed.

rule.automationLimit

string

Automation limit per month.

rule.allowExtraAutomation

boolean

Flag to indicate if extra automations are allowed.

rule.userLimit

integer

User limit.

rule.allowExtraUser

boolean

Flag to indicate if extra users are allowed.

rule.dataRetention

string

Data retention period.

rule.customRole

string

Custom role value.

rule.teams

boolean

Flag to indicate if teams are allowed.

rule.imageQuality

string

Image quality setting.

rule.dataSourceTypeLimit

string

Data source type limit.

rule.allowExtraDataSourceType

boolean

Flag to indicate if extra data source types are allowed.

rule.sla

boolean

Flag to indicate if SLA is included.

rule.sso

boolean

Flag to indicate if SSO is included.

rule.privacyPolicy

string

rule.useBigData

boolean

Flag to indicate if Big Data access is included.

rule.professionalService

boolean

Flag to indicate if professional services are included.

rule.minimumContract

string

Minimum contract setting.

inputType

string

The input type of the component (e.g., string, number, date, etc.)

description

string

billingPeriod

string

Billing period of the license.

orderIndex

integer

Order index of the license.

items

object[]

Show child attributes

items.priceId

string

Price ID of the item. This is ID of Product Price Stripe see this link for full documentation of Product Stripe https://stripe.com/docs/api/prices/object

items.name

string

Name of the item.

items.mainPrice

integer

Main price of the item.

items.extraPrice

integer

Extra price of the item.

feature

object

Show child attributes

feature.taskLimit

object

Show child attributes

feature.taskLimit.title

string

Title of the feature item.

feature.taskLimit.value

Value of the feature item.

feature.taskLimit.description

string

feature.taskLimit.textValue

string

Text representation of the feature value.

feature.taskLimit.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.visitLimit

object

Show child attributes

feature.visitLimit.title

string

Title of the feature item.

feature.visitLimit.value

Value of the feature item.

feature.visitLimit.description

string

feature.visitLimit.textValue

string

Text representation of the feature value.

feature.visitLimit.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.automationLimit

object

Show child attributes

feature.automationLimit.title

string

Title of the feature item.

feature.automationLimit.value

Value of the feature item.

feature.automationLimit.description

string

feature.automationLimit.textValue

string

Text representation of the feature value.

feature.automationLimit.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.userLimit

object

Show child attributes

feature.userLimit.title

string

Title of the feature item.

feature.userLimit.value

Value of the feature item.

feature.userLimit.description

string

feature.userLimit.textValue

string

Text representation of the feature value.

feature.userLimit.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.dataRetention

object

Show child attributes

feature.dataRetention.title

string

Title of the feature item.

feature.dataRetention.value

Value of the feature item.

feature.dataRetention.description

string

feature.dataRetention.textValue

string

Text representation of the feature value.

feature.dataRetention.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.customRole

object

Show child attributes

feature.customRole.title

string

Title of the feature item.

feature.customRole.value

Value of the feature item.

feature.customRole.description

string

feature.customRole.textValue

string

Text representation of the feature value.

feature.customRole.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.teams

object

Show child attributes

feature.teams.title

string

Title of the feature item.

feature.teams.value

Value of the feature item.

feature.teams.description

string

feature.teams.textValue

string

Text representation of the feature value.

feature.teams.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.imageQuality

object

Show child attributes

feature.imageQuality.title

string

Title of the feature item.

feature.imageQuality.value

Value of the feature item.

feature.imageQuality.description

string

feature.imageQuality.textValue

string

Text representation of the feature value.

feature.imageQuality.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.dataSourceTypeLimit

object

Show child attributes

feature.dataSourceTypeLimit.title

string

Title of the feature item.

feature.dataSourceTypeLimit.value

Value of the feature item.

feature.dataSourceTypeLimit.description

string

feature.dataSourceTypeLimit.textValue

string

Text representation of the feature value.

feature.dataSourceTypeLimit.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.sla

object

Show child attributes

feature.sla.title

string

Title of the feature item.

feature.sla.value

Value of the feature item.

feature.sla.description

string

feature.sla.textValue

string

Text representation of the feature value.

feature.sla.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.sso

object

Show child attributes

feature.sso.title

string

Title of the feature item.

feature.sso.value

Value of the feature item.

feature.sso.description

string

feature.sso.textValue

string

Text representation of the feature value.

feature.sso.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.privacyPolicy

object

Show child attributes

feature.privacyPolicy.title

string

Title of the feature item.

feature.privacyPolicy.value

Value of the feature item.

feature.privacyPolicy.description

string

feature.privacyPolicy.textValue

string

Text representation of the feature value.

feature.privacyPolicy.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.useBigData

object

Show child attributes

feature.useBigData.title

string

Title of the feature item.

feature.useBigData.value

Value of the feature item.

feature.useBigData.description

string

feature.useBigData.textValue

string

Text representation of the feature value.

feature.useBigData.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.professionalService

object

Show child attributes

feature.professionalService.title

string

Title of the feature item.

feature.professionalService.value

Value of the feature item.

feature.professionalService.description

string

feature.professionalService.textValue

string

Text representation of the feature value.

feature.professionalService.allowExtra

boolean

Flag to indicate if extra is allowed.

feature.minimumContract

object

Show child attributes

feature.minimumContract.title

string

Title of the feature item.

feature.minimumContract.value

Value of the feature item.

feature.minimumContract.description

string

feature.minimumContract.textValue

string

Text representation of the feature value.

feature.minimumContract.allowExtra

boolean

Flag to indicate if extra is allowed.

failedCode

enum<string>

License Module business failedCode that indicate specific failure conditions or business rule violations during license module operations. These codes help identify the failed operation of license-related and provide standardized failure identification across the system.

Possible values:

lcns-032: Invalid state/condition - License state invalid
lcns-033: License not found - License record does not exist
lcns-035: Access forbidden - User lacks license permission
lcns-036: Organization not verified - Organization verification required
lcns-037: Invalid license type - License type not recognized
lcns-042: Feature not available - Feature not in license plan
lcns-043: License/subscription error - General license error
lcns-045: Server error - Internal server failure

Available options:

lcns-032,

lcns-033,

lcns-035,

lcns-036,

lcns-037,

lcns-042,

lcns-043,

lcns-045

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

File

Billing

Dashboard

Authentication

Reference

Internal Tools

Objects