Usage Details - List

Lists the usage details for the defined scope. Usage details are available via this API only for May 1, 2014 or later.

GET https://management.azure.com/{scope}/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01
GET https://management.azure.com/{scope}/providers/Microsoft.Consumption/usageDetails?$expand={$expand}&$filter={$filter}&$skiptoken={$skiptoken}&$top={$top}&api-version=2019-05-01&metric={metric}

URI Parameters

Name In Required Type Description
scope
path True
  • string

The scope associated with usage details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope. For subscription, billing account, department, enrollment account and management group, you can also add billing period to the scope using '/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'. For e.g. to specify billing period at department scope use '/providers/Microsoft.Billing/departments/{departmentId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}'

$expand
query
  • string

May be used to expand the properties/additionalInfo or properties/meterDetails within a list of usage details. By default, these fields are not included when listing usage details.

$filter
query
  • string

May be used to filter usageDetails by properties/resourceGroup, properties/resourceName, properties/resourceId, properties/chargeType, properties/reservationId, properties/publisherType or tags. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value is separated by a colon (:). PublisherType Filter accepts two values azure and marketplace and it is currently supported for Web Direct Offer Type

$skiptoken
query
  • string

Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.

$top
query
  • integer

May be used to limit the number of results to the most recent N usageDetails.

api-version
query True
  • string

Version of the API to be used with the client request. The current version is 2019-05-01.

metric
query

Allows to select different type of cost/usage records.

Responses

Name Type Description
200 OK

OK. The request has succeeded.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

BillingAccountUsageDetailsList
BillingAccountUsageDetailsListForBillingPeriod
DepartmentUsageDetailsList
DepartmentUsageDetailsListForBillingPeriod
EnrollmentAccountUsageDetailsList
EnrollmentAccountUsageDetailsListForBillingPeriod
ManagementGroupUsageDetailsList
ManagementGroupUsageDetailsListForBillingPeriod
UsageDetailsExpand
UsageDetailsList
UsageDetailsListByMetricActualCost
UsageDetailsListByMetricAmortizedCost
UsageDetailsListByMetricUsage
UsageDetailsListFilterByTag
UsageDetailsListForBillingPeriod

BillingAccountUsageDetailsList

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01

Sample Response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Account Name 1",
        "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Account Name 1",
        "accountName": "Account Name 1",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "Subscription Name 1",
        "date": "2019-03-30T00:00:00.0000000Z",
        "product": "Product Name 1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 0.7329,
        "effectivePrice": 0.000402776395232,
        "cost": 0.000295194820065,
        "unitPrice": 4.38,
        "billingCurrency": "CAD",
        "resourceLocation": "USEast",
        "consumedService": "Microsoft.Storage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1",
        "resourceName": "Resource Name 1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "DEV",
        "resourceGroup": "Resource Group 1",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage"
      }
    }
  ]
}

BillingAccountUsageDetailsListForBillingPeriod

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01

Sample Response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/BillingAccounts/1234/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Account Name 1",
        "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Account Name 1",
        "accountName": "Account Name 1",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "Subscription Name 1",
        "date": "2019-03-30T00:00:00.0000000Z",
        "product": "Product Name 1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 0.8234,
        "effectivePrice": 0.010534556373432,
        "cost": 0.000342194841184,
        "unitPrice": 3.74,
        "billingCurrency": "CAD",
        "resourceLocation": "USEast",
        "consumedService": "Microsoft.Storage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1",
        "resourceName": "Resource Name 1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "DEV",
        "resourceGroup": "Resource Group 1",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage"
      }
    }
  ]
}

DepartmentUsageDetailsList

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01

Sample Response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Account Name 1",
        "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Account Name 1",
        "accountName": "Account Name 1",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "Subscription Name 1",
        "date": "2019-03-30T00:00:00.0000000Z",
        "product": "Product Name 1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 0.7329,
        "effectivePrice": 0.000402776395232,
        "cost": 0.000295194820065,
        "unitPrice": 4.38,
        "billingCurrency": "CAD",
        "resourceLocation": "USEast",
        "consumedService": "Microsoft.Storage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1",
        "resourceName": "Resource Name 1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "DEV",
        "resourceGroup": "Resource Group 1",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage"
      }
    }
  ]
}

DepartmentUsageDetailsListForBillingPeriod

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01

