Stripe CLI

https://github.com/stripe/stripe-cli
Admin
The Stripe CLI helps you build, test, and manage your Stripe integration right from the terminal,...
Tokens:217,339
Snippets:1,581
Trust Score:9.7
License:Apache-2.0
Update:1 week ago
Show doc for...
Tokens:
Raw
### Run make setup

Source: https://github.com/stripe/stripe-cli/blob/master/CONTRIBUTING.md

Set up dependencies after installation, regardless of Go version used.

```sh
$ make setup
```

--------------------------------

### Install Stripe CLI with WinGet

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Install the Stripe CLI on Windows using WinGet.

```sh
winget install Stripe.StripeCLI
```

--------------------------------

### Install Stripe CLI with Scoop

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Install the Stripe CLI on Windows using Scoop. First add the Stripe bucket, then install the package.

```sh
scoop bucket add stripe https://github.com/stripe/scoop-stripe-cli.git
scoop install stripe
```

--------------------------------

### Fixture query syntax examples

Source: https://github.com/stripe/stripe-cli/wiki/Fixtures-command

Shows the two forms of fixture queries: accessing response attributes and accessing environment variables. Queries must start with `${` and end with `}`.

```text
Accessing attributes in responses: ${name:json_path}
Accessing environment variables: ${.env:VARIABLE_NAME}
```

--------------------------------

### Install dependencies for Go 1.16 and 1.17

Source: https://github.com/stripe/stripe-cli/blob/master/CONTRIBUTING.md

For Go versions 1.16 or 1.17, run these commands to install dependencies and navigate to the source directory.

```sh
$ go get -v -u github.com/stripe/stripe-cli/...
$ cd go/src/github.com/stripe/stripe-cli
```

--------------------------------

### Example fixtures JSON file

Source: https://github.com/stripe/stripe-cli/wiki/Fixtures-command

A complete example of a fixtures file that creates a customer, creates a charge, and captures the charge. It demonstrates the use of environment variables and fixture queries to reference previous responses.

```json
{
  "_meta": {
    "template_version": 0
  },
  "fixtures": [
    {
      "name": "cust_bender",
      "path": "/v1/customers",
      "method": "post",
      "params": {
        "name": "Bender Bending Rodriguez",
        "email": "bender@planex.com",
        "phone": "${.env:PHONE}",
        "source": "tok_amex",
        "address": {
          "line1": "1 Planet Express St",
          "city": "New New York"
        }
      }
    },
    {
      "name": "char_bender",
      "path": "/v1/charges",
      "method": "post",
      "params": {
        "customer": "${cust_bender:id}",
        "amount": 100,
        "currency": "usd",
        "capture": false
      }
    },
    {
      "name": "capt_bender",
      "path": "/v1/charges/${char_bender:id}/capture",
      "method": "post"
    }
  ]
}
```

--------------------------------

### Install Stripe CLI with yum/dnf for RedHat/Fedora/CentOS

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Install the Stripe CLI on RedHat, Fedora, or CentOS via yum/dnf. Add the Stripe repository and install the CLI.

```sh
echo -e "[Stripe]\nname=stripe\nbaseurl=https://packages.stripe.dev/stripe-cli-rpm-local/\nenabled=1\ngpgcheck=0" | sudo tee -a /etc/yum.repos.d/stripe.repo
sudo yum install stripe
```

--------------------------------

### Install Stripe CLI with apt on Debian/Ubuntu

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Install the Stripe CLI on Debian or Ubuntu via apt. These commands set up the Stripe repository, update package lists, and install the CLI.

```sh
curl -s https://packages.stripe.dev/api/security/keypair/stripe-cli-gpg/public | gpg --dearmor | sudo tee /usr/share/keyrings/stripe.gpg > /dev/null
echo "deb [signed-by=/usr/share/keyrings/stripe.gpg] https://packages.stripe.dev/stripe-cli-debian-local stable main" | sudo tee -a /etc/apt/sources.list.d/stripe.list
sudo apt update
sudo apt install stripe
```

--------------------------------

### Install Stripe CLI with Homebrew

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Install the Stripe CLI on macOS using Homebrew.

```sh
brew install stripe
```

--------------------------------

### Go Hello World Program

Source: https://github.com/stripe/stripe-cli/blob/master/pkg/docs/markdown/testdata/showcase.md

A minimal Go program that prints "Hello, world!" to standard output. Use as a starting point for any Go application.

```go
package main

import "fmt"

func main() {
    fmt.Println("Hello, world!")
}
```

--------------------------------

### Install Stripe CLI globally with npm

Source: https://github.com/stripe/stripe-cli/wiki/Installation

Use this command to install the Stripe CLI globally via npm. The command is `npm install --global @stripe/cli`. The `$` prompt is shown in the source and is not part of the command.

```sh
$ npm install --global @stripe/cli
```

--------------------------------

### Start log tailing with `stripe logs tail`

Source: https://github.com/stripe/stripe-cli/wiki/Logs-tail-command

Run this command to begin tailing all test mode request logs. By default, all test mode request logs are displayed.

