Plánování změn nového komerčního předplatného pomocí rozhraní API Partnerského centra

se vztahuje na: Partnerské centrum

Tento článek popisuje, jak můžete pomocí rozhraní API Partnerského centra naplánovat změny nového komerčního předplatného, které probíhají pouze při prodloužení. Toto rozhraní API podporuje nová komerční licencovaná a softwarová předplatná.

Vytváření plánovaných změn umožňuje automaticky upravit předplatné, když dojde k dalšímu prodlužování platnosti. Plánováním změn můžete zvýšit nebo snížit počet licencí, upravit fakturační období a frekvenci a dokonce i upgradovat skladovou položku. Plánování změn umožňuje provádět změny předplatného při prodloužení, a ne okamžitě během aktuálního období.

Požadavky

• Přihlašovací údaje popsané v ověřování v Partnerském centru. Tento scénář podporuje ověřování jak samostatnými přihlašovacími údaji aplikace, tak přihlašovacími údaji aplikace a uživatele.

• ID zákazníka (customer-tenant-id). Pokud neznáte ID zákazníka, můžete ho vyhledat v partnerském centru tak, že vyberete pracovní prostor Zákazníci, pak zákazník ze seznamu zákazníků a pak účet. Na stránce Účet zákazníka, vyhledejte ID Microsoftu v části Informace o zákaznickém účtu. ID Microsoftu je stejné jako ID zákazníka (customer-tenant-id).

• ID předplatného.

• Automatické prodlužování je v předplatném povolené.

Metoda Partnerského centra

Naplánování změn předplatného v Partnerském centru:

1. Vyberte zákazníka.

2. Vyberte předplatné, pro které chcete naplánovat změny.

3. Povolit automatické prodlužování.

4. Vyberte Spravovat obnovení.

5. Proveďte změny předplatného, které vstoupí v platnost při obnově.

6. Pokud chcete boční panel zavřít, vyberte Okay.

7. Pro uložení změn zvolte Odeslat.

C#

Naplánování změn pro předplatné zákazníka:

1. Získejte předplatné podle ID.
2. Získání způsobilosti pro naplánovaný typ přechodu.
3. Vytvořte ScheduledNextTermInstructions objekt a nastavte ho na vlastnost předplatného.
4. Zavolejte metodu Patch(), která aktualizuje předplatné plánovanými změnami.

var selectedSubscription = subscriptionOperations.Get();
selectedSubscription.ScheduledNextTermInstructions = new ScheduledNextTermInstructions
{
    Product = new ProductTerm
    {
        ProductId = changeToProductId,
        SkuId = changeToSkuId,
        AvailabilityId = changeToAvailabilityId,
        BillingCycle = changeToBillingCycle,
        TermDuration = changeToTermDuration,
    },
    Quantity = changeToQuantity,
    customTermEndDate = DateTime,
};
var updatedSubscription = subscriptionOperations.Patch(selectedSubscription);

Pokud chcete naplánovat změny předplatného zákazníka, kde je plánovaná změna na jiný produkt:

1. Získejte předplatné podle ID.
2. Získání nároku na přechod pro plánovaný typ přechodu.
3. Zavolejte metodu Patch(), která aktualizuje předplatné plánovanými změnami.

Požadavek REST

Syntaxe požadavku

Parametr identifikátoru URI

Tato tabulka obsahuje seznam požadovaných parametrů dotazu pro volání rozhraní API.

Hlavičky požadavku

Další informace najdete v tématu hlavičky REST Partnerského centra.

Text požadavku

V textu požadavku se vyžaduje úplný prostředek předplatného s definovanou vlastností scheduledNextTermInstructions. Pokud chcete naplánovat změny předplatného, ujistěte se, že je vlastnost AutoRenewEnabled nastavená na true.

Pro ID dostupnosti při ukončení prodeje s převody (EndofSaleWithConversions) nabídky:

1. Metoda GetTransitionEligibility pro návrat hodnoty CatalogItemID.

   a. Ujistěte se, že jste nastavili naplánovaný typ způsobilosti, jinak je výchozí nastavení okamžité.

2. K extrahování ID dostupnosti použijte CatalogItemID.

Příklad požadavku

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": "6e7aa601-629e-461b-8933-0898c3cc3c7c",
    "offerId": "DZH318Z0BXWC:0001:DZH318Z0BMJX",
    "offerName": "offer Name",
    "friendlyName": "friendly Name",
    "quantity": 1,
    "customTermEndDate": "2019-01-09T00:21:45.9263727",
    "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": "active",
    "autoRenewEnabled": true,
    "scheduledNextTermInstructions": { 
      "product": { 
         "productId":  "DG7GMGF0DVSV", 
         "skuId":  "000P", 
         "availabilityId":  "DG7GMGF0F3Q9", 
         "billingCycle":  "Annual", 
         "termDuration":  "P3Y",
         "promotionId": "39NFJQT1PFPJ:000H:39NFJQT1Q5DK"
        }, 
      "quantity":  1 
      "customTermEndDate" : "2019-01-09T00:21:45.9263727",
     },  // original value = null 
    "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"},
}

Odpověď REST

Pokud je požadavek úspěšný, tato metoda vrátí v textu odpovědi aktualizované vlastnosti prostředku Předplatné.

Kódy úspěšnosti a chyb odpovědi

Každá odpověď se dodává se stavovým kódem HTTP, který označuje úspěch nebo selhání, a další informace o ladění. Ke čtení tohoto kódu, typu chyby a dalších parametrů použijte nástroj pro trasování sítě. Úplný seznam najdete v tématu Kódy chyb.

Příklad odpovědi

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": "6e7aa601-629e-461b-8933-0898c3cc3c7c",
    "offerId": "DZH318Z0BXWC:0001:DZH318Z0BMJX",
    "offerName": "offer Name",
    "friendlyName": "friendly Name",
    "quantity": 1,
    "customTermEndDate": "2019-01-09T00:21:45.9263727",
    "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": "active",
    "autoRenewEnabled": true,
    "scheduledNextTermInstructions": { 
      "product": { 
         "productId":  "DG7GMGF0DVSV", 
         "skuId":  "000P", 
         "availabilityId":  "DG7GMGF0F3Q9", 
         "billingCycle":  "Annual", 
         "termDuration":  "P3Y",
         "promotionId": "39NFJQT1PFPJ:000H:39NFJQT1Q5DK"
        }, 
      "quantity":  1 
      "customTermEndDate": "2019-01-09T00:21:45.9263727",
     },  // original value = null 
    "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"},
}