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

Článek
07/19/2024

Platí pro: 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é se provádí pouze při prodlužování platnosti. Toto rozhraní API podporuje nová komerční licencovaná a softwarová předplatná.

Poznámka:

Nové komerční prostředí pro služby založené na licencích zahrnují mnoho nových funkcí a jsou k dispozici pro všechny poskytovatele cloudových řešení (CSP). Další informace najdete v přehledu nových obchodních prostředí.

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

Důležité

Pokud provedete střednědobou (okamžitou) změnu před datem obnovení, odstraní se všechny plánované změny, které byly dříve naplánovány na obnovení.

Požadavky

Přihlašovací údaje popsané v ověřování v Partnerském centru Tento scénář podporuje ověřování pomocí samostatných přihlašovacích údajů aplikace i 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 účtu zákazníka. 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:

Vyberte zákazníka.
Vyberte předplatné, pro které chcete naplánovat změny.
Povolit automatické prodlužování.
Vyberte Spravovat prodlužování platnosti.
Proveďte změny předplatného, které se má provést při prodlužování platnosti.
Výběrem možnosti Ok zavřete boční panel.
výběrem možnosti Odeslat uložte změny.

Poznámka:

Prodloužení se zpracuje po posledním dni termínu počínaje 12:00 UTC následující den. Prodloužení se zpracovávají ve frontě a zpracování může trvat až 24 hodin.

C#

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

Získejte předplatné podle ID.
Získejte nárok na přechod pro typ způsobilosti pro naplánovaný přechod.
Vytvořte Objekt ScheduledNextTermInstructions a nastavte ho na vlastnost předplatného.
Voláním metody Patch() aktualizujte 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:

Získejte předplatné podle ID.
Získejte nárok na přechod pro typ způsobilosti pro naplánovaný přechod.
Voláním metody Patch() aktualizujte předplatné plánovanými změnami.

Požadavek REST

Syntaxe požadavku

metoda	Identifikátor URI žádosti
PATCH	{baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id} HTTP/1.1

Parametr identifikátoru URI

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

Name	Type	Požadováno	Popis
customer-tenant-id	identifikátor guid	Y	Identifikátor GUID odpovídající zákazníkovi.
id předplatného	identifikátor guid	Y	Identifikátor GUID odpovídající předplatnému.

Záhlaví žádosti

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 scheduledNextTermInstructions vlastností. Pokud chcete naplánovat změny pro vaše předplatné, ujistěte se, že je vlastnost AutoRenewEnabled nastavená na hodnotu true.

Pro ID dostupnosti na konci prodeje s převody (EndofSaleWithConversions) nabídky:

GetTransitionEligibility pro vrácení CatalogItemID.

a. Ujistěte se, že jste nastavili typ plánované způsobilosti, jinak je výchozí hodnota okamžitá.
K extrahování ID dostupnosti použijte CatalogItemID.

Poznámka:

Pokud k určení dostupnosti pro plánované pokynyNextTerm používáte příkaz GET a pokud jsou všechny podmínky ve stavu EOS, obdržíte prázdný seznam. Nejlepší způsob, jak určit platné cesty, je volat GetTransitionEligibilty API pro vrácení platných možností.

Pole	Typ	Požadováno	Popis
scheduledNextTermInstructions	object	Y	Definuje další pokyny pro období předplatného. Vlastnost obsahuje `product` objekt a `quantity` pole.

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ý, vrátí tato metoda aktualizované vlastnosti prostředku předplatného v textu odpovědi.

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"},
}

Sdílet prostřednictvím

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

Požadavky

Metoda Partnerského centra

C#

Požadavek REST

Syntaxe požadavku

Parametr identifikátoru URI

Záhlaví žádosti

Text požadavku

Příklad požadavku

Odpověď REST

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

Příklad odpovědi

Váš názor

Další materiály