Get a customer's subscriptions

Article
11/29/2023

Applies to: Partner Center | Partner Center operated by 21Vianet | Partner Center for Microsoft Cloud for US Government

How to get a collection of a customer's subscriptions.

Prerequisites

Credentials as described in Partner Center authentication. This scenario supports authentication with both standalone App and App+User credentials.
A customer ID (customer-tenant-id). If you don't know the customer's ID, you can look it up in Partner Center by selecting the Customers workspace, then the customer from the customer list, then Account. On the customer's Account page, look for the Microsoft ID in the Customer Account Info section. The Microsoft ID is the same as the customer ID (customer-tenant-id).

C#

To get a list of all of a customer's subscriptions, first use the IAggregatePartner.Customers.ById method with the customer identifier to identify the customer. Then use the Subscriptions property to retrieve an interface to subscription collection operations. Finally, call the Get or GetAsync methods to retrieve the customer's subscriptions collection.

// IAggregatePartner partnerOperations;
// string customerId;

var customerSubscriptions = partnerOperations.Customers.ById(customerId).Subscriptions.Get();

Sample: Console test app. Project: Partner Center SDK Samples Class: GetSubscriptions.cs

REST request

Request syntax

Method	Request URI
GET	{baseURL}/v1/customers/{customer-tenant-id}/subscriptions HTTP/1.1

URI parameter

This table lists the required query parameter to get all the subscriptions.

Name	Type	Required	Description
customer-tenant-id	string	Yes	A GUID-formatted string that identifies the customer.

Request headers

For more information, see Partner Center REST headers.

Request body

None.

Request example

GET https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>/subscriptions HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: b2d13828-2ca5-41d4-94fb-9946214f4244
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Connection: Keep-Alive

REST response

If successful, this method returns a collection of Subscription resources 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, error type, and additional parameters. For the full list, see Partner Center REST error codes.

Response examples

Response example for a legacy online services subscription

HTTP/1.1 200 OK
Content-Length: 73754
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: b2d13828-2ca5-41d4-94fb-9946214f4244
Date: Wed, 25 Nov 2015 05:43:06 GMT

{
    "totalCount": 1,
    "items": [{
        "id": "83ef9d05-4169-4ef9-9657-0e86b1eab1de",
        "entitlementId": "a356ac8c-e310-44f4-bf85-C7f29044af99",
        "friendlyName": "nickname",
        "quantity": 1,
        "unitType": "none",
        "creationDate": "2015-11-25T06: 41: 12Z",
        "effectiveStartDate": "2015-11-24T08: 00: 00Z",
        "commitmentEndDate": "2016-12-12T08: 00: 00Z",
        "status": "active",
        "autoRenewEnabled": false,
        "billingType": "none",
        "contractType": "subscription",
        "links": {
            "offer": {
                "uri": "/v1/offers/0CCA44D6-68E9-4762-94EE-31ECE98783B9",
                "method": "GET",
                "headers": []
            },
            "self": {
                "uri": "/subscriptions?key=<key>",
                "method": "GET",
                "headers": []
            }
        },
        "orderId": "6183db3d-6318-4e52-877e-25806e4971be",
        "attributes": {
            "etag": "<etag>",
            "objectType": "Subscription"
        }
    }],
    "attributes": {
        "objectType": "Collection"
    }
}

Response example for new commerce subscriptions with online services and software