Sample Response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/Departments/1234/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Account Name 1",
        "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Account Name 1",
        "accountName": "Account Name 1",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "Subscription Name 1",
        "date": "2019-03-30T00:00:00.0000000Z",
        "product": "Product Name 1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 0.8234,
        "effectivePrice": 0.010534556373432,
        "cost": 0.000342194841184,
        "unitPrice": 3.74,
        "billingCurrency": "CAD",
        "resourceLocation": "USEast",
        "consumedService": "Microsoft.Storage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1",
        "resourceName": "Resource Name 1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "DEV",
        "resourceGroup": "Resource Group 1",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage"
      }
    }
  ]
}

EnrollmentAccountUsageDetailsList

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01

Sample Response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Account Name 1",
        "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Account Name 1",
        "accountName": "Account Name 1",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "Subscription Name 1",
        "date": "2019-03-30T00:00:00.0000000Z",
        "product": "Product Name 1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 0.7329,
        "effectivePrice": 0.000402776395232,
        "cost": 0.000295194820065,
        "unitPrice": 4.38,
        "billingCurrency": "CAD",
        "resourceLocation": "USEast",
        "consumedService": "Microsoft.Storage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1",
        "resourceName": "Resource Name 1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "DEV",
        "resourceGroup": "Resource Group 1",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage"
      }
    }
  ]
}

EnrollmentAccountUsageDetailsListForBillingPeriod

Sample Request

GET https://management.azure.com/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01

Sample Response

{
  "value": [
    {
      "id": "/providers/Microsoft.Billing/EnrollmentAccounts/1234/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Account Name 1",
        "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Account Name 1",
        "accountName": "Account Name 1",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "Subscription Name 1",
        "date": "2019-03-30T00:00:00.0000000Z",
        "product": "Product Name 1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 0.8234,
        "effectivePrice": 0.010534556373432,
        "cost": 0.000342194841184,
        "unitPrice": 3.74,
        "billingCurrency": "CAD",
        "resourceLocation": "USEast",
        "consumedService": "Microsoft.Storage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1",
        "resourceName": "Resource Name 1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "DEV",
        "resourceGroup": "Resource Group 1",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage"
      }
    }
  ]
}

ManagementGroupUsageDetailsList

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Account Name 1",
        "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Account Name 1",
        "accountName": "Account Name 1",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "Subscription Name 1",
        "date": "2019-03-30T00:00:00.0000000Z",
        "product": "Product Name 1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 0.8234,
        "effectivePrice": 0.010534556373432,
        "cost": 0.000342194841184,
        "unitPrice": 3.74,
        "billingCurrency": "CAD",
        "resourceLocation": "USEast",
        "consumedService": "Microsoft.Storage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1",
        "resourceName": "Resource Name 1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "DEV",
        "resourceGroup": "Resource Group 1",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage"
      }
    },
    {
      "id": "/scope/providers/Microsoft.Billing/billingPeriods/20180801/providers/Microsoft.Consumption/usageDetails/usageDetails_Id2",
      "name": "usageDetails_Id2",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Account Name 2",
        "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Account Name 2",
        "accountName": "Account Name 1",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "Subscription Name 1",
        "date": "2019-03-30T00:00:00.0000000Z",
        "product": "Product Name 2",
        "partNumber": "Part Number 2",
        "meterId": "11111111-1111-1111-1111-111111111111",
        "meterDetails": null,
        "quantity": 0.7329,
        "effectivePrice": 0.000402776395232,
        "cost": 0.000295194820065,
        "unitPrice": 4.38,
        "billingCurrency": "CAD",
        "resourceLocation": "USEast",
        "consumedService": "Microsoft.Storage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 2/providers/Microsoft.Storage/storageAccounts/Resource Name 2",
        "resourceName": "Resource Name 2",
        "invoiceSection": "Invoice Section 2",
        "costCenter": "DEV",
        "resourceGroup": "Resource Group 2",
        "offerId": "Offer Id 2",
        "isAzureCreditEligible": false,
        "chargeType": "Usage"
      }
    }
  ]
}

