Utiliser l'interface de ligne de commande Stripe
Créez, testez et gérez votre intégration Stripe à partir de la ligne de commande.
Le CLI de Stripe vous permet de construire, tester et gérer votre intégration Stripe à partir de la ligne de commande. Avec le CLI, vous pouvez créer et gérer des ressources Stripe, déclencher des événements webhook, diffuser des journaux de requêtes API en temps réel et transmettre des événements à votre environnement de développement local.
Spécifiez une version de l’API lors de l’exécution des requêtes
Lorsque vous appelez les API de Stripe dans le CLI, il utilise votre version d’API par défaut dans toutes les requêtes, que vous pouvez identifier dans Workbench. Pour essayer différentes versions d’API dans le CLI, utilisez les indicateurs suivants :
Flag | Description | Exemple |
---|---|---|
| Utilisez l’indicateur --stripe-version dans toute requête de l’interface de programmation pour spécifier une version de l’API. | stripe products create --name=“My Product” --stripe-version 2025-08-27. |
--latest | Utilisez l’indicateur --latest dans toute requête de l’interface de programmation pour spécifier la dernière version de l’API. | stripe products create --name="My Product" --latest |
Vous pouvez également consulter une liste des versions de l’API.
Diffuser les journaux de requêtes
Utilisez la commande stripe logs tail
pour diffuser les journaux des requêtes de l’API. Gardez cette fenêtre ouverte. En cas d’erreur dans vos appels à l’API, ce terminal renvoie le message d’erreur de l’API et la raison de l’erreur.
stripe logs tail
Transmettre les événements à votre point de terminaison de webhook local
Utilisez l’indicateur --forward-to
pour envoyer tous les événements Stripe dans un sandbox vers votre point de terminaison webhook local. Pour désactiver la vérification des certificats 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 transmettre des événements spécifiques dans une liste séparée par des virgules, utilisez l’indicateur --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 point de terminaison dans Stripe, vous pouvez utiliser les indicateurs --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 point de terminaison webhook public enregistré auprès de Stripe vers votre point de terminaison webhook local. Elle charge votre point de terminaison enregistré, analyse le chemin et ses événements enregistrés, puis ajoute le chemin vers votre point de terminaison webhook local dans le chemin --forward-to
. Si vous vérifiez les signatures de webhook, utilisez la commande {{WEBHOOK_
à partir de la sortie initiale de la commande listen
.
Liste de tous les événements disponibles
Use the help flag (--help
) to list all possible events that can occur for an event category. For example, to list all possible events for the prebuilt checkout page for Stripe Checkout:
stripe trigger checkout --help
Créer un produit et un prix uniques
Faites 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 la réponse. Sauvegardez-le pour l’étape suivante. Si tout a fonctionné, la ligne de commande affiche la réponse suivante :{ "id":
, "object": "product","prod_LTenIrmp8Q67sa"Ensuite, appelez l’API de création de tarif pour joindre un tarif de 30 USD. Changez le paramètre fictif dans le
product
avec votre identifiant de produit (par exemple,prod_
).LTenIrmp8Q67sa Command Linestripe 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":
, "object": "price","price_1KzlAMJJDeE9fu01WMJJr79o"
Déclencher un événement webhook lors d’un test
Déclenchez l’événement checkout.
pour créer les objets API qui résultent d’une session de paiement terminée avec succès.
stripe trigger checkout.session.completed
Votre terminal Stripe Listen
affiche la sortie suivante :
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!