```sh
$ stripe logs tail
```

--------------------------------

### Retrieve a charge by ID with `stripe get` and example JSON response

Source: https://github.com/stripe/stripe-cli/wiki/HTTP-(get,-post-&-delete)-commands

When you provide an ID directly, the CLI loads the resource without needing the full path. The output is a JSON object with charge details.

```sh
$ stripe get ch_1EOA8IByst5pquEteSXgXjj0
```

```json
{
  "id": "ch_1EOA8IByst5pquEteSXgXjj0",
  "object": "charge",
  "amount": 1099,
  "amount_refunded": 0,
  ...
}
```

--------------------------------

### Install Stripe CLI with npm

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Install the Stripe CLI globally via npm. Requires Node.js version 18 or later.

```sh
npm install -g @stripe/cli
```

--------------------------------

### Retrieve a charge with `stripe get`

Source: https://github.com/stripe/stripe-cli/wiki/HTTP-(get,-post-&-delete)-commands

Use `stripe get` to retrieve a specific API resource by its path. The example fetches a charge with ID `ch_123`.

```sh
$ stripe get /charges/ch_123
```

--------------------------------

### Create a charge with Stripe CLI

Source: https://github.com/stripe/stripe-cli/wiki/Resource-commands

Creates a charge with the Stripe CLI. This example is repeated from the previous block and demonstrates the create command.

```sh
$ stripe charges create --amount=100 --currency=usd --source=tok_visa
```

--------------------------------

### PaymentIntent JSON Example

Source: https://github.com/stripe/stripe-cli/blob/master/pkg/docs/markdown/testdata/showcase.md

Example JSON response for a PaymentIntent object with fields id, object, amount, currency, and status. Use as a reference for expected API responses.

```json
{
  "id": "pi_123",
  "object": "payment_intent",
  "amount": 2000,
  "currency": "usd",
  "status": "succeeded"
}
```

--------------------------------

### Print Stripe CLI version with `stripe version`

Source: https://github.com/stripe/stripe-cli/wiki/Version-command

Run this command to display the version of the installed Stripe CLI.

```sh
$ stripe version
```

--------------------------------

### Filter logs with multiple values for a single filter: `--filter-http-method GET,POST`

Source: https://github.com/stripe/stripe-cli/wiki/Logs-tail-command

Specify multiple values for a single filter as a comma-separated list; a log only needs to match one of the values. This example shows logs with HTTP method GET or POST.

```sh
$ stripe logs tail --filter-http-method GET,POST
```

--------------------------------

### Create a charge with `stripe post` and `-d` flags

Source: https://github.com/stripe/stripe-cli/wiki/HTTP-(get,-post-&-delete)-commands

Use `stripe post` to create a resource, passing data with the `-d` flag. This example creates a charge with amount, source, and currency.

```sh
$ stripe post /charges -d amount=100 -d source=tok_visa -d currency=usd
```

--------------------------------

### GET /subscriptions

Source: https://github.com/stripe/stripe-cli/wiki/HTTP-(get,-post-&-delete)-commands

List subscriptions with a filter using the Stripe CLI get command.

```APIDOC
## GET /subscriptions

### Description
List subscriptions with a filter using the Stripe CLI get command.

### Method
GET

### Endpoint
/subscriptions

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filter subscriptions by status (e.g., past_due).

### Request Example
```sh
$ stripe get /subscriptions -d status=past_due
```

### Response
#### Success Response (200)
Returns a list of subscriptions.

#### Response Example
```json
{
  "data": [
    {
      "id": "sub_123",
      "object": "subscription",
      "status": "past_due"
    }
  ]
}
```
```

--------------------------------

### stripe login (global configuration)

Source: https://github.com/stripe/stripe-cli/wiki/Login-command

Starts the global login flow. Redirects to the Stripe dashboard for account confirmation and creates a new API key.

```sh
$ stripe login

```

--------------------------------

### Example test functions for offline and API tests

Source: https://github.com/stripe/stripe-cli/blob/master/canary/README.md

Shows the recommended structure for offline and API tests. Offline tests use the TestOffline prefix and do not require an API key. API tests use the TestAPI prefix and call requireAPIKey(t). Both use sanitized logging functions (fatalf, errorf, logSanitizedf) instead of t.Fatalf, t.Errorf, and t.Logf.

```go
func TestOfflineNewFeature(t *testing.T) {
    runner := getRunner(t)

    result, err := runner.Run("new-command", "--flag")
    if err != nil {
        fatalf(t, "Failed to run command: %v", err)
    }

    if result.ExitCode != 0 {
        errorf(t, "Expected exit code 0, got %d", result.ExitCode)
    }
}
```

```go
func TestAPINewFeature(t *testing.T) {
    runner := getRunner(t)
    requireAPIKey(t)

    runner = runner.WithEnv(map[string]string{
        "STRIPE_API_KEY": testutil.GetAPIKey(),
    })

    result, err := runner.Run("api-command")
    // Use sanitized logging for output that may contain secrets
    logSanitizedf(t, "Result: %s", result.Stdout)
}
```