ManagementGroupUsageDetailsListForBillingPeriod

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Account Name 1",
        "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Account Name 1",
        "accountName": "Account Name 1",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "Subscription Name 1",
        "date": "2019-03-30T00:00:00.0000000Z",
        "product": "Product Name 1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 0.8234,
        "effectivePrice": 0.010534556373432,
        "cost": 0.000342194841184,
        "unitPrice": 3.74,
        "billingCurrency": "CAD",
        "resourceLocation": "USEast",
        "consumedService": "Microsoft.Storage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1",
        "resourceName": "Resource Name 1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "DEV",
        "resourceGroup": "Resource Group 1",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage"
      }
    },
    {
      "id": "/scope/providers/Microsoft.Billing/billingPeriods/billingPeriodName/providers/Microsoft.Consumption/usageDetails/usageDetails_Id2",
      "name": "usageDetails_Id2",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Account Name 2",
        "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Account Name 2",
        "accountName": "Account Name 2",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "Subscription Name 2",
        "date": "2019-03-30T00:00:00.0000000Z",
        "product": "Product Name 2",
        "partNumber": "Part Number 2",
        "meterId": "11111111-1111-1111-1111-111111111111",
        "meterDetails": null,
        "quantity": 0.4759,
        "effectivePrice": 0.073488920944598,
        "cost": 0.000821821271948,
        "unitPrice": 5.74,
        "billingCurrency": "CAD",
        "resourceLocation": "USEast",
        "consumedService": "Microsoft.Storage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 2/providers/Microsoft.Storage/storageAccounts/Resource Name 2",
        "resourceName": "Resource Name 2",
        "invoiceSection": "Invoice Section 2",
        "costCenter": "DEV",
        "resourceGroup": "Resource Group 2",
        "offerId": "Offer Id 2",
        "isAzureCreditEligible": false,
        "chargeType": "UnusedReservation"
      }
    }
  ]
}

UsageDetailsExpand

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails?$expand=meterDetails,additionalInfo&$filter=tags eq 'dev:tools'&$top=1&api-version=2019-05-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Account Name 1",
        "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Account Name 1",
        "accountName": "Account Name 1",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "Subscription Name 1",
        "date": "2019-03-30T00:00:00.0000000Z",
        "product": "Product Name 1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": {
          "meterName": "Data Transfer Out (GB)",
          "meterCategory": "Networking",
          "meterSubCategory": "ExpressRoute",
          "unitOfMeasure": "GB",
          "serviceFamily": "Compute"
        },
        "quantity": 0.8234,
        "effectivePrice": 0.010464556322455,
        "cost": 0.000342194841184,
        "unitPrice": 3.54,
        "billingCurrency": "CAD",
        "resourceLocation": "USEast",
        "consumedService": "Microsoft.Storage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1",
        "resourceName": "Resource Name 1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "DEV",
        "resourceGroup": "Resource Group 1",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage",
        "frequency": "UsageBased",
        "additionalInfo": "{\"MyType\":\"\",\"ServiceType\":\"\",\"VMName\":\"\",\"UsageType\":\"MyUsage\"}"
      }
    }
  ]
}

UsageDetailsList

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Customer Name 1",
        "billingPeriodStartDate": "2019-04-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-04-30T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Customer Name 1",
        "accountName": "AccountName",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "SubscriptionName 1",
        "date": "2019-04-09T00:00:00.0000000Z",
        "product": "Product1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 3.6E-05,
        "effectivePrice": 0.054693034210767,
        "cost": 1.980949998E-06,
        "unitPrice": 5.47,
        "billingCurrency": "CAD",
        "resourceLocation": "uswest",
        "consumedService": "Microsoft.ClassicStorage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource-Group-westus/providers/Microsoft.ClassicStorage/storageAccounts/ResourceName1",
        "resourceName": "ResourceName1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "BAS",
        "resourceGroup": "Resource-Group-westus",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage",
        "frequency": "UsageBased"
      }
    }
  ]
}

UsageDetailsListByMetricActualCost

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01&metric=actualcost

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Customer Name 1",
        "billingPeriodStartDate": "2019-04-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-04-30T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Customer Name 1",
        "accountName": "AccountName",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "SubscriptionName 1",
        "date": "2019-04-09T00:00:00.0000000Z",
        "product": "Product1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 3.6E-05,
        "effectivePrice": 0.054693055510767,
        "cost": 1.968949998E-06,
        "unitPrice": 5.47,
        "billingCurrency": "CAD",
        "resourceLocation": "uswest",
        "consumedService": "Microsoft.ClassicStorage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource-Group-westus/providers/Microsoft.ClassicStorage/storageAccounts/ResourceName1",
        "resourceName": "ResourceName1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "BAS",
        "resourceGroup": "Resource-Group-westus",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage"
      }
    }
  ]
}

