Get a usage summary for a partner

Article
10/07/2024

Applies to: Partner Center | Partner Center for Microsoft Cloud for US Government

You can use the PartnerUsageSummary resource to get a partner usage summary of all customers that purchased a specific Azure service or resource during the current billing period.

The total returned by this API will not return consumption for customers that have an Azure plan. Planned for deprecation in the future.

Prerequisites

Credentials as described in Partner Center authentication. This scenario supports authentication with App+User credentials only.

C#

To get a usage summary for all customers that purchased a specific Azure service or resource during the current billing period:

Use your IAggregatePartner.

Call the UsageSummary property, followed by the Get() or GetAsync() methods:

// IAggregatePartner partnerOperations;

var usageSummary = partnerOperations.UsageSummary.Get();

For an example, see the following:

Sample: Console test app
Project: PartnerSDK.FeatureSamples
Class: GetPartnerUsageSummary.cs

REST request

Request syntax

Method	Request URI
GET	{baseURL}/v1/usagesummary HTTP/1.1

Request headers

For more information, see Partner Center REST headers.

Request body

None.

Request example

GET https://api.partnercenter.microsoft.com/v1/usagesummary HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd

REST response

If successful, this method returns a PartnerUsageSummary resource in the response body.

Response success and error codes

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, the error type, and additional parameters. For a full list, see Error Codes.

Response example

HTTP/1.1 200 OK
Content-Length: 1120
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: e128c8e2-4c33-4940-a3e2-2e59b0abdc67
Date: Tue, 17 Sep 2019 20:31:45 GMT

{
    "customersOverBudget": 1,
    "customersTrendingOver": 0,
    "customersWithUsageBasedSubscription": 11,
    "resourceId": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
    "id": "a0a0a0a0-bbbb-cccc-dddd-e1e1e1e1e1e1",
    "resourceName": "PLAMUATT2NETNEW",
    "name": "PLAMUATT2NETNEW",
    "billingStartDate": "2019-08-28T00:00:00-07:00",
    "billingEndDate": "2019-09-27T00:00:00-07:00",
    "totalCost": 22.861172,
    "currencyLocale": "fr-FR",
    "lastModifiedDate": "2019-09-01T23:04:41.193+00:00",
    "links": {
        "self": {
            "uri": "/usagesummary",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "PartnerUsageSummary"
    }
}

Share via