Skip to main content

Retrieve subscription information

Contributors

GET /license/subscriptions/subscription

Retrieves the subscription information of a specified subscription ID.

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

subscriptionId

string

query

True

X-Service-Request-Id

string

header

False

Request identifier

Response

Status: 200, Default Response
Name Type Required Description

accounts

array[string]

False

createdAt

integer

False

cloudProvider

string

False

entitlements

["object", "object"]

False

  • oneOf: [{"type"=>"object", "properties"=>{"items"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"dimension"=>{"type"=>"string", "example"=>"tier12"}, "IntegerValue"=>{"type"=>"integer", "example"=>1}, "expirationDate"=>{"type"=>"string", "example"=>"2026-07-02T00:00:00Z"}}}}}}, {"type"=>"object", "properties"=>{"items"=>{"type"=>"array", "items"=>{"type"=>"object", "properties"=>{"contractOption"=>{"type"=>"string", "example"=>"Professional"}, "units"=>{"type"=>"string", "example"=>"12 TiB"}, "expirationDate"=>{"type"=>"string", "example"=>"2026-07-02T00:00:00Z"}, "details"=>{"type"=>"string", "example"=>"High Availability + Unlimited Cloud Backup"}, "category"=>{"type"=>"string", "example"=>"Cloud Volumes ONTAP"}}}}}}]

dimensions

array[string]

False

contract

boolean

False

customerIdentifier

string

False

productCode

string

False

planId

string

False

serviceName

string

False

subscriptionId

string

False

subscriptionName

string

False

subscriptionStatus

string

False

autoRenew

False

endDate

integer

False

term

string

False

isPrivate

boolean

False

listingUrl

string

False

productTitle

string

False
Example response 
{
  "accounts": [
    "account-sdajkj5",
    "account-euir74j"
  ],
  "createdAt": 1556636730921,
  "cloudProvider": "aws",
  "dimensions": [
    "professional"
  ],
  "contract": "",
  "customerIdentifier": "FJsUvVHffi9",
  "productCode": "1ajwvb3kjavjlk36izcn19e07",
  "planId": "paygo_example",
  "serviceName": "cloud-volumes-ontap",
  "subscriptionId": "aws-abcd-1234",
  "subscriptionName": "My Prod CVO subscription",
  "subscriptionStatus": "subscribed",
  "autoRenew": "N/A",
  "endDate": 1556636730921,
  "term": "12 Months",
  "isPrivate": 1,
  "listingUrl": "https://marketplace-fake-url.com",
  "productTitle": "Cloud Manger - Deploy & Manage Netapp Cloud Data Service"
}

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"
}