Liens profonds sur le portail client

Concevez des flux client rationalisés avec l'API du portail client.

Le portail client vous permet de donner à vos clients la possibilité de gérer leurs abonnements et leurs moyens de paiement par eux-mêmes. Si vous souhaitez simplifier les actions de vos clients et personnaliser davantage les flux de travail entre votre propre application et Stripe, vous pouvez créer un flow du portail client.

Flux du portail client

Un flux est un lien profond personnalisable vers le portail client. Les flux du portail vous permettent de :

Créer un lien profond directement vers la page de l’action spécifiée que votre client doit exécuter. Les composants de navigation dans le reste du portail client sont masqués afin que votre client ne se concentre que sur l’action en question.
Personnaliser le comportement de redirection une fois que le client a mené à bien l’action : redirigez-le immédiatement vers votre propre URL, vers une page de confirmation hébergée ou vers la page d’accueil du portail.
Personnalisez le flux avec des options uniques telles que des codes promotionnels pré-renseignés ou des messages personnalisés.

Types de flux

Le type d’un flux définit le flux ou l’action que votre client exécutera. Les types de flux actuellement disponibles sont les suivants :

Type de flux	Description	Exemple
`payment_method_update`	Utilisez `payment_method_update` pour permettre à votre client d’ajouter un nouveau moyen de paiement. Le moyen de paiement est défini est défini en tant que `customer.invoice_settings.default_payment_method`.	Flux de mise à jour du moyen de paiement
`subscription_cancel`	Utilisez `subscription_cancel` pour permettre à votre client de résilier un abonnement donné. Vous pouvez indiquer si l’abonnement doit être résilié immédiatement ou au terme de la période en cours en mettant à jour la configuration de votre portail par l’API ou le Dashboard.	Flux de résiliation de l’abonnement
`subscription_update`	Utilisez `subscription_update` pour permettre à votre client de sélectionner différentes options de mise à jour, telles que le passage à un abonnement supérieur ou inférieur, ou la mise à jour du volume de son abonnement actuel. Vous pouvez personnaliser les offres disponibles en mettant à jour la configuration de votre portail via l’API ou le Dashboard.	Flux de mise à jour de l’abonnement
`subscription_update_confirm`	Utilisez `subscription_update_confirm` pour permettre à votre client de confirmer une mise à jour spécifique de son abonnement. Vous pouvez utiliser cette option lorsque vous disposez de votre propre page de tarifs, mais que vous souhaitez vous décharger de l’affichage des détails de la mise à jour, tels que la facture à venir et les calculs au prorata, de la gestion des échecs de paiement ou de la gestion de l’authentification 3D Secure. Vous pouvez également spécifier un bon de réduction ou un code promotionnel à appliquer lors de la mise à jour de l’abonnement. Vous pouvez l’utiliser pour des campagnes promotionnelles lorsque vous offrez une réduction pour passer à une autre offre.	Flux de confirmation de la mise à jour de l’abonnement

Créer un flux

Remarque

Les flux du portail client sont une extension de l’API du portail client. Suivez d’abord les instructions générales pour intégrer le portail client à l’API avant d’utiliser ce guide.

Pour créer un flux, spécifiez flow_data lorsque vous créez une session de portail.

Définissez le type de flux que votre client doit exécuter. En fonction du type de flux, vous devrez peut-être transmettre des données supplémentaires, telles qu’un ID d’abonnement.

Vous trouverez ci-dessous des exemples de configuration de chaque type de flux.

L’url de la session du portail pour la réponse est désormais un lien profond vers le flux que vous avez créé. Utilisez cette URL pour rediriger les clients vers le flux du portail depuis votre site.

Personnaliser le comportement après exécution

Une fois que votre client a correctement exécuté le flux, il voit s’afficher une page de confirmation localisée qui affiche les détails de la mise à jour effectuée. Vous pouvez personnaliser le message de confirmation qui s’affiche sur cette page, rediriger votre client vers l’URL de votre choix ou le rediriger vers la page d’accueil du portail client où les détails complets de son compte lui sont présentés.

Pour personnaliser ce comportement, définissez after_completion sur flow_data.

L’exemple suivant permet à votre client de résilier son abonnement et le redirige ensuite vers votre propre site :

Remarque

La return_url de niveau supérieur est un lien vers votre site Web sur lequel le client peut cliquer à tout moment (s’il décide de ne pas résilier, par exemple). Le flow_data[after_completion][redirect][return_url] est un lien vers votre site Web après qu’un client a résilié son abonnement.