Overgang naar een nieuw commerce-abonnement

Van toepassing op: Partnercentrum | Partnercentrum beheerd door 21Vianet | Partnercentrum voor Microsoft Cloud voor de Amerikaanse overheid

Juiste rollen

  • Beheeragent

Deze methoden ondersteunen zowel traditionele als nieuwe commerce-bronabonnementen.

Notitie

De nieuwe commerce-ervaringen voor services op basis van licenties bevatten veel nieuwe mogelijkheden en zijn beschikbaar voor alle CSP's (Cloud Solution Provider). Zie het overzicht van de nieuwe commerce-ervaringen voor meer informatie.

Wordt gebruikt om het nieuwe commerce-abonnement van een klant te upgraden naar een doelabonnement of om een NCE-proefversie te converteren naar een betaald abonnement. Als u een abonnement wilt overstappen, moeten er twee API-aanvragen worden gedaan. Haal eerst beschikbare transities op met GET om de SKU's te verkrijgen die in aanmerking komen voor upgrade. Gebruik vervolgens POST transitie om de transitie uit te voeren.

Geschiktheden voor overgang ophalen

Retourneert een lijst met in aanmerking komende overgangen voor een bepaalde klant, abonnement en aangevraagd type. Geeft ook terug of een upgrade van het doelabonnement mogelijk is. Voorwaarden voor overgang kunnen aanbiedingen bevatten die de status EndofSaleWithConversions hebben.

Vereisten

  • Aanmeldingsgegevens zoals beschreven in Partner Center-verificatie. Dit scenario ondersteunt verificatie met zowel zelfstandige app- als app+gebruikersreferenties.

  • Een klant-ID (customer-tenant-id). Als u de klant-id niet weet, kunt u deze opzoeken in Partnercentrum door de werkruimte Klanten te selecteren, vervolgens de klant in de klantenlijst en daarna Account. Zoek op de pagina Account van de klant naar de Microsoft-id in de sectie Klantaccountgegevens . De Microsoft-id is hetzelfde als de klant-id (customer-tenant-id).

  • Een abonnements-id voor het eerste abonnement.

GDAP-rollen

U hebt ten minste een van de volgende GDAP-rollen nodig:

  • Maplezer
  • Globale lezer

Notitie

Hoewel deze API beschikbaar is voor verouderd en NCE, is GDAP alleen vereist voor verouderde versies.

REST-aanvraag

Aanvraagsyntaxis

Wijze URI van de aanvraag
GET {baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id}/transitionEligibilities?eligibilityType={immediate, scheduled} HTTP/1.1

URI-parameter

Gebruik de volgende queryparameters om in aanmerking komende overgangen te retourneren.

Name Type Vereist Beschrijving
customer-tenant-id guid Y Een GUID die overeenkomt met de tenant van de klant.
subscription-id guid Y Een GUID die hoort bij het oorspronkelijke abonnement.
eligibilityType string N Beschrijft wanneer de overgang moet worden uitgevoerd; kan direct of gepland worden. De standaardwaarde is Immediate.

Aanvraagheaders

Zie REST-headers in Partnercentrum voor meer informatie.

Hoofdtekst van de aanvraag

Geen

Aanvraagvoorbeeld

GET https://api.partnercenter.microsoft.com/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id}/transitionEligibilities?eligibilityType=immediate HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US

REST-antwoord

Als dit lukt, retourneert deze methode een lijst met de in aanmerking komende overgangen voor het opgegeven abonnement in de hoofdtekst van het antwoord.

Geslaagde antwoorden en foutcodes

Elk antwoord gaat vergezeld van een HTTP-statuscode die aangeeft of er sprake is van succes of een fout, plus aanvullende foutopsporingsinformatie. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en andere parameters te lezen. Voor de volledige lijst, zie Foutcodes.

Geschiktheidsfouten

Foutbeschrijvingen en betekenis.

Foutbeschrijving Betekenis
Abonnement kan niet worden overgezet. Het bronabonnement is niet actief. Oorspronkelijke substatus niet actief
Abonnement kan niet worden overgezet. Het bronabonnement is nog niet ingericht. De oorspronkelijke substatus FulfillmentState is niet succesvol
Overgangstype is niet compatibel. Toewijzing van AzureAD-abonnementen is vereist. LegacyCannotConvertSubscriptionId-fout bij het aanroepen van GetSubscriptionUpgradeConflicts
Overgangstype is niet compatibel: conflicterende abonnementen voor licentieoverdracht bestaan. Als een Microsoft Entra-service abonnements-id's van een ander abonnement heeft, voegt u deze toe aan de lijst met conflicten (inclusief aankopen die zijn gedaan met een verouderde of moderne aankoopstroom)

Fouten in geschiktheid voor abonnementen

Als niet naar een doelabonnement kan worden geüpgraded, wordt een van de volgende redenen weergegeven.