--------------------------------

### GET /charges/{id} (shortcut)

Source: https://github.com/stripe/stripe-cli/wiki/HTTP-(get,-post-&-delete)-commands

Retrieve a charge by providing only the ID, without the full path.

```APIDOC
## GET /charges/{id} (shortcut)

### Description
Retrieve a charge by providing only the ID, without the full path.

### Method
GET

### Endpoint
/charges/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the charge to retrieve.

### Request Example
```sh
$ stripe get ch_1EOA8IByst5pquEteSXgXjj0
```

### Response
#### Success Response (200)
Returns the charge object.

#### Response Example
```json
{
  "id": "ch_1EOA8IByst5pquEteSXgXjj0",
  "object": "charge",
  "amount": 1099,
  "amount_refunded": 0
}
```
```

--------------------------------

### Print Stripe CLI version with `stripe --v`

Source: https://github.com/stripe/stripe-cli/wiki/Version-command

Use the short form `-v` (shown as `--v` in the example) to print the current Stripe CLI version.

```sh
$ stripe --v
```

--------------------------------

### Open dashboard page in live mode with --live

Source: https://github.com/stripe/stripe-cli/wiki/Open-command

Opens a dashboard link without the `/test/` segment, using the `--live` flag. For example, `stripe open dashboard/apikeys --live` opens `https://dashboard.stripe.com/apikeys` instead of `https://dashboard.stripe.com/test/apikeys`.

```sh
$ stripe open dashboard/apikeys --live
```

--------------------------------

### Run Stripe CLI in Docker with --api-key

Source: https://github.com/stripe/stripe-cli/wiki/Using-with-Docker

Use this command to run the Stripe CLI in a Docker container without persistent volumes. The `--api-key` flag replaces the interactive login, and the example forwards webhooks to `localhost:5000/hooks`.

```sh
docker run --rm -it stripe/stripe-cli --api-key my-secret-stripe-key listen --forward-to=localhost:5000/hooks
```

--------------------------------

### stripe logs tail

Source: https://github.com/stripe/stripe-cli/wiki/Logs-tail-command

Documentation for the `stripe logs tail` command, including its usage, available filters, and examples.

```APIDOC
## stripe logs tail

### Description
Establishes a direct connection with Stripe and enables you to tail your test mode Stripe API request logs in real-time from your terminal. By default, it displays all of your test mode request logs.

### Usage
```sh
$ stripe logs tail
```

### Options
- `--filter-account` (string) - Optional - (Connect only) Supports `connect_in` (incoming Connect requests), `connect_out` (outgoing Connect requests), and `self` (non-Connect requests).
- `--filter-ip-address` (string) - Optional - Supports a direct match with any IP address.
- `--filter-http-method` (string) - Optional - Supports `GET`, `POST`, and `DELETE`.
- `--filter-request-path` (string) - Optional - Supports a direct match to any Stripe path (e.g., `/v1/charges`).
- `--filter-request-status` (string) - Optional - Supports `succeeded` and `failed`.
- `--filter-source` (string) - Optional - Supports `api` and `dashboard`.
- `--filter-status-code` (integer) - Optional - Supports any status code that is a `200`, `400`, or `500` (e.g., `404`).
- `--filter-status-code-type` (string) - Optional - Supports `2XX`, `4XX`, and `5XX`.

### Examples

#### Multiple filters (AND logic)
```sh
$ stripe logs tail --filter-http-method POST --filter-status-code-type 4XX
```

#### Multiple values for a single filter (OR logic)
```sh
$ stripe logs tail --filter-http-method GET,POST
```
```

--------------------------------

### GET /charges/{id}

Source: https://github.com/stripe/stripe-cli/wiki/HTTP-(get,-post-&-delete)-commands

Retrieve a specific charge by its ID using the Stripe CLI get command.

```APIDOC
## GET /charges/{id}

### Description
Retrieve a specific charge by its ID using the Stripe CLI get command.

### Method
GET

### Endpoint
/charges/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the charge to retrieve.

### Request Example
```sh
$ stripe get /charges/ch_123
```

### Response
#### Success Response (200)
Returns the charge object.

#### Response Example
```json
{
  "id": "ch_123",
  "object": "charge",
  "amount": 1000,
  "currency": "usd"
}
```
```

--------------------------------

### List supported events: stripe trigger

Source: https://github.com/stripe/stripe-cli/wiki/Trigger-command

Lists the currently supported webhook events. Use this to get an up-to-date list of events you can trigger.

```sh
$ stripe trigger
```

--------------------------------

### Uninstall Stripe CLI plugins

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Removes all installed Stripe CLI plugins before uninstalling the binary, because package managers leave plugins behind.

```sh
stripe plugin uninstall --all
```

--------------------------------

### Pipe `stripe get` output to jq and xargs to cancel subscriptions

Source: https://github.com/stripe/stripe-cli/wiki/HTTP-(get,-post-&-delete)-commands

