Skip to main content

Retrieve the subscription entitlements

Contributors

GET /license/subscriptions/entitlements

Retrieves the subscription entitlements information of a specified service name.

Note:

  • This API authorizes service calls (with a predefined scope) only.


Token usage: BlueXP service token with the following scopes: %scopes%.

Parameters

Name Type In Required Description

serviceName

string

query

True

X-Service-Request-Id

string

header

False

Request identifier

Response

Status: 200, Default Response

List of response

Response

Status: 4xx, Error response
Name Type Required Description

errorCode

string

False

error code

error

string

False

Error code/category

message

string

False

Error description message
Example response 
{
  "errorCode": "string",
  "error": "string",
  "message": "string"
}

Definitions

See Definitions

Value

Name Type Required Description

IntegerValue

integer

False

entitlements

Name Type Required Description

CustomerIdentifier

string

False

Dimension

string

False

ExpirationDate

string

False

ProductCode

string

False

Value

Value

False

response

Name Type Required Description

entitlements

array[entitlements]

False

productCode

string

False

error

string

False