Lege lijsten worden geretourneerd als het bronabonnement een proefversie is of als het geschiktheidstype is opgegeven als Gepland. U kunt alleen overstappen naar een bestaand abonnement met een directe (ook wel 'midterm'-overgang genoemd), niet een geplande wijziging.

Foutbeschrijving Foutcode
Abonnement is niet actief. SubscriptionNotActive = 1
Abonnement bevindt zich in het annuleringsvenster. SubscriptionInCancellationWindow = 2
De duur van de abonnementsperiode is korter dan de duur van het bronabonnement. SubscriptionTermDurationShorterThanSourceTermDuration = 3
De einddatum van de abonnementsperiode valt vóór de einddatum van de term van het bronabonnement. De einddatum van de abonnementsperiode valt vóór de einddatum van de term van het bronabonnement. = 4

Responsvoorbeeld

HTTP/1.1 200 OK
Content-Length: 138
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
Date: Fri, 26 Feb 2021 20:42:26 GMT

{
  "totalCount": 2,
  "items": [
    {
      "operationId": "1caf8ec7-62cc-4ab5-b35d-572d2a62974c",
      "catalogItemId": "CFQ7TTC0KZCR:0001:CFQ7TTC0K71H",
      "title": "Microsoft 365 E5 Test Sku Title",
      "description": "Microsoft 365 E5 Test Sku Description",
      "quantity": 1,
      "subscriptionEligibilities": [
        {
          "isEligible": false,
          "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
          "subscriptionFriendlyName": "Microsoft 365 Business Premium",
          "subscriptionTermDuration": "P1M",
          "subscriptionBillingCycle": "monthly",
          "errors": [
            {
              "code": 3,
              "description": "The subscription's term duration is shorter than the source subscription's term duration."
            }
          ]
        },
        {
          "isEligible": true,
          "subscriptionId": "bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f",
          "subscriptionFriendlyName": "Microsoft 365 Business Premium",
          "subscriptionTermDuration": "P1Y",
          "subscriptionBillingCycle": "monthly",
          "errors": []
        }
      ],
      "eligibilities": [
        {
          "isEligible": true,
          "transitionType": "transition_only",
          "errors": []
        },
        {
          "isEligible": false,
          "transitionType": "transition_with_license_transfer",
          "errors": [
            {
              "code": 3,
              "description": "Subscription cannot be transitioned because there are conflicting services."
            }
          ]
        }
      ],
      "attributes": {
        "objectType": "TransitionEligibility"
      }
    },
    {
      "operationId": "1caf8ec7-62cc-4ab5-b35d-572d2a62974c",
      "catalogItemId": "CFQ7TTC0L4M3:0001:CFQ7TTC0K78T",
      "title": "Business Premium Test Sku Title",
      "description": "Business Premium Test Sku Description",
      "quantity": 1,
      "eligibilities": [
        {
          "isEligible": false,
          "transitionType": "transition_with_license_transfer",
          "errors": [
            {
              "code": 3,
              "description": "Subscription cannot be transitioned because there are conflicting services."
            }
          ]
        }
      ],
      "attributes": {
        "objectType": "TransitionEligibility"
      }
    }
  ],
  "attributes": {
    "objectType": "Collection"
  }
}

Antwoordvoorbeeld voor toegestane overgangsdatums

Bepaalde driejarige SKU's met Teams maken het voor partners in Europa mogelijk over te stappen op SKU's zonder Teams. Deze overgangen kunnen alleen plaatsvinden op de verjaardata zoals gedefinieerd in het resultaat van de overgangsgeschiktheid en de toegestane datums.

HTTP/1.1 200 OK
Content-Length: 138
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
Date: Fri, 26 Feb 2021 20:42:26 GMT

{ 
    "totalCount": 1, 
    "items": [ 
        { 
            "catalogItemId": "CFQ7TTBZZR6H:001L:CFQ7TTC0K994", 
            "title": "Microsoft 365 E7 - 3 year", 
            "description": "Microsoft 365 E5, Microsoft 365 Copilot, Agent 365, and Entra Suite. This per-user licensed suite of products offers customers the latest, most advanced, productivity, security, and AI for user and user's agents.", 
            "quantity": 100, 
            "subscriptionEligibilities": [], 
            "transitionAllowedDates": ["2026-08-01T00:00:00Z", "2027-08-01T00:00:00Z"],  // This field will show up only if applicable 
            "eligibilities": [ 
                { 
                    "isEligible": true, 
                    "transitionType": "transition_only", 
                    "errors": [] 
                }, 
                { 
                    "isEligible": true, 
                    "transitionType": "transition_with_license_transfer", 
                    "errors": [] 
                } 
            ], 
            "attributes": { 
                "objectType": "TransitionEligibility" 
            } 
        }] 
} 

Na de overgang

Plaatst een overgangsaanvraag voor een bepaalde klant en een bepaald abonnement. Retourneert de overgang met de oorspronkelijke status.

