使用 Stripe CLI

通过命令行构建、测试和管理您的 Stripe 集成。

通过 Stripe CLI，您可以从命令行构建、测试和管理您的 Stripe 集成。使用 CLI，您可以创建和管理 Stripe 资源、触发 Webhook 事件、流式传输实时 API 请求日志，以及将事件转发到您的本地开发环境。

在运行请求时指定 API 版本。

当您在 CLI 中调用 Stripe API 时，它会在所有请求中使用您的默认 API 版本，您可以在 Workbench 中识别该版本。要在 CLI 中试用不同的 API 版本，请使用以下标志：

标志	描述	示例
`--stripe-version 2025-08-27.basil`	在任何 CLI 请求中，使用 `--stripe-version` 标志来指定 API 版本。	`stripe products create --name=“My Product” --stripe-version 2025-08-27.basil`
`--latest`	在任何 CLI 请求中，使用 `--latest` 标志来指定最新的 API 版本。	`stripe products create --name="My Product" --latest`

您还可以查看 API 版本列表。

流式传输请求日志

使用 stripe logs tail 命令来流式传输 API 请求日志。保持此窗口打开。如果 API 调用中出现错误，此终端将返回 API 错误消息以及错误原因。

Command Line
stripe logs tail

将事件转发到您的本地 Webhook 端点

使用 --forward-to 标志，将沙盒中的所有 Stripe 事件发送到您的本地 Webhook 端点。要禁用 HTTPS 证书验证，请使用 --skip-verify 标志。

Command Line
stripe listen --forward-to localhost:4242/webhooks

Output
Ready! Your webhook signing secret is '{{WEBHOOK_SIGNING_SECRET}}' (^C to quit)

要转发以逗号分隔的特定事件，请使用 --events 标志。

Command Line
stripe listen --events payment_intent.created,customer.created,payment_intent.succeeded,charge.succeeded,checkout.session.completed,charge.failed \
  --forward-to localhost:4242/webhook

如果您已经在 Stripe 中注册了您的端点，则可以使用 --load-from-webhooks-api 和 --forward-to 标志。

Command Line
stripe listen --load-from-webhooks-api --forward-to localhost:4242

此命令会将发送到您在 Stripe 注册的公共 Webhook 端点的事件转发到您的本地 Webhook 端点。它会加载您注册的端点，解析路径及其注册的事件，然后将路径附加到 --forward-to 路径中的本地 Webhook 端点。如果要检查 Webhook 签名，请使用 listen 命令初始输出中的{{WEBHOOK_SIGNING_SECRET}}。

列出所有可用事件

使用 help 标志 (--help) 列出某一事件类别可能发生的所有事件。例如，列出 Stripe Checkout 的预构建结账页面的所有可能事件：

Command Line
stripe trigger checkout --help

创建一次性产品和价格

向创建产品发送单个 API 请求。

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

在响应对象中查找产品标识符（位于 id 中）。将其保存以备下一步使用。如果一切正常，命令行将显示以下响应：
```
{
  "id": "prod_LTenIrmp8Q67sa",
  "object": "product",
```
调用创建价格，附加 30 美元的价格。将 product 中的占位符替换为您的产品标识符（例如，prod_LTenIrmp8Q67sa）。
Command Line
```
stripe prices create \
  --unit-amount=3000 \
  --currency=usd \
  --product={{PRODUCT_ID}}
```
如果一切正常，命令行将显示以下响应：
```
{
  "id": "price_1KzlAMJJDeE9fu01WMJJr79o",
  "object": "price",
```

在测试时触发 Webhook 事件

触发 checkout.session.completed 事件，以创建因结账会话成功完成而产生的 API 对象。

Command Line
stripe trigger checkout.session.completed

您的 Stripe listen 终端将显示以下输出：

Command Line

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!