Dynatrace Platform Subscription API - GET a subscription
Gets detailed information about a Dynatrace Platform Subscription.
The request produces an application/json payload.
GET |
|
Authentication
To execute this request, you need the Allow read access for usage and consumption resources (account-uac-read) scope assigned to your token. To learn how to obtain and use it, see Authentication.
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| accountUuid | string | The ID of the required account. You can find the UUID on the Account > Account management API page, during creation of an OAuth client. | path | required |
| subscriptionUuid | string | The UUID of the requested subscription | path | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Subscription | - |
| 400 | The request was unacceptable, often due to missing a required parameter | |
| 401 | The bearer token is incorrect/expired or the requested account information does not match the bearer token | |
| 403 | Access denied | |
| 404 | The requested resource was not found | |
| 500 | Something went wrong on Account Management API's end |
Response body objects
The SubscriptionDto object
| Element | Type | Description |
|---|---|---|
| uuid | string | The UUID of the Dynatrace Platform Subscription. |
| type | string | The type of the Dynatrace Platform Subscription. |
| name | string | The name of the Dynatrace Platform Subscription. |
| status | string | The status of the Dynatrace Platform Subscription. |
| startTime | string | The start date and time of the subscription in |
| endTime | string | The end date and time of the subscription in |
| account | Subscription | - |
| budget | Subscription | - |
| currentPeriod | Subscription | - |
| periods | Subscription | A list of period data of the subscription. |
| capabilities | Subscription | A list of subscription capabilities. |
The SubscriptionAccountDto object
| Element | Type | Description |
|---|---|---|
| uuid | string | The UUID of the account |
The SubscriptionBudgetDto object
| Element | Type | Description |
|---|---|---|
| total | number | The total budget for the subscription |
| used | number | The total budget used for the subscription |
| currencyCode | string | The currency code for the subscription |
The SubscriptionCurrentPeriodDto object
| Element | Type | Description |
|---|---|---|
| startTime | string | The current period start time in |
| endTime | string | The current period end time in |
| daysRemaining | number | Days remaining in the current period |
The SubscriptionPeriodDto object
| Element | Type | Description |
|---|---|---|
| startTime | string | The subscription period start time in |
| endTime | string | The subscription period end time in |
The SubscriptionCapabilityDto object
| Element | Type | Description |
|---|---|---|
| key | string | The subscription capability key |
| name | string | The subscription capability name |
Response body JSON model
{
"uuid": "string",
"type": "string",
"name": "string",
"status": "string",
"startTime": "string",
"endTime": "string",
"account": {
"uuid": "string"
},
"budget": {
"total": 1,
"used": 1,
"currencyCode": "string"
},
"currentPeriod": {
"startTime": "string",
"endTime": "string",
"daysRemaining": 1
},
"periods": [
{
"startTime": "string",
"endTime": "string"
}
],
"capabilities": [
{
"key": "string",
"name": "string"
}
]
}