获取自定义期限结束日期

项目
02/23/2024

适用于：合作伙伴中心 | 由世纪互联运营的合作伙伴中心 | Microsoft Cloud for US Government 合作伙伴中心

合作伙伴可以查看他们为客户购买的基于 NCE 许可证的订阅的允许自定义期限结束日期。合作伙伴可以查看与日历月结束日期相符的结束日期，也可以查看与现有客户订阅共存的结束日期。

API 仅支持计算购买新订阅的自定义期限结束日期，而不支持现有订阅的续订。

先决条件

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

REST 请求

请求语法

方法	请求 URI
GET	{baseURL}/v1/customers/{customerId}/subscriptions/customTermEndDates

查询字符串

下表列出了筛选和检索自定义术语结束日期所需的查询字符串。

姓名：	必需：	说明:
term_duration	是	术语持续时间的 ISO 8601 表示形式。当前支持的值为 P1M （1 个月）、 P1Y （1 年）和 P3Y （3 年）。
term_start_date	否	购买的预期日期。这不能过去。
target_coterm_subscription_id	否	一个 GUID 格式的字符串，用于标识要与之关联的订阅。

请求标头

有关详细信息，请参阅合作伙伴中心 REST 标头。 API 的响应最多返回 300 条页面记录。如果在输入的查询中返回了超过 300 条记录，响应标头中会提供延续标记。延续标记可以在以下请求的标头中输入，以返回查询的其他页面记录。

请求正文

无。

REST 响应

如果成功，此方法将返回响应正文中已迁移的订阅（迁移对象）的详细信息。这包括迁移 ID。

响应的成功和错误代码

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

请求 URL 示例

baseurl/v1/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M

响应示例

 {
    "totalCount": 2,
    "items": [
        {
            "allowedCustomTermEndDateType": "calendarMonthAligned",
            "allowedCustomTermEndDate": "2023-07-31T00:00:00"
        },
        {
            "allowedCustomTermEndDateType": "subscriptionAligned",
            "cotermSubscriptionIds": [
               "5fcf618b-1daa-4604-da99-cc3e1c9ee422",
               "d30a9ff9-713e-4546-c97e-f06b9dcf6ef6"
            ],
            "allowedCustomTermEndDate": "2023-08-01T00:00:00"
        }
    ],
    "links": {
        "self": {
            "uri": "/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "Collection"
    }
 }

通过