This pipeline lists subscriptions with status `past_due`, extracts their IDs with jq, and cancels each subscription using `stripe delete`. The `-p` flag prompts before each deletion.

```sh
$ stripe get /subscriptions -d status=past_due | jq ".data[].id" | xargs -I % -p stripe delete /subscriptions/%
```

--------------------------------

### Filter logs with multiple filters: `--filter-http-method POST --filter-status-code-type 4XX`

Source: https://github.com/stripe/stripe-cli/wiki/Logs-tail-command

Use multiple filters together; a log must match all filters to be shown. This example shows logs with HTTP method POST and status code type 4XX.

```sh
$ stripe logs tail --filter-http-method POST --filter-status-code-type 4XX
```

--------------------------------

### Create entrypoint.sh for Stripe CLI Docker live mode

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Create an entrypoint script for Docker that sets up a GPG key and password store, and allows live mode requests by appending the --api-key flag and passing it to the Stripe CLI.

```sh
#!/bin/sh
if ! [ -f ~/.gnupg/trustdb.gpg ] ; then
  chmod 700 ~/.gnupg/
  gpg --quick-generate-key stripe-live # This will generate a gpg key called "stripe-live"
fi
if ! [ -f ~/.password-store/.gpg-id ] ; then
  pass init stripe-live # This will initialize a password store record named "stripe-live", using the gpg key above
  pass insert stripe-live # This will insert value for the password store "stripe-live", which we will put Stripe Live Secret Key in
fi

string="$@"
liveflag="--live"

if [ -z "${string##*$liveflag*}" ] ;then
  OPTS="--api-key $(pass show stripe-live)" # This will use the content of the password store "stripe-live" which was inserted in line 8
fi

#pass insert stripe-live
/bin/stripe  $@ $OPTS
```

--------------------------------

### Run make test

Source: https://github.com/stripe/stripe-cli/blob/master/CONTRIBUTING.md

Run the test suite to verify everything works as expected.

```sh
$ make test
```

--------------------------------

### Create a palette with a commands mode

Source: https://github.com/stripe/stripe-cli/blob/master/pkg/docs/palette/README.md

Imports the palette package and defines a list of commands, a mode that fuzzy-filters them, and creates a new palette with that mode. Each mode owns its own Match, Items, and optional async Search or typeable Facets.

```go
import "github.com/stripe/stripe-cli/pkg/docs/internal/palette"

var commands = []palette.Item{
    palette.Command{Name: "Open file"},
    palette.Command{Name: "Save"},
    palette.Command{Name: "Quit"},
}

mode := palette.Mode{
    Name: "commands",
    Items: func(_ palette.Model, q string) []palette.Item {
        return palette.FilterFuzzy(commands, q)
    },
}

p := palette.New(palette.WithModes(mode))
```

--------------------------------

### Use the stripe CLI to run commands and access help

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Prints general CLI usage. Use `stripe [command] help` to see help for a specific command.

```sh-session
stripe [command]

# Run `--help` for detailed information about CLI commands
stripe [command] help

```

--------------------------------

### List available shortcuts with stripe open --list

Source: https://github.com/stripe/stripe-cli/wiki/Open-command

Displays an up-to-date list of all available shortcuts for the `open` command.

```sh
$ stripe open --list
```

--------------------------------

### Build and Test Commands

Source: https://github.com/stripe/stripe-cli/blob/master/CLAUDE.md

Common Makefile targets and Go tool commands for building, testing, linting, formatting, and running CI. Place temporary binaries in bin/ to avoid macOS security blocks.

```bash
make build              # Build binary (runs go generate first)
make test               # Run tests with race detector and coverage
make lint               # Run golangci-lint v2
make fmt                # Format with gofmt + goimports
make ci                 # Full CI: build-all-platforms + test + go-mod-tidy + protoc-ci
make protoc             # Regenerate all protobuf code
make setup              # Download Go modules
go build ./...          # Quick compilation check
go vet ./...            # Static analysis
```

--------------------------------

### Show help for charges resource

Source: https://github.com/stripe/stripe-cli/wiki/Resource-commands

Displays help for the charges resource, listing available actions.

```sh
$ stripe charges --help
```

--------------------------------

### Build the CLI binary

Source: https://github.com/stripe/stripe-cli/blob/master/canary/README.md

Build the Stripe CLI binary before running canary tests.

```bash
make build
```

--------------------------------

### Run stripe open with a shortcut

Source: https://github.com/stripe/stripe-cli/wiki/Open-command

Invokes the `open` command with a shortcut to open the corresponding Stripe page.

```sh
$ stripe open <shortcut>
```

--------------------------------

### Create Dockerfile-cli for Stripe CLI

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Create a Dockerfile for the Stripe CLI that adds password store and GPG agent dependencies.svg, copies the entrypoint script, and sets it as the container entrypoint.

```sh
FROM  stripe/stripe-cli:vx.x.x
RUN  apk  add  pass  gpg-agent
COPY  ./entrypoint.sh  /entrypoint.sh
ENTRYPOINT  [ "/entrypoint.sh" ]
```

--------------------------------