UsageDetailsListByMetricAmortizedCost

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01&metric=amortizedcost

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Customer Name 1",
        "billingPeriodStartDate": "2019-04-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-04-30T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Customer Name 1",
        "accountName": "AccountName",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "SubscriptionName 1",
        "date": "2019-04-09T00:00:00.0000000Z",
        "product": "Product1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 3.6E-05,
        "effectivePrice": 0.054693055510767,
        "cost": 1.968949998E-06,
        "unitPrice": 5.47,
        "billingCurrency": "CAD",
        "resourceLocation": "uswest",
        "consumedService": "Microsoft.ClassicStorage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource-Group-westus/providers/Microsoft.ClassicStorage/storageAccounts/ResourceName1",
        "resourceName": "ResourceName1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "BAS",
        "resourceGroup": "Resource-Group-westus",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage",
        "frequency": "UsageBased"
      }
    }
  ]
}

UsageDetailsListByMetricUsage

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01&metric=usage

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Customer Name 1",
        "billingPeriodStartDate": "2019-04-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-04-30T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Customer Name 1",
        "accountName": "AccountName",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "SubscriptionName 1",
        "date": "2019-04-09T00:00:00.0000000Z",
        "product": "Product1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 3.6E-05,
        "effectivePrice": 0.054693055510767,
        "cost": 1.968949998E-06,
        "unitPrice": 5.47,
        "billingCurrency": "CAD",
        "resourceLocation": "uswest",
        "consumedService": "Microsoft.ClassicStorage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource-Group-westus/providers/Microsoft.ClassicStorage/storageAccounts/ResourceName1",
        "resourceName": "ResourceName1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "BAS",
        "resourceGroup": "Resource-Group-westus",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage"
      }
    }
  ]
}

UsageDetailsListFilterByTag

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails?$filter=tags eq 'dev:tools'&api-version=2019-05-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Account Name 1",
        "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Account Name 1",
        "accountName": "Account Name 1",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "Subscription Name 1",
        "date": "2019-03-30T00:00:00.0000000Z",
        "product": "Product Name 1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 0.8234,
        "effectivePrice": 0.010534556373432,
        "cost": 0.000342194841184,
        "unitPrice": 3.74,
        "billingCurrency": "CAD",
        "resourceLocation": "USEast",
        "consumedService": "Microsoft.Storage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1",
        "resourceName": "Resource Name 1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "DEV",
        "resourceGroup": "Resource Group 1",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage"
      }
    }
  ]
}

UsageDetailsListForBillingPeriod

Sample Request

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/usageDetails?api-version=2019-05-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201903/providers/Microsoft.Consumption/usageDetails/usageDetails_Id1",
      "name": "usageDetails_Id1",
      "type": "Microsoft.Consumption/usageDetails",
      "tags": {
        "env": "newcrp",
        "dev": "tools"
      },
      "properties": {
        "billingAccountId": "xxxxxxxx",
        "billingAccountName": "Account Name 1",
        "billingPeriodStartDate": "2019-03-01T00:00:00.0000000Z",
        "billingPeriodEndDate": "2019-03-31T00:00:00.0000000Z",
        "billingProfileId": "xxxxxxxx",
        "billingProfileName": "Account Name 1",
        "accountName": "Account Name 1",
        "subscriptionId": "00000000-0000-0000-0000-000000000000",
        "subscriptionName": "Subscription Name 1",
        "date": "2019-03-30T00:00:00.0000000Z",
        "product": "Product Name 1",
        "partNumber": "Part Number 1",
        "meterId": "00000000-0000-0000-0000-000000000000",
        "meterDetails": null,
        "quantity": 0.8234,
        "effectivePrice": 0.010534556373432,
        "cost": 0.000342194841184,
        "unitPrice": 3.74,
        "billingCurrency": "CAD",
        "resourceLocation": "USEast",
        "consumedService": "Microsoft.Storage",
        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Resource Group 1/providers/Microsoft.Storage/storageAccounts/Resource Name 1",
        "resourceName": "Resource Name 1",
        "invoiceSection": "Invoice Section 1",
        "costCenter": "DEV",
        "resourceGroup": "Resource Group 1",
        "offerId": "Offer Id 1",
        "isAzureCreditEligible": false,
        "chargeType": "Usage"
      }
    }
  ]
}

Definitions

ErrorDetails

The details of the error.

ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

MeterDetailsResponse

The properties of the meter detail.

metrictype

Allows to select different type of cost/usage records.

UsageDetail

An usage detail resource.

UsageDetailsListResult

Result of listing usage details. It contains a list of available usage details in reverse chronological order by billing period.

ErrorDetails

The details of the error.

Name Type Description
code
  • string

Error code.

message
  • string

Error message indicating why the operation failed.

ErrorResponse

Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Name Type Description
error

