Freigeben über

Ändern des Abrechnungsstatus eines Abonnements für einen Benutzer

Verwenden Sie diese Methode in der Microsoft Store-Einkaufs-API, um den Abrechnungsstatus eines Abonnement-Add-Ons für einen bestimmten Benutzer zu ändern. Sie können die automatische Verlängerung eines Abonnements kündigen, verlängern, erstatten oder deaktivieren.

Hinweis

Diese Methode kann nur von Entwicklerkonten verwendet werden, die von Microsoft bereitgestellt wurden, um Abonnement-Add-Ons für UWP-Apps (Universelle Windows-Plattform) erstellen zu können. Abonnement-Add-Ons sind derzeit für die meisten Entwicklerkonten nicht verfügbar.

Die Microsoft.StoreServices-Bibliothek stellt die Funktionalität dieser Methode über die StoreServicesClient.RecurrenceChangeAysnc-API bereit.

Voraussetzungen

Um diese Methode zu verwenden, benötigen Sie Folgendes:

  • Ein Azure AD-Zugriffstoken mit dem Zielgruppen-URI-Wert https://onestore.microsoft.com.
  • Ein Microsoft Store-ID-Schlüssel, der die Identität des Benutzers darstellt, der über eine Berechtigung für das Abonnement verfügt, das Sie ändern möchten.

Weitere Informationen finden Sie unter Verwalten von Produktberechtigungen über einen Dienst.

Anfrage

Anforderungssyntax

Methode Anforderungs-URI
SENDEN https://purchase.mp.microsoft.com/v8.0/b2b/recurrences/{recurrenceId}/change

Anforderungs-Kopfzeile

Kopfzeile Typ BESCHREIBUNG
Autorisierung Schnur Erforderlich. Das Azure AD-Zugriffstoken in der Form Bearer<token>.
Gastgeber Schnur Muss auf den Wert purchase.mp.microsoft.comfestgelegt werden.
Inhaltslänge Zahl Die Länge des Anforderungstexts.
Inhaltstyp Schnur Gibt den Anforderungs- und Antworttyp an. Derzeit ist der einzige unterstützte Wert application/json.

Anforderungsparameter

Name Typ BESCHREIBUNG Erforderlich
Wiederholungs-ID Schnur Die ID des Abonnements, das Sie ändern möchten. Um diese ID zu erhalten, rufen Sie die Methode ‚Abonnements eines Benutzers abrufen‘ auf, identifizieren Sie den Eintrag im Antworttext, der das Abonnement-Add-On darstellt, das Sie ändern möchten, und nutzen Sie den Wert des Felds ID für diesen Eintrag. Ja

Anfragekörper

Feld Typ BESCHREIBUNG Erforderlich
b2bKey Schnur Der Microsoft Store-ID-Schlüssel, der die Identität des Benutzers darstellt, dessen Abonnement Sie ändern möchten. Ja
Änderungstyp Schnur Eine der folgenden Zeichenfolgen, die den Typ der Änderung identifiziert, die Sie vornehmen möchten:
  • Kündigen: Kündigt das Abonnement.
  • Erweitern: Erweitert das Abonnement. Wenn Sie diesen Wert angeben, müssen Sie auch den parameter extensionTimeInDays einschließen.
  • Rückerstattung: Erstattet das Abonnement an den Kunden.
  • ToggleAutoRenew: Deaktiviert die automatische Verlängerung für dieses Abonnement. Wenn die automatische Verlängerung derzeit für das Abonnement deaktiviert ist, führt dieser Wert nichts aus.
 Ja
VerlängerungszeitInTagen Schnur Wenn der parameter changeType den Wert Extendaufweist, gibt dieser Parameter die Anzahl der Tage an, die das Abonnement verlängern sollen. Ja, wenn changeType den Wert Extendhat; andernfalls nein.

Beispielanfrage

Im folgenden Beispiel wird veranschaulicht, wie Sie diese Methode verwenden, um den Abonnementzeitraum um 5 Tage zu verlängern. Ersetzen Sie den wert b2bKey durch den Microsoft Store ID-Schlüssel, der die Identität des Benutzers darstellt, dessen Abonnement Sie ändern möchten.

POST https://purchase.mp.microsoft.com/v8.0/b2b/recurrences/mdr:0:bc0cb6960acd4515a0e1d638192d77b7:77d5ebee-0310-4d23-b204-83e8613baaac/change HTTP/1.1
Authorization: Bearer <your access token>
Content-Type: application/json
Host: https://purchase.mp.microsoft.com

{
  "b2bKey":  "eyJ0eXAiOiJ...",
  "changeType": "Extend",
  "extensionTimeInDays": "5"
}

Antwort

Diese Methode gibt einen JSON-Antworttext zurück, der Informationen zum geänderten Abonnement-Add-On enthält, einschließlich aller Felder, die geändert wurden. Im folgenden Beispiel wird ein Antwortinhalt für diese Methode veranschaulicht.

{
  "items": [
    {
      "autoRenew":true,
      "beneficiary":"pub:gFVuEBiZHPXonkYvtdOi+tLE2h4g2Ss0ZId0RQOwzDg=",
      "expirationTime":"2017-06-16T03:07:49.2552941+00:00",
      "id":"mdr:0:bc0cb6960acd4515a0e1d638192d77b7:77d5ebee-0310-4d23-b204-83e8613baaac",
      "lastModified":"2017-01-10T21:08:13.1459644+00:00",
      "market":"US",
      "productId":"9NBLGGH52Q8X",
      "skuId":"0024",
      "startTime":"2017-01-10T21:07:49.2552941+00:00",
      "recurrenceState":"Active"
    }
  ]
}