### Build binary and set STRIPE_CLI_BINARY

Source: https://github.com/stripe/stripe-cli/blob/master/canary/README.md

Builds the Stripe CLI binary and sets the STRIPE_CLI_BINARY environment variable to the built binary path. Required to run canary tests.

```bash
make build
export STRIPE_CLI_BINARY=$(pwd)/stripe
```

--------------------------------

### Set API key and run all tests via make

Source: https://github.com/stripe/stripe-cli/blob/master/canary/README.md

Set the STRIPE_API_KEY environment variable and run all canary tests including API tests.

```bash
export STRIPE_API_KEY=sk_test_...
```

```bash
make canary
```

--------------------------------

### List available Stripe CLI resources

Source: https://github.com/stripe/stripe-cli/wiki/Resource-commands

Lists all available Stripe CLI resources.

```sh
$ stripe resources
```

--------------------------------

### List config values

Source: https://github.com/stripe/stripe-cli/wiki/Config-command

Lists all configuration values using the `--list` flag.

```sh
$ stripe config --list
```

--------------------------------

### Run all tests directly

Source: https://github.com/stripe/stripe-cli/blob/master/canary/README.md

Run all canary tests directly with go test, setting both binary path and API key.

```bash
STRIPE_CLI_BINARY=$(pwd)/stripe STRIPE_API_KEY=sk_test_... go test -v -timeout 15m ./canary/...
```

--------------------------------

### stripe login --project-name (project configuration)

Source: https://github.com/stripe/stripe-cli/wiki/Login-command

Creates a project-specific configuration using the --project-name flag. Without this flag, commands default to the global configuration.

```sh
$ stripe login --project-name=rocket-rides

```

--------------------------------

### GitHub CLI with GH_HOST

Source: https://github.com/stripe/stripe-cli/blob/master/CLAUDE.md

Set GH_HOST to github.com for gh commands to target public GitHub. Use direnv allow or prefix commands with GH_HOST=github.com.

```bash
GH_HOST=github.com gh pr create ...
GH_HOST=github.com gh pr view ...
```

--------------------------------

### Set a config value

Source: https://github.com/stripe/stripe-cli/wiki/Config-command

Sets a configuration value by providing the key name and value.

```sh
$ stripe config <name> <value>
```

--------------------------------

### stripe listen

Source: https://github.com/stripe/stripe-cli/wiki/Listen-command

Establishes a direct connection with Stripe to receive webhook events. By default, it displays all events in the terminal. Use --forward-to to forward events to a local endpoint.

```APIDOC
## stripe listen

### Description
Establishes a direct connection with Stripe, delivering webhook events to your computer. By default, it accepts all webhook events and displays them in your terminal. Use --forward-to to forward events to a local application.

### Command
`stripe listen`

### Options
- `--forward-to` (string) - Optional - The location to forward webhook events to, e.g., `localhost:3000` or `https://example.com/hooks`. When used, a webhook signing secret is returned.
- `--events` (string) - Optional - A comma-separated list of Stripe events to listen to, e.g., `payment_intent.created,payment_intent.succeeded`.
- `--load-from-webhooks-api` (flag) - Optional - Automatically listen to events from webhook endpoints configured in test mode for your account. Must be used with `--forward-to`.
- `--forward-connect-to` (string) - Optional - The location to forward connect events for all connected accounts, e.g., `localhost:3000/connect_webhook`.

### Examples
```sh
$ stripe listen --forward-to https://example.com/hooks
> Ready! Your webhook signing secret is whsec_oZ8nus9PHnoltEtWZ3pGITZdeHWHoqnL (^C to quit)
```

```sh
$ stripe listen --events=payment_intent.created,payment_intent.succeeded
```

```sh
$ stripe listen --load-from-webhooks-api --forward-to https://example.com/hooks
```

```sh
$ stripe listen --forward-to localhost:3000/webhook --forward-connect-to localhost:3000/connect_webhook
```

### Notes
- You do not need to configure webhook endpoints in your Dashboard to receive webhooks with the CLI.
- The webhook signing secret provided will not change between restarts of the `listen` command.
- You will receive events for all interactions on your Stripe account; there is currently no way to limit events to only those that a specific user created.
```

--------------------------------

### Run data analytics canary tests locally

Source: https://github.com/stripe/stripe-cli/blob/master/canary/README.md

Sets environment variables for the CLI binary and API key, then runs the canary tests with the `data_analytics_canary` build tag, filtering to offline and API tests.

```bash
export STRIPE_CLI_BINARY=$(pwd)/stripe
export STRIPE_API_KEY=sk_test_...
go test -tags data_analytics_canary -v ./canary/... \
  -run "TestOfflineDataMetricsRunHelp|TestOfflineReporting|TestAPIDataMetricsRun|TestAPIReportingQueryRuns"
