CLI Stripe

L’interface de ligne de commande Stripe est un outil destiné aux développeurs. Elle permet de créer, tester et gérer une intégration Stripe directement depuis la ligne de commande. Avec la CLI Stripe, il est aisé d’accomplir certaines tâches courantes telles qu’appeler les API Stripe, tester votre intégration de webhook et créer un formulaire d’inscription.

Se lancer avec un guide

Se connecter à Stripe pour authentifier les requêtes

Connectez-vous et authentifiez votre compte d’utilisateur Stripe afin de générer un jeu de clés limitées. Pour en savoir plus, consultez la documentation consacrée aux autorisations et aux clés de la CLI Stripe.

stripe login

Your pairing code is: enjoy-enough-outwit-win
This pairing code verifies your authentication with Stripe.
Press Enter to open the browser or visit https://dashboard.stripe.com/stripecli/confirm_auth?t=THQdJfL3x12udFkNorJL8OF1iFlN8Az1 (^C to quit)

Spécifier une version d’API lors de l’exécution de requêtes

Lorsque vous appelez les API Stripe dans l’interface de ligne de commande, votre appel utilise votre version par défaut des API dans toutes les requêtes, que vous pouvez identifier dans Workbench. Pour tester différentes versions des API dans l’interface de ligne de commande, utilisez les flags ci-après :

Vous pouvez également consulter une liste des versions de l’API.

Streamer les logs des requêtes

Utilisez la commande stripe logs tail pour streamer les logs des requêtes API. Gardez cette fenêtre ouverte. Si vous avez une erreur dans vos appels à l’API, ce terminal vous renverra le message d’erreur API et la raison de l’erreur.

stripe logs tail

Transmettre des événements à votre endpoint de webhook local

Utilisez l’indicateur --forward-to pour envoyer tous les événements Stripe dans un environnement de test vers votre endpoint de webhook local. Pour désactiver la vérification du certificat HTTPS, utilisez l’indicateur --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 sous la forme d’une liste d’éléments séparés par des virgules, utilisez le flag --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é auprès de Stripe à 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 paramètre {{WEBHOOK_SIGNING_SECRET}} à partir de la sortie initiale de la commande listen.

Dresser la liste de tous les événements disponibles

Utilisez le flag –help pour répertorier tous les événements possibles pour une catégorie d’événement. Par exemple, pour répertorier tous les événements possibles liés à la page de paiement prédéfinie pour Stripe Checkout :

stripe trigger checkout --help

Créer un produit et un tarif ponctuels

1. Effectuez une requête unique à l’API afin de créer un produit.

stripe products create \
--name="My First Product" \
--description="Created with the Stripe CLI"

1. Recherchez l’identifiant produit (dans id) dans l’objet réponse. Conservez-le pour la prochaine étape.

Si tout a bien fonctionné, la ligne de commande affiche la réponse suivante.

{
  "id": 
"prod_LTenIrmp8Q67sa",
  "object": "product",

1. Appelez l’API de création de tarif pour associer un tarif de 30 USD. Remplacez le paramètre substituable contenu dans product par l’identifiant de votre produit (par exemple, prod_LTenIrmp8Q67sa).

stripe prices create \
  --unit-amount=3000 \
  --currency=usd \
  --product=
{{PRODUCT_ID}}

Si tout a bien fonctionné, la ligne de commande affiche la réponse suivante.

{
  "id": 
"price_1KzlAMJJDeE9fu01WMJJr79o",
  "object": "price",

Déclencher un événement webhook pendant les tests

Déclenchez l’événement checkout.session.completed pour créer les objets API qui résultent d’une session Checkout ayant abouti.

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!

Pour en savoir plus sur les déclencheurs, consultez notre guide.