Abonnementinformationen abrufen

Informationen über Abonnementaktivitäten lassen sich auf die folgenden Arten abrufen:

• Informationen mithilfe von API-Aufrufen abrufen (geeignet für serverlose Integration)
• Informationen bei Änderung des Abonnementstatus mithilfe von Webhooks automatisch abrufen (geeignet für Serverintegration)

Über API-Aufrufe einrichten

Geben Sie die Projekt-ID als Pfadparameter projectId an. Sie finden diesen Parameter im Kundenportal neben dem Projektnamen.

Legen Sie als Abfrageparameter Folgendes fest:

• limit – Obergrenze für die Anzahl der Elemente pro Seite (standardmäßig werden 15 Elemente angezeigt).
• offset – Elementnummer, bei der die Liste beginnt (die Zählung beginnt bei 0).
• locale – Sprache der Benutzeroberfläche (standardmäßig ist Englisch voreingestellt). Eingabewerte müssen der Norm ISO 639-1 entsprechen.

curl -X 'GET' \
  'https://subscriptions.xsolla.com/api/user/v1/projects/{projectId}/subscriptions?locale=ru&limit=5&offset=5 ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'

{
  "items": [
    {
      "id": 11111111,
      "plan_id": 11111,
      "plan_external_id": "TestChangePlanBase",
      "plan_name": "package_recurrent_name_66053",
      "plan_description": "package_recurrent_description_66053",
      "product_id": null,
      "product_external_id": null,
      "product_name": null,
      "product_description": null,
      "status": "active",
      "date_create": "2021-03-11T13:50:11+03:00",
      "date_next_charge": "2031-04-11T13:51:02+03:00",
      "date_last_charge": "2021-03-11T13:51:02+03:00",
      "charge": {
        "amount": "0.2500",
        "currency": "USD"
      },
      "period": {
        "value": 1,
        "unit": "day"
      }
    }
  ],
  "has_more": true
}

Webhooks einrichten

Die Subscriptions-Lösung unterstützt Webhooks für die folgenden Ereignisse:

• Für ein Abonnement zahlen:
  • Benutzervalidierung
  • Zahlung
  • Abgeschlossenes Abonnement

• Abonnement verlängern:
  • Benutzervalidierung
  • Zahlung
  • Aktualisiertes Abonnement
• Abonnement kündigen: Gekündigtes Abonnement (Abonnement wurde im Kundenportal gekündigt oder alle Zahlungen wurden für alle gültigen Zeiträume storniert)

• Erstattung:
  • Rückerstattung (Zahlung wurde im Kundenportal storniert)
  • Aktualisiertes Abonnement (Die Zahlung wurde storniert, das Abonnement ist aber noch aktiv. Das kann passieren, wenn der Benutzer versehentlich zweimal für das Abonnement bezahlt und nur die letzte Zahlung storniert hat.)
  • Gekündigtes Abonnement (Zahlung wurde im Kundenportal storniert oder alle Zahlungen wurden für alle gültigen Zeiträume storniert)

1. Navigieren Sie im Kundenportal zu Projekteinstellungen > Webhooks.
2. Stellen Sie den Umschalter im Block Webhooks auf Ein.

3. Geben Sie Ihre Webhook-URL an. Klicken Sie auf Einstellungen speichern.

4. Testen Sie die Webhooks im Kundenportal.
5. Testen Sie den Abonnementabschluss.
6. Testen Sie die Abonnementverlängerung.
7. Testen Sie die Abonnementkündigung.

Webhooks im Kundenportal testen

1. Navigieren Sie zu Kundenportal > Projekteinstellungen > Webhooks, und wechseln Sie dort zur Registerkarte Subscriptions.

2. Um Webhooks zu testen, geben Sie Werte aus Ihrem Projekt (Benutzer-ID, Rechnungs-ID) an, die in einer Anfrage an die von Ihnen angegebene Webhook-URL gesendet werden sollen. Falls reale Werte fehlen, können Sie beliebige Werte eingeben. Füllen Sie die folgenden Formularfelder aus:
   • Benutzer-ID
   • Xsolla-Rechnungs-ID
   • Betrag
   • Währung
   • ID des Abo-Modells
   • Abo-Produkt (optional)
   • Rechnungs-ID – interne Bestellnummer (optional)
   • Probezeitraum (Legen Sie zum Testen des Abonnementabschlusses in der Testumgebung oder zum Testen der Abonnementverlängerung als Wert 0 fest.)

3. Klicken Sie auf Test.
4. Bestätigen Sie, dass Sie die Testnachricht erhalten haben. Sofern der Test erfolgreich ist, antwortet Ihr Server mit dem HTTP-Statuscode 204. Schlägt der Test fehl, antwortet Ihr Server entweder mit dem HTTP-Statuscode 400 oder 500 sowie einer Fehlerbeschreibung.

Abonnementabschluss testen

• die Testumgebung nutzen (für Abonnement mit einem Probezeitraum von 0 Tagen)
• eine echte Zahlung vornehmen und dann eine Erstattung über das Kundenportal veranlassen (für Abonnement mit einem Probezeitraum von mehr als 0 Tagen)