Antwortkörper

Der Antworttext enthält die folgenden Daten.

Wert Typ BESCHREIBUNG
automatische Verlängerung Boolescher Typ (Boolean) Gibt an, ob das Abonnement für die automatische Verlängerung am Ende des aktuellen Abonnementzeitraums konfiguriert ist.
Begünstigter Schnur Die ID des Begünstigten der Berechtigung, die diesem Abonnement zugeordnet ist.
Ablaufzeit Schnur Das Datum und die Uhrzeit, zu denen das Abonnement abläuft, im ISO 8601-Format. Dieses Feld ist nur verfügbar, wenn sich das Abonnement in bestimmten Status befindet. Die Ablaufzeit gibt in der Regel an, wann der aktuelle Zustand abläuft. Beispielsweise gibt das Ablaufdatum für ein aktives Abonnement an, wann die nächste automatische Verlängerung erfolgt.
AblaufzeitMitKulanz Schnur Das Datum und die Uhrzeit, zu dem das Abonnement abläuft, einschließlich des Karenzzeitraums im ISO 8601-Format. Dieser Wert gibt an, wann der Benutzer den Zugriff auf das Abonnement verliert, nachdem das Abonnement nicht automatisch verlängert wurde.
id Schnur Die ID des Abonnements. Verwenden Sie diesen Wert, um anzugeben, welches Abonnement Sie ändern möchten, wenn Sie die Methode aufrufen, um den Abrechnungsstatus eines Abonnements für einen Benutzer zu ändern.
isTrial Boolescher Typ (Boolean) Gibt an, ob das Abonnement eine Testversion ist.
zuletzt geändert Schnur Datum und Uhrzeit der letzten Änderung des Abonnements im ISO 8601-Format.
Markt Schnur Der Ländercode (im Zwei-Buchstaben-ISO 3166-1-Alpha-2-Format), in dem der Benutzer das Abonnement erworben hat.
Produkt-ID Schnur Die Store-ID für das Produkt, das das Abonnement-Add-On im Microsoft Store-Katalog darstellt. Eine Beispiel-Store-ID für ein Produkt ist 9NBLGGH42CFD.
SKU-Nummer Schnur Die Store-ID für die SKU, die die Abonnement-Erweiterung im Katalog des Microsoft Stores darstellt. Eine Beispiel-Store-ID für eine SKU ist 0010.
Startzeit Schnur Das Startdatum und die Startzeit des Abonnements im ISO 8601-Format.
Wiederholungsstatus Schnur Einer der folgenden Werte:
  • Keine: Dies gibt ein unbefristetes Abonnement an.
  • Active: Das Abonnement ist aktiv und der Benutzer ist berechtigt, die Dienste zu nutzen.
  • Inaktive: Das Abonnement liegt über dem Ablaufdatum und der Benutzer hat die Option für die automatische Verlängerung für das Abonnement deaktiviert.
  • Stornierte: Das Abonnement wurde absichtlich vor dem Ablaufdatum mit oder ohne Rückerstattung gekündigt.
  • InDunning-: Das Abonnement befindet sich in dunning (d. a. das Abonnement läuft bald ab und Microsoft versucht, Guthaben zu erwerben, um das Abonnement automatisch zu verlängern).
  • Fehlgeschlagene: Der Mahnzeitraum ist abgelaufen, und das Abonnement wurde nach mehreren Versuchen nicht verlängert.

Anmerkung:

  • Inaktiv/Abgebrochen/Fehlgeschlagen sind Terminalzustände. Wenn ein Abonnement einen dieser Zustände eingibt, muss der Benutzer das Abonnement erneut erwerben, um es erneut zu aktivieren. Der Nutzer ist nicht berechtigt, die Dienste in diesen Zuständen zu nutzen.
  • Wenn ein Abonnement storniert, wird die Ablaufzeit mit dem Datum und der Uhrzeit der Stornierung aktualisiert.
  • Die ID des Abonnements bleibt während der gesamten Lebensdauer gleich. Sie wird nicht geändert, wenn die Option für die automatische Verlängerung aktiviert oder deaktiviert ist. Wenn ein Benutzer ein Abonnement nach Erreichen eines Terminalzustands erneut kauft, wird eine neue Abonnement-ID erstellt.
  • Die ID eines Abonnements sollte verwendet werden, um jegliche Operation an einem einzelnen Abonnement auszuführen.
  • Wenn ein Benutzer ein Abonnement nach der Kündigung oder Beendigung erneut kauft, erhalten Sie zwei Einträge: einen mit der alten Abonnement-ID in einem terminalen Zustand und einen mit der neuen Abonnement-ID in einem aktiven Zustand.
  • Es empfiehlt sich immer, sowohl recurrenceState als auch expirationTime zu überprüfen, da Updates für recurrenceState möglicherweise um ein paar Minuten (oder gelegentlich Stunden) verzögert werden können.
Stornierungsdatum Schnur Datum und Uhrzeit der Kündigung des Abonnements des Benutzers im ISO 8601-Format.
  • Last updated on