Skip to main content

Retrieve subscription information using the subscription ID

GET /license/subscriptions/subscription

Retrieves the subscription information for a specified subscription ID.

Note:

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


Token usage: NetApp Console 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

entitlements

False

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

string

False

endDate

["null", "integer"]

False

term

["null", "string"]

False

isPrivate

["null", "boolean"]

False

listingUrl

["null", "string"]

False

productTitle

["null", "string"]

False

cloudIds

array[string]

False

availableDimensions

array[string]

False

configuration

string

False

events

events

False
Example response 
{
  "accounts": [
    "account-sdajkj5",
    "account-euir74j"
  ],
  "createdAt": 1556636730921,
  "cloudProvider": "aws",
  "entitlements": {
    "items": [
      {
        "contractOption": "Professional",
        "units": "12 TiB",
        "expirationDate": "2026-07-02T00:00:00Z",
        "details": "High Availability + Unlimited Cloud Backup",
        "category": "Cloud Volumes ONTAP",
        "dimension": "tier12",
        "IntegerValue": 1,
        "usageReport": 12,
        "unit": "TiB",
        "serviceName": "CVO"
      }
    ]
  },
  "dimensions": [
    "professional"
  ],
  "contract": false,
  "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": true,
  "listingUrl": "https://marketplace-fake-url.com",
  "productTitle": "Cloud Manager - Deploy & Manage Netapp Cloud Data Service",
  "cloudIds": [
    "0ae5-rew5-ttt1-4563"
  ],
  "availableDimensions": [
    "ransomware_resilience"
  ],
  "configuration": "string",
  "events": {
    "endDateEvent": {
      "type": "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

items

Name Type Required Description

contractOption

string

False

units

string

False

expirationDate

string

False

details

string

False

category

string

False

  • example: Cloud Volumes ONTAP

dimension

string

False

IntegerValue

integer

False

usageReport

integer

False

unit

string

False

serviceName

string

False

entitlements

Name Type Required Description

items

array[items]

False

endDateEvent

Name Type Required Description

type

string

False

subscriptionExpirationInDays

integer

False

events

Name Type Required Description

endDateEvent

endDateEvent

False