使用合作伙伴中心 API 取消商业市场或新商业订阅

项目
07/02/2024

适用于：合作伙伴中心

本文介绍如何使用合作伙伴中心 API 取消与客户和订阅 ID 匹配的商业市场或新的商业订阅资源。

注意

基于许可证的服务的新商业体验涵盖许多新功能，可供所有云解决方案提供商 (CSP) 使用。有关详细信息，请参阅新商业体验概述。

新的商业订阅可以在 7 天内取消，除非法律要求购买或续订。在此窗口传递后，无法再取消订阅，API 将引发错误。

先决条件

合作伙伴中心身份验证中所述的凭据。此方案支持使用独立应用和 App+User 凭据进行身份验证。
客户 ID (customer-tenant-id)。如果不知道客户的 ID，可以在“客户”工作区的合作伙伴中心中查找该 ID。从客户列表中选择客户，然后选择“帐户”。在客户的“帐户”页上，在“客户帐户信息”部分查找Microsoft ID。 Microsoft ID 与客户 ID (customer-tenant-id) 相同。
订阅 ID。

合作伙伴中心方法

若要在合作伙伴中心取消商业市场订阅，请执行以下操作：

选择客户。
选择要取消的订阅。
选择 “取消订阅 ”选项，然后选择“ 提交”。

C#

若要取消客户的订阅，请执行以下操作：

按 ID 获取订阅。
更改订阅的状态属性。有关状态代码的信息，请参阅 SubscriptionStatus 枚举。
进行更改后，使用 IAggregatePartner.Customers 集合并调用 ById（） 方法。
依次调用 Subscriptions 属性和 ById() 方法。
调用 Patch() 方法。

// IAggregatePartner partnerOperations;
// var selectedCustomerId as string;
// Subscription selectedSubscription;

selectedSubscription.Status = SubscriptionStatus.Deleted;
var updatedSubscription = partnerOperations.Customers.ById(selectedCustomerId).Subscriptions.ById(selectedSubscription.Id).Patch(selectedSubscription);

示例控制台测试应用

示例：控制台测试应用。项目：PartnerSDK.FeatureSample 类：UpdateSubscription.cs

REST 请求

请求语法

方法	请求 URI
PATCH	{baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id} HTTP/1.1

URI 参数

下表列出了挂起订阅所需的查询参数。

名称	类型	必需	说明
customer-tenant-id	guid	Y	对应于客户的 GUID。
subscription-id	guid	Y	对应于订阅的 GUID。

请求标头

有关详细信息，请参阅合作伙伴中心 REST 标头。

请求正文

请求正文中需要有一个完整的订阅资源。若要取消订阅，请确保状态属性已更新为值 deleted。

字段	类型	必需	说明
status	string	Y	订阅的状态。选项可以是 - `active`、 `suspendeddeleted`

请求示例

PATCH https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>/subscriptions/<subscription-id> HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3831
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
If-Match: <etag>
Content-Type: application/json
Content-Length: 1029
Expect: 100-continue
Connection: Keep-Alive

{
    "id": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "offerId": "DZH318Z0BXWC:0001:DZH318Z0BMJX",
    "offerName": "offer Name",
    "friendlyName": "friendly Name",
    "quantity": 1,
    "unitType": "License(s)",
    "hasPurchasableAddons": false,
    "creationDate": "2019-01-04T01:00:12.6647304Z",
    "effectiveStartDate": "2019-01-09T00:21:45.9263727+00:00",
    "commitmentEndDate": "2019-02-08T00:21:45.9263727+00:00",
    "status": "deleted",
    "autoRenewEnabled": false,
    "isTrial": false,
    "billingType": "license",
    "billingCycle": "monthly",
    "termDuration": "P1M",
    "refundOptions": [{
        "type": "Full",
        "expiresAt": "2019-01-10T00:21:45.9263727+00:00"
    }],
    "isMicrosoftProduct": false,
    "partnerId": "",
    "contractType": "subscription",
    "publisherName": "publisher Name",
    "orderId": "ImxjLNL4_fOc-2KoyOxGTZcrlIquzls11",
    "attributes": {"objectType": "Subscription"},
}

REST 响应

如果请求成功，此方法在响应正文中返回已删除的订阅资源属性。

响应的成功和错误代码

每个响应都带有一个 HTTP 状态代码，用于指示成功或失败以及其他调试信息。请使用网络跟踪工具来读取此代码、错误类型和其他参数。有关完整列表，请参阅错误代码。

响应示例

HTTP/1.1 200 OK
Content-Length: 1322
Content-Type: application/json; charset=utf-8
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3831
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US

{
    "id": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "offerId": "DZH318Z0BXWC:0001:DZH318Z0BMJX",
    "offerName": "offer Name",
    "friendlyName": "friendly Name",
    "quantity": 1,
    "unitType": "License(s)",
    "hasPurchasableAddons": false,
    "creationDate": "2019-01-04T01:00:12.6647304Z",
    "effectiveStartDate": "2019-01-09T00:21:45.9263727+00:00",
    "commitmentEndDate": "2019-02-08T00:21:45.9263727+00:00",
    "status": "deleted",
    "autoRenewEnabled": false,
    "isTrial": false,
    "billingType": "license",
    "billingCycle": "monthly",
    "termDuration": "P1M",
    "refundOptions": [
        {
            "type": "Full",
            "expiresAt": "2019-01-10T00:21:45.9263727+00:00"
        }
    ],
    "isMicrosoftProduct": false,
    "partnerId": "",
    "contractType": "subscription",
    "links": {
        "product": {
            "uri": "/products/DZH318Z0BXWC?country=US",
            "method": "GET",
            "headers": []
        },
        "sku": {
            "uri": "/products/DZH318Z0BXWC/skus/0001?country=US",
            "method": "GET",
            "headers": []
        },
        "availability": {
            "uri": "/products/DZH318Z0BXWC/skus/0001/availabilities/DZH318Z0BMJX?country=US",
            "method": "GET",
            "headers": []
        },
        "self": {
            "uri": "/customers/5921f00a-32c0-4457-aaa1-e8018c650895/subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
            "method": "GET",
            "headers": []
        }
    },
    "publisherName": "publisher Name",
    "orderId": "ImxjLNL4_fOc-2KoyOxGTZcrlIquzls11",
    "attributes": {
        "etag": "",
        "objectType": "Subscription"
    }
}

通过