Get a customer's service cost summary

  • Article

Learn how to get a summary of a customer's service costs for a specific billing period. You can use one of the following options:

  • PowerShell
  • C#
  • REST API

PowerShell

Get-PCCustomerServiceCostSummary -BillingPeriod MostRecent -TenantId '<tenant identifier>'

C#

  1. To identify the customer, call the IAggregatePartner.Customers.ById method with the customer ID.
  2. To get an interface for collection operations for customer service costs, use the ServiceCosts property.
  3. To return a value for IServiceCostsCollection, call the ByBillingPeriod method with a member of the billing period enumerator.
  4. To get the customer's service cost summary, use the IServiceCostsCollection.Summary.Get or the GetAsync method.
// IAggregatePartner partnerOperations;
// string selectedCustomerId;

var serviceCostsSummary = partnerOperations.Customers.ById(selectedCustomerId).ServiceCosts.ByBillingPeriod(ServiceCostsBillingPeriod.MostRecent).Summary.Get();

REST API

Request

Request syntax

Method Request URI
GET {baseURL}/v1/customers/{customer-id}/servicecosts/{billing-period} HTTP/1.1

URI parameters

The following table lists the parameters that are required for identifying a customer.

Name Type Description
customer-id guid A GUID-format customer ID that identifies the customer.
billing-period string The billing period. The only supported value is MostRecent. The string is not case-sensitive.

Request example

GET https://api.partnercenter.microsoft.com/v1/customers/65726577-c208-40fd-9735-8c85ac9cac68/servicecosts/mostrecent HTTP/1.1
Authorization: Bearer <authorization token>
Accept: application/json
MS-RequestId: e6a3b6b2-230a-4813-999d-57f883b60d38
MS-CorrelationId: a687bc47-8d08-4b78-aff6-5a59aa2055c2
X-Locale: en-US
Host: api.partnercenter.microsoft.com

Response

If the request is successful, the response body contains a ServiceCostsSummary resource that provides information about the customer's service costs.

Response example

HTTP/1.1 200 OK
Content-Length: 766
Content-Type: application/json; charset=utf-8
MS-CorrelationId: a687bc47-8d08-4b78-aff6-5a59aa2055c2
MS-RequestId: e6a3b6b2-230a-4813-999d-57f883b60d38
MS-CV: gPPoyNX1X0asAAcw.0
MS-ServerId: 101112202
Date: Fri, 02 Dec 2016 18: 54: 38 GMT

{
    "billingStartDate": "2015-12-12T00:00:00Z",
    "billingEndDate": "2016-01-11T00:00:00Z",
    "pretaxTotal": 17.22,
    "tax": 0.0,
    "afterTaxTotal": 17.22,
    "currencySymbol": "$",
    "customerId": "ae1d5b32-f9ff-4252-b2bf-40e21937a51a",
    "links": {
        "serviceCostLineItems": {
            "uri": "/customers/ae1d5b32-f9ff-4252-b2bf-40e21937a51a/servicecosts/MostRecent/lineitems",
            "method": "GET",
            "headers": []
        },
        "self": {
            "uri": "/customers/ae1d5b32-f9ff-4252-b2bf-40e21937a51a/servicecosts/MostRecent",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "ServiceCostsSummary"
    }
}

Next steps