カスタマーポータルのディープリンク

カスタマーポータルの API を使用して、効率的な顧客フローを設計します。

カスタマーポータルを利用すると、構築を自身で行わなくても顧客にサブスクリプションと決済手段の管理機能を提供できます。顧客のアクションを効率化して、アプリと Stripe 間のワークフローをさらにカスタマイズする場合は、カスタマーポータルフローを作成できます。

カスタマーポータルのフロー

「フロー」は、カスタマーポータルへのカスタマイズ可能なディープリンクです。ポータルフローでは以下を行うことができます。

顧客に実行を求める指定アクションが表示されるページにディープリンクで直接接続します。カスタマーポータルの他の部分にアクセスするナビゲーションコンポーネントは非表示になるため、顧客は 1 つのアクションに注目できます。
顧客がアクションを完了した後のリダイレクトの動作をカスタマイズします。お客様独自の URL、オンラインの確認ページ、またはポータルのホームページに即時にリダイレクトします。
事前入力されたプロモーションコードやカスタムメッセージなどの独自のオプションによって、フローをカスタマイズします。

フローのタイプ

フローの type は、顧客がどの個別フローまたはアクションを実行するかを定義します。以下は、現在利用可能なフローのタイプです。

フロータイプ	説明	例
`payment_method_update`	顧客が新しい支払い方法を追加できるようにするには、`payment_method_update` を使用します。支払い方法は、`customer.invoice_settings.default_payment_method` として設定されます。	支払い方法の更新フロー
`subscription_cancel`	顧客が特定のサブスクリプションをキャンセルできるようにするには、`subscription_cancel` を使用します。 API またはダッシュボードを使用してポータル設定を更新すると、サブスクリプションを即時または期間終了時のどちらでキャンセルするかをカスタマイズできます。	サブスクリプションのキャンセルフロー
`subscription_update`	別のプランへのアップグレードやダウングレード、現在のプランの数量の更新など、別の更新オプションを顧客が選択できるようにするには、`subscription_update` を使用します。 API またはダッシュボードを使用してポータル設定を更新することにより、提供するプランをカスタマイズできます。	サブスクリプションの更新フロー
`subscription_update_confirm`	顧客がサブスクリプションへの更新の明細を確定できるようにするには、`subscription_update_confirm` を使用します。このオプションは、独自の料金ページがあるが、更新情報を表示する処理 (次回の請求書や日割り計算などの更新情報の表示、支払い失敗の処理、3D セキュア認証の処理など) をオフロードしたい場合に使用できます。サブスクリプション更新に適用するクーポンやプロモーションコードも指定できます。これは、別のプランへの切り替えに対して割引を提供するプロモーションキャンペーンなどで使用できます。	サブスクリプション更新の確認フロー

フローを作成する

注

カスタマーポータルフローは、カスタマーポータル API の拡張機能です。まず、このガイドを使用する前に、全般的なガイドに従って API でカスタマーポータルを実装してください。

フローを作成するには、ポータルセッションの作成時に flow_data を指定します。

顧客に実行を求めるフローのタイプを設定します。フローの type によっては、サブスクリプション ID などの追加のデータを渡すことが必要になる場合があります。

以下は、各フロータイプの設定方法の例です。

レスポンスのポータルセッションの url が、作成したフローにディープリンクで接続されます。この URL を使用して、サイトからポータルフローに顧客をリダイレクトします。

完了後の動作をカスタマイズする

顧客がフローを正常に完了すると、完了した更新の詳細を示すローカライズ版の確認ページが表示されます。このページの確認メッセージをカスタマイズしたり、選択した URL やアカウント情報がすべて表示されるカスタマーポータルのホームページにリダイレクトしたりすることができます。

この動作をカスタマイズするには、flow_data に after_completion を設定します。

以下の例では、顧客がサブスクリプションをキャンセルし、その後でお客様のサイトにリダイレクトされます。

注

上位の return_url は、顧客がいつでもクリックしてウェブサイトに戻ることができるリンクです (たとえば、キャンセルしないことにした場合など)。flow_data[after_completion][redirect][return_url] は、顧客がサブスクリプションを正常にキャンセルした後にウェブサイトに戻るためのリンクです。