```

--------------------------------

### Invoke local CLI with go run

Source: https://github.com/stripe/stripe-cli/blob/master/CONTRIBUTING.md

Invoke the local version of the Stripe CLI.

```sh
$ go run cmd/stripe/main.go
```

--------------------------------

### Run Stripe CLI Docker image for version check

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Run the Stripe CLI Docker image to check its version. Output shows the version in the format 'stripe version x.y.z (beta)'.

```sh
docker run --rm -it stripe/stripe-cli version
```

--------------------------------

### Print Stripe CLI version with `stripe --version`

Source: https://github.com/stripe/stripe-cli/wiki/Version-command

Use the `--version` flag to print the current Stripe CLI version.

```sh
$ stripe --version
```

--------------------------------

### Run Stripe CLI Docker image with password volumes

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Run the Docker image with password volumes. Replace $command with the appropriate Stripe CLI command (e.g., 'customers list'). For live mode requests, append --live after $command.

```sh
docker run --rm -it -v stripe-config://root/.config/stripe/ -v stripe-gpg://root/.gnupg/ -v stripe-pass://root/.password-store/ stripe-cli $command
```

--------------------------------

### Build Stripe CLI Docker image

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Build the Docker image named 'stripe-cli' using the Dockerfile-cli in the current directory.

```sh
docker build -t stripe-cli -f Dockerfile-cli .
```

--------------------------------

### Forward Connect events with --forward-connect-to flag

Source: https://github.com/stripe/stripe-cli/wiki/Listen-command

Use the separate --forward-connect-to flag to also listen for Connect events from all connected accounts, alongside the regular --forward-to flag.

```sh
stripe listen --forward-to localhost:3000/webhook --forward-connect-to localhost:3000/connect_webhook
```

--------------------------------

### Set the binary path

Source: https://github.com/stripe/stripe-cli/blob/master/canary/README.md

Set the STRIPE_CLI_BINARY environment variable to the built binary path.

```bash
export STRIPE_CLI_BINARY=$(pwd)/stripe
```

--------------------------------

### Run Stripe CLI Docker image and its version output

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Run the Stripe CLI Docker image to check its version. The output shows the version in the format 'stripe version x.y.z (beta)'.

```sh
docker run --rm -it stripe/stripe-cli version
stripe version x.y.z (beta)
```

--------------------------------

### Search Stripe Docs with CLI

Source: https://github.com/stripe/stripe-cli/blob/master/pkg/docs/markdown/testdata/showcase.md

Searches Stripe documentation for the query "payment intents" using the Stripe CLI. Outputs matching documentation links.

```sh
stripe docs search "payment intents"
```

--------------------------------

### Upgrade Stripe CLI with WinGet (Windows)

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Upgrades the Stripe CLI using WinGet on Windows.

```sh
winget upgrade Stripe.StripeCLI
```

--------------------------------

### Generate ZSH completion script

Source: https://github.com/stripe/stripe-cli/wiki/Completion-command

Run this command to generate the `stripe-completion.zsh` file for ZSH autocompletion.

```bash
stripe completion
```

--------------------------------

### Add completion directory to fpath in .zshrc

Source: https://github.com/stripe/stripe-cli/wiki/Completion-command

Add the `~/.stripe` directory to the `fpath` array in your `~/.zshrc` so ZSH can find the completion script.

```zsh
fpath=("~/.stripe" $fpath)
```

--------------------------------

### Upgrade Stripe CLI with Scoop (Windows)

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Upgrades the Stripe CLI using Scoop on Windows.

```sh
scoop update stripe
```

--------------------------------

### Move ZSH completion script to home directory

Source: https://github.com/stripe/stripe-cli/wiki/Completion-command

Move the generated completion script to `~/.stripe` so it can be loaded automatically by ZSH.

```bash
mv stripe-completion.zsh ~/.stripe
```

--------------------------------

### Run offline tests via make

Source: https://github.com/stripe/stripe-cli/blob/master/canary/README.md

Run canary tests that don't require API access.

```bash
make canary-offline
```

--------------------------------

### stripe login --interactive (manual API key)

Source: https://github.com/stripe/stripe-cli/wiki/Login-command

Manually provides an API key with the --interactive flag. Shows the interactive prompts and confirmation output.

```sh
$ stripe login --interactive
Enter your API key: sk_test_foobar
Your API key is: sk_test_**obar
How would you like to identify this device in the Stripe Dashboard? [default: st-tomer1]
You're configured and all set to get started