Testumgebung

1. Rufen Sie einen Token für die Testumgebung ab. Übermitteln Sie den Wert 0 an den Probezeitraum-Parameter (trial_days).
2. Wählen Sie die Zahlungsmethodengruppe Kredit-/Debitkarten aus.
3. Geben Sie die Daten einer Testbankkarte ein. Geben Sie in den übrigen Felder beliebige Werte ein. Sie können auch falsche Daten (Kartennummer, Ablaufdatum oder CVV) angeben, um einen Fehler zu erzeugen.

4. Empfangen Sie die Benutzervalidierung-, Zahlung- und Aktualisiertes Abonnement-Webhooks unter der von Ihnen im Schritt Webhooks einrichten angegebenen URL.

Echte Zahlung

1. Testen Sie zunächst die Webhooks im Kundenportal, und aktivieren Sie das Modul Subscriptions.
2. Unterzeichnen Sie die Lizenzvereinbarung.

3. Rufen Sie einen Token ab, um eine echte Zahlungen zu ermöglichen.

4. Öffnen Sie das Zahlungsportal mit dem folgenden Link: https://secure.xsolla.com/paystation4/?token=ACCESS_TOKEN, wobei ACCESS_TOKEN dem im vorherigen Schritt erlangten Token entspricht.
5. Wählen Sie die Zahlungsmethodengruppe Kredit-/Debitkarten.
6. Geben Sie gültige Bankkartendaten ein.

7. Empfangen Sie Benutzervalidierung-, Zahlung- und Aktualisiertes Abonnement-Webhooks über die von Ihnen im Schritt Webhooks einrichten angegebene Webhook-URL.
8. Erstatten Sie Ihre Zahlung. Navigieren Sie dafür zu Kundenportal > Support > Transaktionssuche.
9. Wählen Sie die testweise getätigte Transaktion aus, und klicken Sie auf die Schaltfläche Mehr (•••). Klicken Sie danach im Pop-up-Menü auf Erstatten (die Transaktion sollte den Status Abgeschlossen aufweisen). Daraufhin werden die Webhooks Gekündigtes Abonnement und Rückerstattung gesendet.

Abonnementverlängerung testen

1. Rufen Sie einen Token für die Testumgebung ab. Übermitteln Sie den Wert 0 an den Probezeitraum-Parameter (trial_days).
2. Bezahlen Sie für das Abonnement mit einer beliebigen Zahlungsmethode.
3. Öffnen Sie das Zahlungsportal erneut in der Testumgebung.
4. Zahlen Sie erneut mit einer beliebigen Zahlungsmethode, um das Abonnement zu verlängern.
5. Empfangen Sie die Webhooks Benutzervalidierung, Zahlung und Aktualisiertes Abonnement an der von Ihnen im Schritt Webhooks einrichten angegebenen Webhook-URL.

Abonnementkündigung testen

• Suche anhand von Abonnements
• Suche anhand kürzlicher Transaktionen
• API-Aufrufe

Suche anhand von Abonnements

1. Navigieren Sie im Kundenportal zu Support > Abonnenten.
2. Suchen Sie das zu kündigende Abonnement.
3. Öffnen Sie das Abonnementstatusmenü und wählen Sie Folgendes aus:
   1. Kündigen und erstatten, um den Gekündigtes Abonnement- und den Rückerstattung-Webhook zu empfangen.
   2. Ohne Erstattung kündigen, um den Gekündigtes Abonnement-Webhook zu empfangen.

Suche anhand kürzlicher Transaktionen

1. Navigieren Sie im Kundenportal zu Support > Transaktionssuche.
2. Suchen Sie die kürzlich getätigten Transaktionen, die Sie stornieren möchten.
3. Klicken Sie auf das Symbol Mehr (•••). Klicken Sie im Pop-up-Menü auf Erstatten, um den Gekündigtes Abonnement- und den Rückerstattung-Webhook zu empfangen.

Über API-Aufrufe

Zahlungsportal in der Testumgebung öffnen

• Über das Kundenportal
• Über einen API-Aufruf

Über das Kundenportal

1. Testen Sie Webhooks im Kundenportal. Geben Sie den Wert 0 im Feld Probezeitraum ein, um ein Abonnement ohne Probezeitraum zu testen. Nachdem Sie eine Bestätigungsmeldung über einen erfolgreichen Test erhalten haben, wird ein Link mit dem erforderlichen Token unter der Überschrift URL der Testumgebung angezeigt.

2. Klicken Sie auf den Link mit der Bezeichnung URL der Testumgebung.

Über einen API-Aufruf

1. Übermitteln Sie die Parameter "settings":{"mode":"sandbox"} an die Methode Token erstellen. Übermitteln Sie die Parameter "purchase": {"subscription":{"trial_days": 0}}, um ein Abonnement ohne Probezeitraum zu testen.
2. Nutzen Sie dafür den folgenden Link: https://sandbox-secure.xsolla.com/paystation4/?token=ACCESS_TOKEN, wobei ACCESS_TOKEN dem im vorherigen Schritt abgerufenen Token entspricht.