• Home
  • API
  • Account management
  • Dynatrace Platform Subscription
  • Subscriptions
  • GET a subscription

Dynatrace Platform Subscription API - GET a subscription

Gets detailed information about a Dynatrace Platform Subscription.

The request produces an application/json payload.

GET

https://api.dynatrace.com/sub/v2/accounts/{accountUuid}/subscriptions/{subscriptionUuid}

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

ParameterTypeDescriptionInRequired
accountUuidstring

The ID of the required account.

You can find the UUID on the Account > Account management API page, during creation of an OAuth client.

pathrequired
subscriptionUuidstring

The UUID of the requested subscription

pathrequired

Response

Response codes

CodeTypeDescription
200SubscriptionDto-
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

ElementTypeDescription
uuidstring

The UUID of the Dynatrace Platform Subscription.

typestring

The type of the Dynatrace Platform Subscription.

namestring

The name of the Dynatrace Platform Subscription.

statusstring

The status of the Dynatrace Platform Subscription.

startTimestring

The start date and time of the subscription in 2021-05-01T15:11:00Z format.

endTimestring

The end date and time of the subscription in 2021-05-01T15:11:00Z format.

accountSubscriptionAccountDto-
budgetSubscriptionBudgetDto-
currentPeriodSubscriptionCurrentPeriodDto-
periodsSubscriptionPeriodDto[]

A list of period data of the subscription.

capabilitiesSubscriptionCapabilityDto[]

A list of subscription capabilities.

The SubscriptionAccountDto object

ElementTypeDescription
uuidstring

The UUID of the account

The SubscriptionBudgetDto object

ElementTypeDescription
totalnumber

The total budget for the subscription

usednumber

The total budget used for the subscription

currencyCodestring

The currency code for the subscription

The SubscriptionCurrentPeriodDto object

ElementTypeDescription
startTimestring

The current period start time in 2021-05-01T15:11:00Z format.

endTimestring

The current period end time in 2021-05-01T15:11:00Z format.

daysRemainingnumber

Days remaining in the current period

The SubscriptionPeriodDto object

ElementTypeDescription
startTimestring

The subscription period start time in 2021-05-01T15:11:00Z format.

endTimestring

The subscription period end time in 2021-05-01T15:11:00Z format.

The SubscriptionCapabilityDto object

ElementTypeDescription
keystring

The subscription capability key

namestring

The subscription capability name

Response body JSON model

json
{ "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" } ] }