Get a list of subscriptions by order

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

Gets a collection of Subscription resources that correspond to a given order.

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).

• An order ID.

C#

To get a list of subscriptions by order, use your IAggregatePartner.Customers collection and call the ById() method. Then call the Subscriptions property, followed by the ByOrder() method. Finish by calling Get() or GetAsync().

// IAggregatePartner partnerOperations;
// var selectedCustomerId as string;
// string orderID;

ResourceCollection<Subscription> customerSubscriptions = partnerOperations.Customers.ById(selectedCustomerId).Subscriptions.ByOrder(orderID).Get();

Sample: Console test app. Project: PartnerSDK.FeatureSample Class: SubscriptionsByOrder.cs

REST request

Request syntax

Method	Request URI
GET	{baseURL}/v1/customers/{customer-tenant-id}/subscriptions?order_id={id-for-order} HTTP/1.1

URI parameter

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

Name	Type	Required	Description
customer-tenant-id	guid	Y	A GUID corresponding to the customer.
id-for-order	guid	Y	A GUID corresponding to the order.

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?order_id={id-for-order} HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 16fee928-dc2c-412f-adbb-871f68babf16
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 Error Codes.

Response example

HTTP/1.1 200 OK
Content-Length: 73754
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 16fee928-dc2c-412f-adbb-871f68babf16
Date: Wed, 25 Nov 2015 05:50:45 GMT

{
    "totalCount": 1,
    "items": [{
        "id": "83ef9d05-4169-4ef9-9657-0e86b1eab1de",
        "entitlementId": "a356ac8c-e310-44f4-bf85-C7f29044af99",
        "friendlyName": "Myofferpurchase",
        "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": "{id-for-order}",
        "attributes": {
            "etag": "<etag>",
            "objectType": "Subscription"
        }
    }],
    "attributes": {
        "objectType": "Collection"
    }
}

Response example in new commerce

GET https://api.partnercenter.microsoft.com/v1/customers/c501c3c4-d776-40ef-9ecf-9cefb59442c1//subscriptions?order_id=79d9f5e2f43a HTTP/1.1
Content-Length: 73754
Content-Type: application/json
MS-RequestId: 261a7eab-99ba-4fef-b3f1-476ebfddfa52
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
Date: Thurs, 6 June 2024 10:50:45 GMT

{
  "totalCount": 1,
  "items": [
    {
        "id": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
        "offerId": "CFQ7TTC0LH18:0001:CFQ7TTC0P0WS",
        "offerName": "Microsoft 365 Business Basic",
        "friendlyName": "Microsoft 365 Business Basic",
        "productType": {
            "id": "OnlineServicesNCE",
            "displayName": "OnlineServicesNCE"
        },
        "quantity": 2,
        "unitType": "Licenses",
        "hasPurchasableAddons": false,
        "creationDate": "2024-06-05T19:26:38.3667635Z",
        "effectiveStartDate": "2024-06-05T00:00:00Z",
        "commitmentEndDate": "2024-07-04T00:00:00Z",
        "commitmentEndDateTime": "2024-07-04T23:59:59Z",
        "cancellationAllowedUntilDate": "2024-06-12T19:27:03.440527Z",
        "billingCycleEndDate": "2024-07-04T00:00:00Z",
        "billingCycleEndDateTime": "2024-07-04T23:59:59Z",
        "status": "active",
        "autoRenewEnabled": true,
        "isTrial": false,
        "billingType": "license",
        "billingCycle": "monthly",
        "termDuration": "P1M",
        "renewalTermDuration": "",
        "isMicrosoftProduct": true,
        "partnerId": "4847383",
        "attentionNeeded": false,
        "actionTaken": false,
        "contractType": "subscription",
        "links": {
            "product": {
                "uri": "/products/CFQ7TTC0LH18?country=US",
                "method": "GET",
                "headers": []
            },
            "sku": {
                "uri": "/products/CFQ7TTC0LH18/skus/0001?country=US",
                "method": "GET",
                "headers": []
            },
            "availability": {
                "uri": "/products/CFQ7TTC0LH18/skus/0001/availabilities/CFQ7TTC0P0WS?country=US",
                "method": "GET",
                "headers": []
            },
            "self": {
                "uri": "/customers/c501c3c4-d776-40ef-9ecf-9cefb59442c1/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
                "method": "GET",
                "headers": []
            }
        },
        "publisherName": "Microsoft Corporation",
        "refundableQuantity": {
            "totalQuantity": 1,
            "details": [
                {
                    "quantity": 1,
                    "allowedUntilDateTime": "2024-06-14T17:41:13.4675407Z"
                }
            ]
        },
        "orderId": "79d9f5e2f43a",
        "attributes": {
            "objectType": "Subscription"
        }
    }
  ],
  "attributes": { "objectType": "Collection" }
}