```

--------------------------------

### Upgrade Stripe CLI with apt (Debian/Ubuntu)

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Updates package lists and upgrades the Stripe CLI using apt on Debian or Ubuntu.

```sh
sudo apt update && sudo apt upgrade stripe
```

--------------------------------

### Edit config file

Source: https://github.com/stripe/stripe-cli/wiki/Config-command

Opens the config file in the default editor using the `--edit` or `-e` flag.

```sh
$ stripe config -e
```

--------------------------------

### Listen and forward webhooks to a URL, showing signing secret

Source: https://github.com/stripe/stripe-cli/wiki/Listen-command

When you provide the --forward-to flag, the CLI prints the webhook signing secret that you should add to your application's configuration. The secret remains stable across restarts of the listen command.

```sh
stripe listen --forward-to https://example.com/hooks
> Ready! Your webhook signing secret is whsec_oZ8nus9PHnoltEtWZ3pGITZdeHWHoqnL (^C to quit)
```

--------------------------------

### Source ZSH completion script

Source: https://github.com/stripe/stripe-cli/wiki/Completion-command

Source the generated `stripe-completion.zsh` file to enable autocompletion in the current shell session.

```bash
source stripe-completion.zsh
```

--------------------------------

### Wrap errors with fmt.Errorf and %w

Source: https://github.com/stripe/stripe-cli/blob/master/CONTRIBUTING.md

When adding context to an existing error, use %w to preserve the category and concrete error type through the unwrap chain.

```go
return fmt.Errorf("loading configuration: %w", err)
```

--------------------------------

### Listen to events from existing webhook endpoints with --load-from-webhooks-api

Source: https://github.com/stripe/stripe-cli/wiki/Listen-command

Use --load-from-webhooks-api together with --forward-to to automatically listen to the events configured on your existing test-mode webhook endpoints in the Dashboard, forwarding those events to the provided URL.

```sh
stripe listen --load-from-webhooks-api --forward-to https://example.com/hooks
```

--------------------------------

### POST /charges

Source: https://github.com/stripe/stripe-cli/wiki/HTTP-(get,-post-&-delete)-commands

Create a new charge using the Stripe CLI post command with data flags.

```APIDOC
## POST /charges

### Description
Create a new charge using the Stripe CLI post command with data flags.

### Method
POST

### Endpoint
/charges

### Parameters
#### Request Body
- **amount** (integer) - Required - The amount to charge.
- **source** (string) - Required - The payment source (e.g., tok_visa).
- **currency** (string) - Required - The currency code (e.g., usd).

### Request Example
```sh
$ stripe post /charges -d amount=100 -d source=tok_visa -d currency=usd
```

### Response
#### Success Response (200)
Returns the created charge object.

#### Response Example
```json
{
  "id": "ch_123",
  "object": "charge",
  "amount": 100,
  "currency": "usd"
}
```
```

--------------------------------

### GoReleaser Version Injection

Source: https://github.com/stripe/stripe-cli/blob/master/CLAUDE.md

GoReleaser sets the version at build time using ldflags. Default value is "master" for dev builds.

```text
-ldflags "-s -w -X github.com/stripe/stripe-cli/pkg/version.Version={{.Version}}"
```

--------------------------------

### Extract Stripe CLI Linux archive

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Extract the Linux release archive. Move the stripe binary to a directory on your PATH after extraction.

```sh
tar -xvf stripe_X.X.X_linux_x86_64.tar.gz
```

--------------------------------

### Upgrade Stripe CLI with Homebrew (macOS)

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Upgrades the Stripe CLI using Homebrew on macOS.

```sh
brew upgrade stripe
```

--------------------------------

### Run Stripe CLI command with npx

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Run a Stripe CLI command directly with npx without permanently adding it to PATH.

```sh
npx @stripe/cli login
```

--------------------------------

### Increase test timeout

Source: https://github.com/stripe/stripe-cli/blob/master/canary/README.md

Runs canary tests with a 30-minute timeout using the go test command.

```bash
go test -v -timeout 30m ./canary/...
```

--------------------------------

### Basic Stripe CLI API requests for charges

Source: https://github.com/stripe/stripe-cli/wiki/Resource-commands

Shows basic API requests for the charges resource: retrieve, create, and update. The update command uses the -d flag to set metadata.

```sh
$ stripe charges retrieve ch_123
$ stripe charges create --amount=100 --currency=usd --source=tok_visa
$ stripe charges update ch_123 -d "metadata[key]=value"
```

--------------------------------

### Run offline tests directly

Source: https://github.com/stripe/stripe-cli/blob/master/canary/README.md

Run offline canary tests directly with go test, filtering to TestOffline.

```bash
STRIPE_CLI_BINARY=$(pwd)/stripe go test -v ./canary/... -run "TestOffline"
```

--------------------------------

### Upgrade Stripe CLI with yum (RedHat/Fedora/CentOS)

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Upgrades the Stripe CLI using yum on RedHat, Fedora, or CentOS.

```sh
yum update stripe
```

--------------------------------

### Upgrade Stripe CLI with Docker

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Pulls the latest Docker image for the Stripe CLI. Note that `stripe login` is not supported in Docker containers; use the `--api-key` flag instead.

```sh
docker pull stripe/stripe-cli:latest
```

--------------------------------

### Create categorized errors with errorcategory

Source: https://github.com/stripe/stripe-cli/blob/master/CONTRIBUTING.md

Assign semantic categories to errors in production code. Use errorcategory.New for fixed messages and errorcategory.Errorf for formatted messages.

```go
return errorcategory.New(errorcategory.UserInput, "an argument is required")
return errorcategory.Errorf(errorcategory.Auth, "profile %q has no API key", profile)
```

--------------------------------

### Uninstall Stripe CLI with WinGet (Windows)

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Uninstalls the Stripe CLI using WinGet on Windows.

```sh
winget uninstall Stripe.StripeCLI
```

--------------------------------

### Add stripe-dev alias to shell profile

Source: https://github.com/stripe/stripe-cli/blob/master/CONTRIBUTING.md

Optional shell alias for running the local CLI. Only works from the stripe-cli directory; absolute paths won't work.

```sh
alias stripe-dev='go run cmd/stripe/main.go'
```

--------------------------------

### Uninstall Stripe CLI with apt (Debian/Ubuntu)

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Removes the Stripe CLI using apt on Debian or Ubuntu.

```sh
sudo apt remove stripe
```

--------------------------------

### Set test API key

Source: https://github.com/stripe/stripe-cli/blob/master/canary/README.md

Sets the STRIPE_API_KEY environment variable to a test API key. Required for API tests to run.

```bash
export STRIPE_API_KEY=sk_test_your_key_here
```

--------------------------------

### Uninstall Stripe CLI with Homebrew (macOS)

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Uninstalls the Stripe CLI using Homebrew on macOS.

```sh
brew uninstall stripe
```

--------------------------------

### Uninstall Stripe CLI with Scoop (Windows)

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Uninstalls the Stripe CLI using Scoop on Windows.

```sh
scoop uninstall stripe
```

--------------------------------

### Extract Stripe CLI macOS archive

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Extract the macOS release archive. After extraction, you can move the stripe binary to /usr/local/bin for global access.

```sh
tar -xvf stripe_X.X.X_mac-os_ARCH.tar.gz
```

--------------------------------

### Uninstall Stripe CLI with npm

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Uninstalls the Stripe CLI globally via npm on macOS, Linux, and Windows.

```sh
npm uninstall -g @stripe/cli
```

--------------------------------

### Listen only to specified events with --events flag

Source: https://github.com/stripe/stripe-cli/wiki/Listen-command

Use the --events flag with a comma-separated list of Stripe events to specify which webhook events you want to listen to.

```sh
stripe listen --events=payment_intent.created,payment_intent.succeeded
```

--------------------------------

### Uninstall Stripe CLI with Docker

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Removes the Stripe CLI Docker image.

```sh
docker rmi stripe/stripe-cli
```

--------------------------------

### Set custom timeout for specific tests

Source: https://github.com/stripe/stripe-cli/blob/master/canary/README.md

Configures a custom timeout for the test runner using the WithTimeout method. Useful for individual tests that need a different timeout.

```go
runner = runner.WithTimeout(2 * time.Minute)
```

--------------------------------

### Uninstall Stripe CLI with yum (RedHat/Fedora/CentOS)

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Removes the Stripe CLI using yum on RedHat, Fedora, or CentOS.

```sh
sudo yum remove stripe
```

--------------------------------

### Remove Stripe CLI configuration and credentials

Source: https://github.com/stripe/stripe-cli/blob/master/README.md

Optionally removes stored credentials and configuration after uninstalling. The CLI intentionally keeps configuration on uninstall, so this step is only needed if you want to delete it yourself.

```sh
# Clear stored credentials for every project you are logged into
stripe logout --all

