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 | SubscriptionDto | - |
| 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 of the subscription in |
| endTime | string | The end date of the subscription in |
| account | SubscriptionAccountDto | - |
| budget | SubscriptionBudgetDto | - |
| currentPeriod | SubscriptionCurrentPeriodDto | - |
| periods | SubscriptionPeriodDto[] | A list of period data of the subscription. |
| capabilities | SubscriptionCapabilityDto[] | 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 date in |
| endTime | string | The current period end date 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
1{2 "uuid": "string",3 "type": "string",4 "name": "string",5 "status": "string",6 "startTime": "string",7 "endTime": "string",8 "account": {9 "uuid": "string"10 },11 "budget": {12 "total": 1,13 "used": 1,14 "currencyCode": "string"15 },16 "currentPeriod": {17 "startTime": "string",18 "endTime": "string",19 "daysRemaining": 120 },21 "periods": [22 {23 "startTime": "string",24 "endTime": "string"25 }26 ],27 "capabilities": [28 {29 "key": "string",30 "name": "string"31 }32 ]33}