Schemalägga ändringar för en ny handelsprenumeration med partnercenter-API:er

Artikel
02/26/2024

Gäller för: Partnercenter

Den här artikeln beskriver hur du kan använda Partner Center API för att schemalägga ändringar för en ny handelsprenumeration, som endast sker vid förnyelse.

Kommentar

De nya handelsupplevelserna för licensbaserade tjänster innehåller många nya funktioner och är tillgängliga för alla Molnlösningsleverantör (CSP:er). Mer information finns i översikten över nya handelsupplevelser.

När du skapar schemalagda ändringar kan du ändra din prenumeration automatiskt när nästa förnyelse sker. Genom att schemalägga ändringar kan du välja att öka eller minska antalet licenser, ändra faktureringsperioden och frekvensen och till och med välja att uppgradera SKU:n. Genom att schemalägga ändringar kan du göra ändringar i din prenumeration vid förnyelse i stället för omedelbart under den aktuella perioden.

Viktigt!

Om du gör en ändring efter halva tiden (omedelbar) före förnyelsedatumet tas alla schemalagda ändringar som tidigare var schemalagda att ske vid förnyelse bort.

Förutsättningar

Autentiseringsuppgifter enligt beskrivningen i Partnercenter-autentisering. Det här scenariot stöder autentisering med både fristående app- och App+User-autentiseringsuppgifter.
Ett kund-ID (customer-tenant-id). Om du inte känner till kundens ID kan du söka efter det i Partnercenter genom att välja arbetsytan Kunder , sedan kunden från kundlistan och sedan Konto. På kundens kontosida letar du efter Microsoft-ID :t i avsnittet Kundkontoinformation . Microsoft-ID:t är samma som kund-ID :t (customer-tenant-id).
Ett prenumerations-ID.
Automatisk förnyelse är aktiverat i prenumerationen.

Partnercenter-metod

Så här schemalägger du ändringar för en prenumeration i Partnercenter:

Välj en kund.
Välj den prenumeration som du vill schemalägga ändringar för.
Aktivera Automatisk förnyelse.
Välj Hantera förnyelse.
Gör ändringar i prenumerationen för förnyelse.
Välj Okej för att stänga sidopanelen.
välj Skicka för att spara ändringarna.

Kommentar

Förnyelser bearbetas efter den sista dagen av en period, med början kl. 12:00 UTC följande dag. Förnyelser bearbetas i en kö och kan ta upp till 24 timmar att bearbeta.

C#

Så här schemalägger du ändringar för en kunds prenumeration:

Hämta prenumerationen efter ID.
Skapa ett ScheduledNextTermInstructions-objekt och ange det till prenumerationens egenskap.
Anropa metoden Patch() för att uppdatera prenumerationen med de schemalagda ändringarna.

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);

REST-begäran

Syntax för begäran

Metod	URI för förfrågan
PATCH	{baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id} HTTP/1.1

URI-parameter

Den här tabellen visar de frågeparametrar som krävs för att anropa API:et.

Namn	Typ	Obligatoriskt	Beskrivning
customer-tenant-id	Guid	Y	Ett GUID som motsvarar kunden.
prenumerations-ID	Guid	Y	Ett GUID som motsvarar prenumerationen.

Begärandehuvuden

Mer information finns i REST-huvuden för Partnercenter.

Begärandetext

En fullständig prenumerationsresurs krävs i begärandetexten med egenskapen scheduledNextTermInstructions definierad. Om du vill schemalägga ändringar för din prenumeration kontrollerar du att egenskapen AutoRenewEnabled är inställd på true.

Fält	Typ	Obligatoriskt	Beskrivning
scheduledNextTermInstructions	Objekt	Y	Definierar nästa terminstruktioner för prenumerationen. Egenskapen innehåller objektet `product` och fältet `quantity` .

Exempel på begäran

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: ec8f62e5-1d92-47e9-8d5d-1924af105f2c
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"},
}

REST-svar

Om begäran lyckas returnerar den här metoden de uppdaterade egenskaperna för prenumerationsresursen i svarstexten.

Svarsframgång och felkoder

Varje svar levereras med en HTTP-statuskod som anger lyckad eller misslyckad och annan felsökningsinformation. Använd ett verktyg för nätverksspårning för att läsa den här koden, feltypen och andra parametrar. Den fullständiga listan finns i Felkoder.

Svarsexempel

HTTP/1.1 200 OK
Content-Length: 1322
Content-Type: application/json; charset=utf-8
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3831
MS-CorrelationId: ec8f62e5-1d92-47e9-8d5d-1924af105f2c
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"},
}

Dela via