Dynatrace Platform Subscription API - GET a subscription

  • Latest Dynatrace
  • Reference
  • Published Mar 30, 2023

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 OAuth clients.

Parameters

ParameterTypeDescriptionInRequired
accountUuidstring

The ID of the required account.

You can find the UUID on the Account Management > Identity & access management > OAuth clients page, during creation of an OAuth client.

pathrequired
subscriptionUuidstring

The UUID of the requested subscription.

Fetch the list of subscriptions via the GET all subscriptions request.

pathrequired

Response

Response codes

CodeTypeDescription
200SubscriptionDto

Success. The response contains the details of the subscription.

400-

Failed. The request was unacceptable, often due to missing a required parameter

401-

Failed. The bearer token is incorrect/expired or the requested account information does not match the bearer token

403-

Access denied

404-

Failed. The requested resource was not found

500-

Failed. Something went wrong in Account Management API

Response body objects

The SubscriptionDto object

ElementTypeDescription
uuidstring

The UUID of the Dynatrace Platform Subscription.

typestring

The type of the Dynatrace Platform Subscription.

subTypestring

The sub-type of the Dynatrace Platform Subscription.

namestring

The display name of the Dynatrace Platform Subscription.

statusstring

The status of the Dynatrace Platform Subscription.

startTimestring

The start date of the subscription in 2021-05-01 format.

endTimestring

The end date of the subscription in 2021-05-01 format.

accountSubscriptionAccountDto

The account associated with the subscription.

budgetSubscriptionBudgetDto

The budget associated with the subscription.

currentPeriodSubscriptionCurrentPeriodDto

The current period associated with the subscription.

periodsSubscriptionPeriodDto[]

A list of subscription periods.

capabilitiesSubscriptionCapabilityDto[]

A list of subscription capabilities.

The SubscriptionAccountDto object

ElementTypeDescription
uuidstring

The UUID of the account.

The SubscriptionBudgetDto object

ElementTypeDescription
totalnumber

The total budget of the subscription.

usednumber

The used budget of the subscription.

currencyCodestring

The currency of the subscription.

The SubscriptionCurrentPeriodDto object

ElementTypeDescription
startTimestring

The current period start date in 2021-05-01 format.

endTimestring

The current period end date in 2021-05-01 format.

daysRemainingnumber

Remaining days 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 key of the subscription capability.

namestring

The display name of the subscription capability.

Response body JSON model

{
  "uuid": "string",
  "type": "string",
  "subType": "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"
    }
  ]
}