Deep-Links im Kundenportal

Entwerfen Sie optimierte Kundenabläufe mit der Kundenportal-API.

Mit dem Kundenportal können Sie Ihren Kundinnen/Kunden die Verwaltung von Abonnements und Zahlungsmethoden anbieten, ohne es selbst erstellen zu müssen. Wenn Sie Kundenaktionen optimieren und die Arbeitsabläufe zwischen Ihrer eigenen App und Stripe weiter anpassen möchten, können Sie einen flow für das Kundenportal erstellen.

Kundenportalabläufe

Ein Ablauf ist ein anpassbarer Deep-Link zum Kundenportal. Portalabläufe bieten Ihnen folgende Möglichkeiten:

Deep-Link direkt zu der Seite mit der angegebenen Aktion, die Ihre Kund/innen ausführen müssen. Die Navigationskomponenten für den Zugriff auf den Rest des Kundenportals sind ausgeblendet, sodass sich der/die Kund/in auf eine einzelne Aktion konzentrieren kann.
Passen Sie das Weiterleitungsverhalten an, nachdem der/die Kund/in die Aktion abgeschlossen hat. Leiten Sie ihn/sie sofort zu Ihrer eigenen URL, zu einer gehosteten Bestätigungsseite oder zurück zur Portal-Startseite weiter.
Personalisieren Sie den Ablauf mit interessanten Optionen wie vorausgefüllten Promo-Codes oder nutzerdefinierten Nachrichten.

Ablauftypen

Der Typ eines Ablaufs definiert, welchen einzelnen Ablauf oder welche Aktion Ihr Kunde/Ihre Kundin ausführt. Nachfolgend finden Sie die derzeit verfügbaren Ablauftypen:

Ablauftyp	Beschreibung	Beispiel
`payment_method_update`	Verwenden Sie `payment_method_update`, damit Ihre Kund/innen eine neue Zahlungsmethode hinzufügen können. Als Zahlungsmethode ist `customer.invoice_settings.default_payment_method` festgelegt.	Ablauf zur Aktualisierung der Zahlungsmethode
`subscription_cancel`	Verwenden Sie `subscription_cancel`, damit Ihre Kund/innen ein bestimmtes Abonnement kündigen können. Sie können festlegen, ob das Abonnement sofort oder zum Ende des Zeitraums gekündigt wird, indem Sie Ihre Portalkonfiguration über die API oder das Dashboard aktualisieren.	Ablauf zum Kündigen eines Abonnements
`subscription_update`	Verwenden Sie `subscription_update`, damit Ihre Kund/innen verschiedene Aktualisierungsoptionen auswählen können, z. B. ein Upgrade oder Downgrade auf einen anderen Plan oder eine Aktualisierung der aktuellen Planmenge. Sie können die verfügbaren Pläne anpassen, indem Sie Ihre Portalkonfiguration über die API oder das Dashboard aktualisieren.	Ablauf zur Aktualisierung eines Abonnements
`subscription_update_confirm`	Verwenden Sie `subscription_update_confirm`, damit Ihre Kund/innen ein bestimmtes Update ihres Abonnements bestätigen können. Sie können diese Option verwenden, wenn Sie über Ihre eigene Seite mit Preisinformationen verfügen, aber die Arbeit der Anzeige von Aktualisierungsdetails wie zum Beispiel anstehende Rechnungen und anteilsmäßige Verrechnungen, die Bearbeitung von Zahlungsausfällen oder die Handhabung der 3D Secure-Authentifizierung auslagern möchten. Sie können auch einen Gutschein oder einen Promo-Code angeben, der auf die Abonnement-Aktualisierung angewendet werden soll. Sie können dies für Werbekampagnen verwenden, wenn Sie einen Rabatt für den Wechsel zu einem anderen Plan anbieten.	Ablauf zur Bestätigung der Abonnement-Aktualisierung

Ablauf erstellen

Notiz

Bei Kundenportalabläufen handelt es sich um eine Erweiterung der Kundenportal-API. Befolgen Sie zuerst den allgemeinen Leitfaden zur Vernetzung des Kundenportals mit der API, bevor Sie diesen Leitfaden verwenden.

Um einen Ablauf zu erstellen, geben Sie beim Erstellen einer Portalsitzung flow_data an.

Legen Sie den Typ des Ablaufs fest, den Ihr Kunde/Ihre Kundin ausführen soll. Je nach type des Ablaufs müssen Sie möglicherweise zusätzliche Daten wie zum Beispiel eine Abonnement-ID übergeben.

Im Folgenden finden Sie Beispiele für die Einrichtung der einzelnen Ablauftypen.

Die url der Portalsitzung für die Antwort enthält jetzt einen Deep-Link zu dem von Ihnen erstellten Ablauf. Verwenden Sie diese URL, um Kund/innen von Ihrer Website an den Portalablauf weiterzuleiten.

Verhalten nach Abschluss anpassen

Nachdem Ihr/e Kund/in den Ablauf erfolgreich abgeschlossen hat, wird eine lokalisierte Bestätigungsseite mit den Details der abgeschlossenen Aktualisierung angezeigt. Sie können die Bestätigungsnachricht auf dieser Seite anpassen, sie zu einer URL Ihrer Wahl weiterleiten oder sie zurück zur Startseite des Kundenportals leiten, auf der die vollständigen Kontodetails angezeigt werden.

Um dieses Verhalten anzupassen, legen Sie after_completion für flow_data fest.

Im folgenden Beispiel können Ihre Kund/innen ihr Abonnement kündigen und werden anschließend zu Ihrer eigenen Website zurückgeleitet:

Notiz

Die oberste return_url ist ein Link zurück zu Ihrer Website, den der/die Kund/in jederzeit anklicken kann (z. B. wenn er/sie die Kündigung nicht durchführen möchte). Die flow_data[after_completion][redirect][return_url] ist ein Link zurück zu Ihrer Website, nachdem ein/e Kund/in sein/ihr Abonnement erfolgreich gekündigt hat.