Reservation Transactions - List

Service:: Consumption

API Version:: 2024-08-01

List of transactions for reserved instances on billing account scope. Note: The refund transactions are posted along with its purchase transaction (i.e. in the purchase billing month). For example, The refund is requested in May 2021. This refund transaction will have event date as May 2021 but the billing month as April 2020 when the reservation purchase was made. Note: ARM has a payload size limit of 12MB, so currently callers get 400 when the response size exceeds the ARM limit. In such cases, API call should be made with smaller date ranges.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?api-version=2024-08-01

With optional parameters:

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.Consumption/reservationTransactions?api-version=2024-08-01&$filter={$filter}&useMarkupIfPartner={useMarkupIfPartner}&previewMarkupPercentage={previewMarkupPercentage}

URI Parameters

Name	In	Required	Type	Description
billingAccountId	path	True	string	BillingAccount ID
api-version	query	True	string minLength: 1	The API version to use for this operation.
$filter	query		string	Filter reservation transactions by date range. The properties/EventDate for start date and end date. The filter supports 'le' and 'ge'. Note: API returns data for the entire start date's and end date's billing month. For example, filter properties/eventDate+ge+2020-01-01+AND+properties/eventDate+le+2020-12-29 will include data for the entire December 2020 month (i.e. will contain records for dates December 30 and 31)
previewMarkupPercentage	query		number (decimal)	Preview markup percentage to be applied.
useMarkupIfPartner	query		boolean	Applies mark up to the transactions if the caller is a partner.

Responses

Name	Type	Description
200 OK	ReservationTransactionsListResult	The request has succeeded.
Other Status Codes	ErrorResponse	An unexpected error response.

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

ReservationTransactionsByEnrollmentNumber

Sample request

HTTP

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.Consumption/reservationTransactions?api-version=2024-08-01&$filter=properties/eventDate+ge+2020-05-20+AND+properties/eventDate+le+2020-05-30&useMarkupIfPartner=True&previewMarkupPercentage=15.5

Sample response

Status code:: 200

{
  "value": [
    {
      "name": "201909091919",
      "type": "Microsoft.Consumption/reservationTransactions",
      "id": "/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919",
      "properties": {
        "description": "Standard_DS1_v2 westus 1 Year",
        "accountName": "Microsoft Infrastructure",
        "accountOwnerEmail": "admin@microsoft.com",
        "amount": -21,
        "armSkuName": "Standard_DS1_v2",
        "billingFrequency": "recurring",
        "billingMonth": 20190901,
        "costCenter": "",
        "currency": "USD",
        "currentEnrollment": "123456",
        "departmentName": "Unassigned",
        "eventDate": "2019-09-09T19:19:04Z",
        "eventType": "Refund",
        "monetaryCommitment": 523123.9,
        "overage": 23234.49,
        "purchasingEnrollment": "123456",
        "purchasingSubscriptionGuid": "a838a8c3-a408-49e1-ac90-42cb95bff9b2",
        "purchasingSubscriptionName": "Infrastructure Subscription",
        "quantity": 1,
        "region": "westus",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderName": "Transaction-DS1_v2",
        "term": "P1Y"
      },
      "tags": []
    },
    {
      "name": "201909091919",
      "type": "Microsoft.Consumption/reservationTransactions",
      "id": "/billingAccounts/123456/providers/Microsoft.Consumption/reservationtransactions/201909091919",
      "properties": {
        "description": "Standard_DS1_v2 westus 1 Year",
        "accountName": "Microsoft Infrastructure",
        "accountOwnerEmail": "admin@microsoft.com",
        "amount": 21,
        "armSkuName": "Standard_DS1_v2",
        "billingFrequency": "recurring",
        "billingMonth": 20190901,
        "costCenter": "",
        "currency": "USD",
        "currentEnrollment": "123456",
        "departmentName": "Unassigned",
        "eventDate": "2019-09-09T19:19:04Z",
        "eventType": "Purchase",
        "monetaryCommitment": 523123.9,
        "overage": 23234.49,
        "purchasingEnrollment": "123456",
        "purchasingSubscriptionGuid": "a838a8c3-a408-49e1-ac90-42cb95bff9b2",
        "purchasingSubscriptionName": "Infrastructure Subscription",
        "quantity": 1,
        "region": "westus",
        "reservationOrderId": "00000000-0000-0000-0000-000000000000",
        "reservationOrderName": "Transaction-DS1_v2",
        "term": "P1Y"
      },
      "tags": []
    }
  ]
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ReservationTransaction	Reservation transaction resource.
ReservationTransactionsListResult	Result of listing reservation recommendations.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.