Skip to main content

Retrieve subscription information

Contributors

GET /license/account/{accountId}/subscriptions

Retrieves the subscription information of a specified subscription.

Note:

  • In the context of an account provided in URL parameters, the API returns subscriptions of all accounts

  • If the subscription ID is provided, the API returns only the subscription details or an empty response

  • The API authorizes three types of calls: user call, agent call (BlueXP Connector), and service call (with a predefined scope)

  • For a service call, you must send the subscription type as a query parameter (the API validates the scope against the subscription type)

Token usage: BlueXP service token.

Parameters

Name Type In Required Description

subscriptionId

string

query

False

subscriptionType

string

query

False

accountId

string

path

True

X-Service-Request-Id

string

header

False

Request identifier

Response

Status: 200, Default Response
Name Type Required Description

subscriptions

array[subscriptions]

False
Example response 
{
  "subscriptions": [
    {
      "subscriptionId": "string",
      "subscriptionType": "string"
    }
  ]
}

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

subscriptions

Name Type Required Description

subscriptionId

string

False

subscriptionType

string

False

expirationDate

integer

False

numberOfAssociatedCvos

integer

False

lastModified

integer

False