Skip to main content

Retrieve the subscription information

Contributors

GET /license/subscriptions/account/{accountId}

Retrieves the subscription information of a specified account ID.

Note:

  • If entitlements are provided, the API endpoint also returns the entitlements related to each subscription.

  • If serviceName is provided, the API returns only the subscription related to the service name.

  • The API authorizes two types of calls: user calls and service calls (with a predefined scope).
    For KEYSTONE, only user calls are allowed.


Token usage: Either a BlueXP user token or service token.

Parameters

Name Type In Required Description

serviceName

string

query

False

entitlements

boolean

query

False

subscriptionId

string

query

False

dimensions

boolean

query

False

cloudProvider

string

query

False

extendSubInfo

boolean

query

False

extendEntitlementsInfo

boolean

query

False

accountId

string

path

True

X-Service-Request-Id

string

header

False

Request identifier

Response

Status: 200, Default 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"
}