{
  "totalCount": 2,
  "items": [
    {
      "id": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
      "offerId": "CFQ7TTC0LFLZ:0002:CFQ7TTC0MKD5",
      "offerName": "Microsoft 365 E5",
      "friendlyName": "Microsoft 365 E5",
      "productType": {
        "id": "OnlineServicesNCE",
        "displayName": "OnlineServicesNCE"
      },
      "quantity": 1,
      "unitType": "Licenses",
      "hasPurchasableAddons": false,
      "consumptionType": "overage",
      "creationDate": "2023-11-28T22:28:50.7842638Z",
      "effectiveStartDate": "2023-11-28T00:00:00Z",
      "commitmentEndDate": "2023-12-27T00:00:00Z",
      "commitmentEndDateTime": "2023-12-27T23:59:59Z",
      "cancellationAllowedUntilDate": "2023-12-05T22:29:25.9967858Z",
      "billingCycleEndDate": "2023-12-27T00:00:00Z",
      "billingCycleEndDateTime": "2023-12-27T23:59:59Z",
      "status": "active",
      "autoRenewEnabled": true,
      "isTrial": false,
      "billingType": "license",
      "billingCycle": "monthly",
      "termDuration": "P1M",
      "renewalTermDuration": "",
      "refundOptions": [
        {
          "type": "Full",
          "expiresAt": "2023-11-29T22:29:25.9967858Z"
        }
      ],
      "isMicrosoftProduct": true,
      "partnerId": "",
      "attentionNeeded": false,
      "actionTaken": false,
      "contractType": "subscription",
      "links": {
        "product": {
          "uri": "/products/CFQ7TTC0LFLZ?country=US",
          "method": "GET",
          "headers": []
        },
        "sku": {
          "uri": "/products/CFQ7TTC0LFLZ/skus/0002?country=US",
          "method": "GET",
          "headers": []
        },
        "availability": {
          "uri": "/products/CFQ7TTC0LFLZ/skus/0002/availabilities/CFQ7TTC0MKD5?country=US",
          "method": "GET",
          "headers": []
        },
        "self": {
          "uri": "/customers/bfb6b398-c7f5-40f0-aa75-a1f1adf81374/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
          "method": "GET",
          "headers": []
        }
      },
      "publisherName": "Microsoft Corporation",
      "orderId": "f9a896ba4686",
      "attributes": {
        "objectType": "Subscription"
      }
    },
    {
      "id": "bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f",
      "offerId": "DG7GMGF0GJC2:0003:DG7GMGF0CFC5",
      "offerName": "Azure SQL Edge - 1 year",
      "friendlyName": "Azure SQL Edge",
      "productType": {
        "id": "Software",
        "displayName": "Software"
      },
      "quantity": 1,
      "unitType": "Licenses",
      "hasPurchasableAddons": false,
      "creationDate": "2023-11-28T22:21:15.015299Z",
      "effectiveStartDate": "2023-11-28T22:21:12.5336906Z",
      "commitmentEndDate": "2024-11-27T00:00:00Z",
      "commitmentEndDateTime": "2024-11-27T23:59:59Z",
      "cancellationAllowedUntilDate": "2023-12-05T22:21:37.7730547Z",
      "billingCycleEndDate": "2024-11-27T00:00:00Z",
      "billingCycleEndDateTime": "2024-11-27T23:59:59Z",
      "status": "active",
      "autoRenewEnabled": true,
      "isTrial": false,
      "billingType": "license",
      "billingCycle": "annual",
      "termDuration": "P1Y",
      "renewalTermDuration": "",
      "isMicrosoftProduct": true,
      "partnerId": "",
      "attentionNeeded": false,
      "actionTaken": false,
      "contractType": "subscription",
      "links": {
        "product": {
          "uri": "/products/DG7GMGF0GJC2?country=US",
          "method": "GET",
          "headers": []
        },
        "sku": {
          "uri": "/products/DG7GMGF0GJC2/skus/0003?country=US",
          "method": "GET",
          "headers": []
        },
        "availability": {
          "uri": "/products/DG7GMGF0GJC2/skus/0003/availabilities/DG7GMGF0CFC5?country=US",
          "method": "GET",
          "headers": []
        },
        "self": {
          "uri": "/customers/bfb6b398-c7f5-40f0-aa75-a1f1adf81374/subscriptions/bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f",
          "method": "GET",
          "headers": []
        }
      },
      "publisherName": "Microsoft",
      "orderId": "be34ac49aefb",
      "attributes": {
        "objectType": "Subscription"
      }
    }
  ]
}

Share via