取得自訂字詞結束日期

發行項
02/21/2024

適用於：合作夥伴中心 |由 21Vianet 營運的合作夥伴中心 |美國政府適用的 Microsoft Cloud 合作夥伴中心

合作夥伴可以檢視他們為其客戶購買的 NCE 授權型訂閱所允許的自定義字詞結束日期。合作夥伴可以檢視與行事曆月份結束相符的結束日期，或與現有客戶訂閱共同合作的日期。

API 僅支援針對購買新訂閱的自定義字詞結束日期進行計算，而不支援現有訂閱的續約。

必要條件

認證，如合作夥伴中心驗證所述。此案例支援使用獨立應用程式和 App+使用者認證進行驗證。
CustomerTenantId。如果您不知道客戶的標識碼，您可以在合作夥伴中心中選取 [客戶] 工作區，然後從客戶清單中查看客戶，然後從 [帳戶]。在客戶的 [帳戶] 頁面上，在 [客戶帳戶資訊] 區段中尋找 Microsoft 標識符。 Microsoft識別碼與客戶標識符相同。

REST 要求

要求語法

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

查詢字串

下表列出篩選和擷取自定義字詞結束日期所需的查詢字串。

Name：	必要：	描述：
term_duration	Yes	詞彙持續時間的 ISO 8601 表示法。目前的支援值為 P1M （1 個月）、 P1Y （1 年）和 P3Y （3 年）。
term_start_date	No	購買的預定日期。這不能過去。
target_coterm_subscription_id	No	GUID 格式的字串，可識別要搭配共置的訂用帳戶。

要求標頭

如需詳細資訊，請參閱合作夥伴中心 REST 標頭。 API 的回應最多會傳回 300 個頁面記錄。如果在輸入的查詢中傳回超過 300 筆記錄，響應標頭中會提供接續令牌。接續令牌可以是下列要求的標頭中的輸入，以傳回查詢的其他頁面記錄。

要求本文

無。

REST 回應

如果成功，這個方法會傳回響應主體中已移轉的訂用帳戶詳細數據（移轉物件）。這包括移轉標識碼。

回應成功和錯誤碼

每個回應都隨附 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"
    }
 }

共用方式為