カスタマーポータルのディープリンク
カスタマーポータルでは、お客様側での構築作業を必要とせずにサブスクリプションと決済手段の管理機能を顧客に提供できます。顧客のアクションを効率化して、独自のアプリと Stripe の間のワークフローをさらにカスタマイズする場合は、カスタマーポータルの flow
を作成できます。
カスタマーポータルのフロー
「フロー」は、カスタマーポータルへのカスタマイズ可能なディープリンクです。ポータルフローでは以下を行うことができます。
- 顧客に実行を求める指定アクションが表示されるページにディープリンクで直接接続します。カスタマーポータルの他の部分にアクセスするナビゲーションコンポーネントは非表示になるため、顧客は 1 つのアクションに注目できます。
- 顧客がアクションを完了した後のリダイレクトの動作をカスタマイズします。お客様独自の URL、オンラインの確認ページ、またはポータルのホームページに即時にリダイレクトします。
- Personalize the flow with unique options like prefilled promotion codes or custom messages.
フローのタイプ
フローの type
は、顧客がどの個別フローまたはアクションを実行するかを定義します。以下は、現在利用できるフローのタイプです。
フロータイプ | 説明 | 例 |
---|---|---|
payment_method_update | 顧客が新しい決済手段を追加できるようにするには、payment_method_update を使用します。決済手段は、customer.invoice_settings.default_payment_method として設定されます。 | 決済手段の更新フロー |
| 顧客が特定のサブスクリプションをキャンセルできるようにするには、 API またはダッシュボードを使用してポータル設定を更新することにより、サブスクリプションが即時または期間終了時のどちらでキャンセルされるようにするかをカスタマイズできます。 | サブスクリプションのキャンセルフロー |
| 別のプランへのアップグレードやダウングレード、現在のプランの数量の更新など、別の更新オプションを顧客が選択できるようにするには、 | サブスクリプションの更新フロー |
| 顧客がサブスクリプションへの更新の明細を確定できるようにするには、 このオプションは、独自の料金体系ページがあり、次回のインボイスや比例配分などの更新情報の表示、支払いの失敗の処理、3D セキュア認証の処理などの処理をオフロードする場合に使用できます。 サブスクリプション更新に適用するクーポンやプロモーションコードも指定できます。これは、別のプランへの切り替えに対して割引を提供するプロモーションキャンペーンなどで使用できます。 | サブスクリプション更新の確認フロー |
フローを作成する
注
カスタマーポータルフローは、Customer portal API の拡張機能です。まず、このガイドを使用する前に、全般的なガイドに従い、API でカスタマーポータルを実装してください。
フローを作成するには、ポータルセッションの作成時に flow_data
を指定します。
顧客に実行を求めるフローの type
を設定します。フローの type
によっては、サブスクリプション ID などの追加のデータを渡すことが必要になる場合があります。
Below are examples on how to set up each flow type.
レスポンスのポータルセッションの url
が、作成したフローにディープリンクで接続されます。この URL を使用して、サイトからポータルフローに顧客をリダイレクトします。
完了後の動作をカスタマイズする
顧客がフローを正常に完了すると、完了した更新の詳細を示すローカライズ版の確認ページが表示されます。このページの確認メッセージをカスタマイズしたり、選択した URL やアカウント情報がすべて表示されるカスタマーポータルのホームページにリダイレクトしたりすることができます。
この動作をカスタマイズするには、flow_data
で after_completion
を設定します。
以下の例では、顧客がサブスクリプションをキャンセルし、その後でお客様のサイトにリダイレクトされます。
注
上位の return_url
は、顧客がいつでもクリックしてウェブサイトに戻ることができるリンクです (たとえば、キャンセルしないことにした場合など)。flow_data[after_completion][redirect][return_url]
は、顧客がサブスクリプションを正常にキャンセルした後にウェブサイトに戻るためのリンクです。