Integrieren Sie das Kundenportal mit der API

First, you need to register for a Stripe account.

Before you integrate the customer portal, use the Dashboard to define what your users can do with the portal. Choose your settings for sandboxes and live mode, based on your product and price catalog.

If you want to create multiple portal configurations for different sets of customers (or if you’re a Connect platform and want to manage configurations for your connected accounts), you can do so using the API:

curl https://api.stripe.com/v1/billing_portal/configurations \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "features[invoice_history][enabled]"=true

Produktkatalog einrichten

If you allow customers to upgrade, downgrade, or change the quantities of their subscriptions, you must also set a product catalog. This includes the products and prices that your customers can upgrade or downgrade to, and the subscriptions they can update quantities on. See how to create a product for more details about creating products and prices. If you’re using the customer portal for invoicing only, you don’t need to set a product catalog.

Das Portal zeigt die folgenden Attribute Ihres Produktkatalogs an:

• Product name and description—These attributes are editable in the Dashboard and API.
• Quantity restrictions per product—These attributes are editable in the Dashboard.
• Price amount, currency, and billing interval—These attributes are fixed, and you can only set them when you create them in the Dashboard and API.

Erfassung von Steuer-IDs aktivieren

If you use Stripe Tax to automatically collect taxes for subscriptions or invoices, you can let customers set and update their tax IDs in the customer portal. Stripe Billing adds the tax IDs to the customers’ invoices. To allow customers to set their tax IDs, go to the Customer portal settings and toggle on Tax ID. For more information, see how customer tax IDs work with subscriptions and invoices.

Hier erfahren Sie, wie Sie Stripe Tax einrichten, Steuern für wiederkehrende Zahlungen erheben, Steuern in Ihren nutzerdefinierten Zahlungsabläufen einziehen und Steuersätze für Posten und Rechnungen festlegen.

Vorschau und Test

As you configure your settings, click Preview to preview the portal. This launches a read-only version of the portal that lets you see how your customers might manage their subscriptions and billing details.

Nachdem Sie Ihre Einstellungen gespeichert haben, können Sie das Portal starten und mit einem Kunden/einer Kundin in einer Sandbox testen. Navigieren Sie im Dashboard zu einer Kundin/einem Kunden, klicken Sie auf Aktionen und wählen Sie dann Kundenportal öffnen aus.

You can only preview the portal as a read-only version when your Dashboard is in a sandbox. If you can’t preview and test the portal, check your settings to make sure that your configuration is saved in a sandbox. For previewing and testing to work, you also need to have edit permissions in the Dashboard.

Eine Portalsitzung dient als Einstiegspunkt in das Kundenportal. Sie liefert einen eindeutigen, temporären Link zum Portal. Wenn Kund/innen ihre Rechnungen oder Abrechnung verwalten möchten, können Sie eine neue Portalsitzung erstellen und die Kund/innen zur url der Sitzung weiterleiten.

Fügen Sie auf Ihrer Website eine Schaltfläche hinzu, über die die Kund/innen das Portal aufrufen können. Verwenden Sie eine POST-Anfrage, um eine Portalsitzung zu erstellen:

<form method="POST" action="/create-customer-portal-session">
  <button type="submit">Manage billing</button>
</form>

Fügen Sie als Nächstes einen Endpoint hinzu, über den eine Portalsitzung erstellt wird und Ihre Kund/innen weitergeleitet werden. Authentifizieren Sie Kund/innen auf Ihrer Website, bevor Sie Sitzungen für sie erstellen. Zum Erstellen einer Sitzung benötigen Sie die ID der Kundin/des Kunden und eine return_url, die erforderlich ist, falls in der Dashboard-Konfiguration keine Standard-Rückgabe-URL festgelegt ist.

Wenn Sie eine Portalsitzung erstellen, gibt Stripe das portal session object zurück, das die kurzlebige URL der Sitzung enthält, die Ihre Kund/innen für den Zugriff auf das Kundenportal verwenden.

curl https://api.stripe.com/v1/billing_portal/sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d customer={{CUSTOMER_ID}} \
  --data-urlencode return_url="https://example.com/account"

Wenn der Abonnementumfang geändert oder Abonnements gekündigt werden, müssen Sie sicherstellen, dass die Kund/innen danach nur Zugriff auf die Produkte oder Dienste haben, die sie tatsächlich abonniert haben. Über Webhooks benachrichtigt Stripe Ihre Integration über diese Änderungen. Sehen Sie sich im Event-Objekt die ID für das Abonnement oder die Kundin/den Kunden an, um herauszufinden, für welche Kundin/welchen Kunden das Ereignis gilt.

Stripe benachrichtigt Ihre Integration auch über Webhooks, wenn eine Rechnung bezahlt wird. Sehen Sie sich im Event-Objekt die ID für die Rechnung oder die Kundin/den Kunden an, um herauszufinden, für welche Kundin/welchen Kunden das Ereignis gilt.

Wenn Sie noch keinen Webhook-Endpoint für Stripe eingerichtet haben, können Sie die Dokumentation zu Webhooks von Stripe lesen, um loszulegen und über die beschriebenen Ereignisse informiert zu werden.

Testen Sie das Portal, bevor Sie es in den Produktionsbetrieb integrieren. Führen Sie folgende Schritte aus, wenn Sie bereit für das Go-Live sind:

Wenn Sie eine Portalsitzung erstellen, gibt Stripe das portal session-Objekt zurück, das die kurzlebige URL der Sitzung enthält, die Ihre Kundinnen/Kunden für den Zugriff auf das Kundenportal verwenden müssen. Sie können auch einen gemeinsam nutzbaren Link für jede Konfiguration des Portals mit dem Parameter login_page erstellen.

• Deaktivieren Sie Testdaten anzeigen im Dashboard.
• Konfigurieren Sie das Portal im Live-Modus.
• Fügen Sie die Webhooks im Live-Modus hinzu.

Stripe unterhält mehrere verschiedene Portalkonfigurationen: eine für den Live-Modus und eine für jede Sandbox. Damit Sie Ihre Integration problemlos testen können, wirken sich Änderungen in einem Modus nicht auf die Konfiguration im anderen Modus aus.