Utiliser la Stripe CLI
Créez, testez et gérez votre intégration Stripe depuis la ligne de commande.
La Stripe CLI vous permet de créer, de tester et de gérer votre intégration Stripe depuis la ligne de commande. Avec la CLI, vous pouvez créer et gérer des ressources Stripe, déclencher des événements de webhook, diffuser des journaux de requêtes API en temps réel et transférer des événements vers votre environnement de développement local.
Spécifier une version de l’API lors de l’exécution des requêtes
Lorsque vous appelez les API Stripe dans la CLI, elle utilise votre version d’API par défaut dans toutes les requêtes, que vous pouvez identifier dans Workbench. Pour essayer différentes versions de l’API dans la CLI, utilisez les options suivantes :
| Option | Description | Exemple |
|---|---|---|
| Utilisez l’option --stripe-version dans n’importe quelle requête CLI pour spécifier une version de l’API. | stripe products create --name=“My Product” --stripe-version 2025-12-15. |
--latest | Utilisez l’option --latest dans n’importe quelle requête CLI pour spécifier la dernière version de l’API. | stripe products create --name="My Product" --latest |
Vous pouvez également afficher une liste des versions de l’API.
Découvrez les options de commande
Pour apprendre davantage sur les options de commandes spécifiques, ajoutez --help à la commande.
stripe listen --help
Diffuser les journaux de requêtes
Utilisez la commande stripe logs tail pour diffuser les journaux de requêtes API. Gardez cette fenêtre ouverte. Si vous avez une erreur dans vos appels d’API, ce terminal renvoie le message d’erreur de l’API et un motif pour l’erreur.
stripe logs tail
Transférer des événements vers votre endpoint de webhook local
Utilisez l’option --forward-to pour envoyer tous les événements Stripe d’un environnement de test à votre endpoint de webhook local. Pour désactiver la vérification du certificat HTTPS, utilisez l’option --skip-verify.
stripe listen --forward-to localhost:4242/webhooks
Ready! Your webhook signing secret is '{{WEBHOOK_SIGNING_SECRET}}' (^C to quit)
Pour transférer des événements spécifiques dans une liste séparée par des virgules, utilisez l’option --events.
stripe listen --events payment_intent.created,customer.created,payment_intent.succeeded,charge.succeeded,checkout.session.completed,charge.failed \ --forward-to localhost:4242/webhook
Si vous avez déjà enregistré votre endpoint dans Stripe, vous pouvez utiliser les options --load-from-webhooks-api et --forward-to.
stripe listen --load-from-webhooks-api --forward-to localhost:4242
Cette commande transfère les événements envoyés à votre endpoint de webhook public enregistré sur Stripe vers votre endpoint de webhook local. Elle charge votre endpoint enregistré, analyse le chemin et ses événements enregistrés, puis ajoute le chemin à votre endpoint de webhook local dans le chemin --forward-to. Si vous vérifiez les signatures de webhook, utilisez le {{WEBHOOK_ de la sortie initiale de la commande listen.
Lister tous les événements disponibles
Utilisez l’option d’aide (--help) pour lister tous les événements possibles qui peuvent survenir pour une catégorie d’événements. Par exemple, pour lister tous les événements possibles pour la page de paiement préconfigurée de Stripe Checkout :
stripe trigger checkout --help
Créer un produit et un prix uniques
Effectuez une seule requête API pour Créer un produit.
Command Linestripe products create \ --name="My First Product" \ --description="Created with the Stripe CLI"Recherchez l’identifiant du produit (dans
id) dans l’objet de réponse. Enregistrez-le pour la prochaine étape. Si tout a fonctionné, la ligne de commande affiche la réponse suivante :{ "id":, "object": "product","prod_LTenIrmp8Q67sa"Appelez Créer un prix pour associer un prix de 30 $ US. Remplacez l’espace réservé dans
productpar votre identifiant de produit (par exemple,prod_).LTenIrmp8Q67sa Command Linestripe prices create \ --unit-amount=3000 \ --currency=usd \ --product="{{PRODUCT_ID}}"Si tout a fonctionné, la ligne de commande affiche la réponse suivante :
{ "id":, "object": "price","price_1KzlAMJJDeE9fu01WMJJr79o"
Déclencher un événement de webhook lors des tests
Déclenchez l’événement checkout. pour créer les objets API qui résultent de la réussite d’une session de paiement.
stripe trigger checkout.session.completed
Votre terminal stripe listen affiche le résultat suivant :
Setting up fixture for: checkout_session Running fixture for: checkout_session Setting up fixture for: payment_page Running fixture for: payment_page Setting up fixture for: payment_method Running fixture for: payment_method Setting up fixture for: payment_page_confirm Running fixture for: payment_page_confirm Trigger succeeded!