Skip to content
MonetizeIt MonetizeIt Docs

AddEntitlement

POST
/api/v1/provision/admin/entitlements
 
curl --request POST \
  --url https://api.monetizeit.example/api/v1/provision/admin/entitlements \
  --header 'Content-Type: application/json-patch+json' \
  --data '{ "customerContactEmail": "example", "customerContactName": "example", "legalNoticeHtml": "example", "description": "example", "name": "example", "version": "example", "isTrial": true, "isRevoked": true, "isTemplateForNewEntitlements": true, "customerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "orderId": "example", "reference": "example", "licenseKey": "example" }'

Authorizations

Section titled “Authorizations ”
  • oidc
    email profile roles

Request Body

Section titled “Request Body ”
object
customerContactEmail
string
customerContactName
string
legalNoticeHtml
string
description
string
name
string
version
string
isTrial
boolean
isRevoked
boolean
isTemplateForNewEntitlements
boolean
customerId
string format: uuid
orderId
string
reference
string
licenseKey
string
Example generated
{
  "customerContactEmail": "example",
  "customerContactName": "example",
  "legalNoticeHtml": "example",
  "description": "example",
  "name": "example",
  "version": "example",
  "isTrial": true,
  "isRevoked": true,
  "isTemplateForNewEntitlements": true,
  "customerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "orderId": "example",
  "reference": "example",
  "licenseKey": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

object
legalNoticeHtml
string
description
string
name
string
version
string
customerContactEmail
string
customerContactName
string
allowLicenseActivation
boolean
licenseKey
string
expirationDateTime
string format: date-time
isEntitlementTrial
boolean
isRevoked
boolean
id
string format: uuid
isTemplateForNewEntitlements
boolean
products
Array<object>
object
id
string format: uuid
status
integer format: int32
Allowed values: 0 1 2 3 4 5 6 7
providerId
string format: uuid
name
string
description
string
productCode
string
productVersion
string
expirationDate
string format: date-time
externalId
string
features
Array<object>
object
id
string format: uuid
featureCode
string
featurePath
string
moduleName
string
name
string
description
string
value
string
version
string
isEnabled
boolean
isAvailableDuringTrialPeriod
boolean
isAvailableDuringGracePeriod
boolean
canModifyValueOnEntitlement
boolean
isDeleted
boolean
creationTimeStamp
string format: date-time
lastUpdateTimeStamp
string format: date-time
revisionNumber
integer format: int32
monitoredAssets
Array<object>
object
id
string format: uuid
entitlementId
string format: uuid
productId
string format: uuid
metricName
string
name
string
description
string
unit
string
category
string
numberFormat
string
metricType
integer format: int32
Allowed values: 0 1 2
meteredUsageId
string format: uuid
meteredUsage
object
id
string format: uuid
suspendUntilTimeStamp
string format: date-time
lastReportedOverageSeverityStatus
integer format: int32
Allowed values: 0 1 2 3 4
usageTiers
Array<object>
object
startUsage
number format: double
endUsage
number format: double
baseCredits
number format: double
creditsPerUnitOfConsumption
number format: double
name
string
quotaUsageLevel
integer format: int32
Allowed values: 0 1 2 3 4
quotaUsagePolicy
integer format: int32
Allowed values: 0 1 2 3
consumptionPeriod
string
accumulationMethod
integer format: int32
Allowed values: 0 1
balanceUsageId
string format: uuid
balanceUsage
object
id
string format: uuid
name
string
description
string
creditsUsed
number format: double
totalCredits
number format: double
cumulativeCreditsUsed
number format: double
unit
string
numberFormat
string
lastDeposit
string format: date-time
usageQuota
Array<object>
object
endUsage
number format: double
name
string
quotaUsageLevel
integer format: int32
Allowed values: 0 1 2 3
suspendUntilTimeStamp
string format: date-time
overageSeverityStatus
integer format: int32
Allowed values: 0 1 2 3
initialCreditAmount
number format: double
isUnlimitedCredits
boolean
autoBalanceCronSchedule
string
lastAutoBalanceDate
string format: date-time
shouldAutoBalanceTransferCurrentCredits
boolean
maxAutoBalanceCreditTransferAmount
number format: double
autoBalanceCreditAmount
number format: double
allowedBackDatingTolerance
string format: date-span
productInformation
object
displayVersion
string
additionalInformation
string
revisionInformation
string
downloadUrl
string
informationUrl
string
supportUrl
string
propertyValues
object
key
additional properties
object
key
string
value
string
metadata
Array<object>
object
key
string
value
string
isDeleted
boolean
createdAt
string format: date-time
updatedAt
string format: date-time
revisionNumber
integer format: int32
isLocked
boolean
productMetaData
string
productLicenseData
string
features
Array<object>
object
id
string format: uuid
featureCode
string
productId
string format: uuid
moduleName
string
featurePath
string
name
string
description
string
value
string
version
string
isEnabled
boolean
isAvailableDuringTrialPeriod
boolean
isAvailableDuringGracePeriod
boolean
canModifyValueOnEntitlement
boolean
meteredAssetId
string format: uuid
featureExpiration
string format: date-time
createdAt
string format: date-time
updatedAt
string format: date-time
customerId
string format: uuid
activationPolicy
object
requiredAuthenticationLevel
integer format: int32
Allowed values: 1 2 3
requireNewUserVerification
boolean
requireProductCode
boolean
requireActivationWorkflow
boolean
requireOrganizationGroupMember
string format: uuid
requireAclHostNameMember
Array<string>
claimBasedActivation
object
leaseTime
string format: date-span
gracePeriod
string format: date-span
numberOfSeats
integer format: int32
isFloatingLicense
boolean
allowOffLineUse
boolean
isTransferableLicense
boolean
fingerprintingMethod
string
timeRestrictedActivationPolicy
object
notValidBeforeTimestamp
string format: date-time
notValidAfterTimestamp
string format: date-time
activationPeriod
string format: date-span
trialActivationPolicy
object
trialPeriod
string format: date-span
cannotActivateBeforeTimestamp
string format: date-time
notValidAfterTimestamp
string format: date-time
trialEndsAt
string format: date-time
trialPeriodStartsAfterFirstActivation
boolean
subscriptionPolicy
object
renewPeriod
string
renewInterval
integer format: int32
cannotActivateBeforeTimestamp
string format: date-time
notValidAfterTimestamp
string format: date-time
isSubscriptionActive
boolean
subscriptionPeriodsLeft
integer format: int32
softEnforcement
boolean
nextRenewalTimeStamp
string format: date-time
orderId
string
reference
string