Vereisten

  • Aanmeldingsgegevens zoals beschreven in Partner Center-verificatie. Dit scenario ondersteunt verificatie met zowel zelfstandige app- als app+gebruikersreferenties.

  • Een klant-ID (customer-tenant-id). Als u de klant-id niet weet, kunt u deze opzoeken in Partnercentrum door de werkruimte Klanten te selecteren, vervolgens de klant in de klantenlijst en daarna Account. Zoek op de pagina Account van de klant naar de Microsoft-id in de sectie Klantaccountgegevens . De Microsoft-id is hetzelfde als de klant-id (customer-tenant-id).

  • Een abonnements-id voor het eerste abonnement.

GDAP-rollen

U hebt ten minste een van de volgende GDAP-rollen nodig:

  • Adreslijstlezer of Globale lezer (alleen voor overgang)
  • Directory Writer (overgang met licentieoverdracht)

Notitie

Hoewel deze API beschikbaar is voor verouderd en NCE, is GDAP alleen vereist voor verouderde versies.

REST-aanvraag

Aanvraagsyntaxis

Wijze URI van de aanvraag
POST {baseURL}/v1/customers/{customer-tenant-id}/subscriptions/{subscription-id}/transitions HTTP/1.1

URI-parameter

Gebruik de volgende queryparameters om een overgang uit te voeren.

Name Type Vereist Beschrijving
customer-tenant-id guid Y Een GUID die overeenkomt met de tenant van de klant.
subscription-id guid Y Een GUID die hoort bij het oorspronkelijke abonnement.

Aanvraagheaders

Zie REST-headers in Partnercentrum voor meer informatie.

Hoofdtekst van de aanvraag

In deze tabel worden de eigenschappen van Transition in de aanvraagtekst beschreven.

Eigenschap Type Vereist Beschrijving
fromCatalogItemId tekenreeks Nee Het catalogusitem waaruit u overstapt.
fromSubscriptionId tekenreeks Nee De abonnements-id van waaruit u overstapt.
toCatalogItemId tekenreeks Ja Het catalogusitem waarnaar u overstapt.
toSubscriptionId tekenreeks Nee De abonnements-id waarnaar u overstapt.
hoeveelheid geheel getal Ja Het aantal licenties dat moet worden overgedragen.
termDuration tekenreeks Nee De abonnementsduur opgeven.
billingCycle tekenreeks Nee De factureringscyclus van het abonnement opgeven.
transitionType tekenreeks Ja Het overgangstype. Mogelijke waarden - transition_only, transition_with_license_transfer.

Aanvraagvoorbeeld

POST https://api.partnercenter.microsoft.com/v1/customers/{customerId}/subscriptions/{subscriptionId}/transitions HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US

{
    "fromCatalogItemId": "CFQ7TTC0LF8Q:0001:CFQ7TTC0K39X",
    "fromSubscriptionId": "e487e8dc-421e-4275-cb42-3c1c8daccf70",
    "toCatalogItemId": "CFQ7TTC0LF8R:0001:CFQ7TTC0KCSV",
    "toSubscriptionId": "0af52192-4a2a-4364-d25b-c8ecab3a5697",
    "quantity": 2,
    "termDuration": "P1M",
    "billingCycle": "Monthly",
    "transitionType": "transition_only"
}

REST-antwoord

Als dit lukt, retourneert deze methode een Transition-resource met de initiële status.

Geslaagde antwoorden en foutcodes

Elk antwoord gaat vergezeld van een HTTP-statuscode die aangeeft of er sprake is van succes of een fout, plus aanvullende foutopsporingsinformatie. Gebruik een hulpprogramma voor netwerktracering om deze code, het fouttype en andere parameters te lezen. Voor de volledige lijst, zie Foutcodes.

Responsvoorbeeld

HTTP/1.1 200 OK
Content-Length: 138
Content-Type: application/json
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 18752a69-1aa1-4ef7-8f9d-eb3681b2d70a
Date: Fri, 26 Feb 2021 20:42:26 GMT

{
    "fromCatalogItemId": "CFQ7TTC0LF8Q:0001:CFQ7TTC0K39X",
    "fromSubscriptionId": "e487e8dc-421e-4275-cb42-3c1c8daccf70",
    "toCatalogItemId": "CFQ7TTC0LF8R:0001:CFQ7TTC0KCSV",
    "toSubscriptionId": "0af52192-4a2a-4364-d25b-c8ecab3a5697",
    "quantity": 2,
    "termDuration": "P1M",
    "billingCycle": "Monthly",
    "transitionType": "transition_only"
    "Events": [
        {
            "name": "Conversion",
            "status": "Started ",
            "timestamp": "2021-01-08T18:01:14.7488618Z",
            "attributes":
            {
                "objectType": "TransitionEvent"
            }
        }
    ],
    "attributes":
    {
        "objectType": "Transition" 
    }
}