# Remove all remaining CLI configuration
rm -rf "${XDG_CONFIG_HOME:-$HOME/.config}/stripe"
```

--------------------------------

### Unset a config value

Source: https://github.com/stripe/stripe-cli/wiki/Config-command

Unsets a configuration value using the `--unset` flag with the name.

```sh
$ stripe config --unset <name>
```

--------------------------------

### Plain Text Block

Source: https://github.com/stripe/stripe-cli/blob/master/pkg/docs/markdown/testdata/showcase.md

A plain text block without syntax highlighting. Use for non-code content or when language is unspecified.

```plaintext
plain text block
no syntax highlighting
```

--------------------------------

### Resend a Stripe webhook event

Source: https://github.com/stripe/stripe-cli/wiki/Events-resend-command

Use the Stripe CLI to resend a webhook event. Replace <event id> with the event ID you want to resend.

```bash
stripe events resend <event id>
```

--------------------------------

### DELETE /subscriptions/{id}

Source: https://github.com/stripe/stripe-cli/wiki/HTTP-(get,-post-&-delete)-commands

Delete a subscription by its ID using the Stripe CLI delete command.

```APIDOC
## DELETE /subscriptions/{id}

### Description
Delete a subscription by its ID using the Stripe CLI delete command.

### Method
DELETE

### Endpoint
/subscriptions/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the subscription to delete.

### Request Example
```sh
$ stripe delete /subscriptions/sub_123
```

### Response
#### Success Response (200)
Returns the deleted subscription object.

#### Response Example
```json
{
  "id": "sub_123",
  "object": "subscription",
  "deleted": true
}
```
```

--------------------------------

### Trigger a webhook event: stripe trigger <event>

Source: https://github.com/stripe/stripe-cli/wiki/Trigger-command

Used to manually trigger a test webhook event. The <event> placeholder must be replaced with a supported event name. Running this may trigger additional webhook events as part of the test.

```sh
$ stripe trigger <event>
```
Tokens:
Raw