The details of the error.

MeterDetailsResponse

The properties of the meter detail.

Name Type Description
meterCategory
  • string

The category of the meter, for example, 'Cloud services', 'Networking', etc..

meterName
  • string

The name of the meter, within the given meter category

meterSubCategory
  • string

The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc..

serviceFamily
  • string

The service family.

unitOfMeasure
  • string

The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc.

metrictype

Allows to select different type of cost/usage records.

Name Type Description
actualcost
  • string

Actual cost data.

amortizedcost
  • string

Amortized cost data.

usage
  • string

Usage data.

UsageDetail

An usage detail resource.

Name Type Description
id
  • string

Resource Id.

name
  • string

Resource name.

properties.accountName
  • string

Account Name.

properties.accountOwnerId
  • string

Account Owner Id.

properties.additionalInfo
  • string

Additional details of this usage item. By default this is not populated, unless it's specified in $expand. Use this field to get usage line item specific details such as the actual VM Size (ServiceType) or the ratio in which the reservation discount is applied.

properties.billingAccountId
  • string

Billing Account identifier.

properties.billingAccountName
  • string

Billing Account Name.

properties.billingCurrency
  • string

Billing Currency.

properties.billingPeriodEndDate
  • string

The billing period end date.

properties.billingPeriodStartDate
  • string

The billing period start date.

properties.billingProfileId
  • string

Billing Profile identifier.

properties.billingProfileName
  • string

Billing Profile Name.

properties.chargeType
  • string

Indicates a charge represents credits, usage, a Marketplace purchase, a reservation fee, or a refund.

properties.consumedService
  • string

Consumed service name. Name of the azure resource provider that emits the usage or was purchased. This value is not provided for marketplace usage.

properties.cost
  • number

The amount of cost before tax.

properties.costCenter
  • string

The cost center of this department if it is a department and a cost center is provided.

properties.date
  • string

Date for the usage record.

properties.effectivePrice
  • number

Effective Price that’s charged for the usage.

properties.frequency
  • string

Indicates how frequently this charge will occur. OneTime for purchases which only happen once, Monthly for fees which recur every month, and UsageBased for charges based on how much a service is used.

properties.invoiceSection
  • string

Invoice Section Name.

properties.isAzureCreditEligible
  • boolean

Is Azure Credit Eligible.

properties.meterDetails

The details about the meter. By default this is not populated, unless it's specified in $expand.

properties.meterId
  • string

The meter id (GUID). Not available for marketplace. For reserved instance this represents the primary meter for which the reservation was purchased. For the actual VM Size for which the reservation is purchased see productOrderName.

properties.offerId
  • string

Offer Id. Ex: MS-AZR-0017P, MS-AZR-0148P.

properties.partNumber
  • string

Part Number of the service used. Can be used to join with the price sheet. Not available for marketplace.

properties.planName
  • string

Plan Name.

properties.product
  • string

Product name for the consumed service or purchase. Not available for Marketplace.

properties.productOrderId
  • string

Product Order Id. For reservations this is the Reservation Order ID.

properties.productOrderName
  • string

Product Order Name. For reservations this is the SKU that was purchased.

properties.publisherName
  • string

Publisher Name.

properties.publisherType
  • string

Publisher Type.

properties.quantity
  • number

The usage quantity.

properties.reservationId
  • string

ARM resource id of the reservation. Only applies to records relevant to reservations.

properties.reservationName
  • string

User provided display name of the reservation. Last known name for a particular day is populated in the daily data. Only applies to records relevant to reservations.

properties.resourceGroup
  • string

Resource Group Name.

properties.resourceId
  • string

Azure resource manager resource identifier.

properties.resourceLocation
  • string

Resource Location.

properties.resourceName
  • string

Resource Name.

properties.serviceInfo1
  • string

Service Info 1.

properties.serviceInfo2
  • string

Service Info 2.

properties.subscriptionId
  • string

Subscription guid.

properties.subscriptionName
  • string

Subscription name.

properties.term
  • string

Term (in months). 1 month for monthly recurring purchase. 12 months for a 1 year reservation. 36 months for a 3 year reservation.

properties.unitPrice
  • number

Unit Price is the price applicable to you. (your EA or other contract price).

tags
  • object

Resource tags.

type
  • string

Resource type.

UsageDetailsListResult

Result of listing usage details. It contains a list of available usage details in reverse chronological order by billing period.

Name Type Description
nextLink
  • string

The link (url) to the next page of results.

value

The list of usage details.