# Manage your account in the terminal

Use the Stripe CLI tools plugin to manage, configure, and operate your Stripe account inside your terminal.

For more details, see the [Stripe CLI reference](https://docs.stripe.com/cli.md).

The `stripe tools` plugin lets you manage and configure your Stripe account directly from the command line. It provides access to account operations that aren’t available through the standard CLI.

## Before you begin

- Install the [Stripe CLI](https://docs.stripe.com/stripe-cli/install.md) version 1.42.1 or later
- Install the tools plugin:

```bash
stripe plugin install tools
```

If you need to upgrade the plugin, run:

```bash
stripe plugin upgrade tools
```

## Search for operations 

Use the `search` subcommand to find available operations by keyword:

```bash
stripe tools search "branding"
```

```
Found 2 matching operations:

## get_brand_settings
  GET
  Lists all branding settings.
  → Use "stripe tools details get_brand_settings" to see full parameters

## update_brand_settings
  POST
  Body params: checkout_background_color*, checkout_border_style, checkout_button_color, ...
  Updates branding settings.
  → Use "stripe tools details update_brand_settings" to see full parameters
```

Use the operation name with `details` or `execute`.

## Inspect an operation 

Use the `details` subcommand to view the full parameter schema for an operation before executing it:

```bash
stripe tools details get_brand_settings --json
```

```json
{
  "operation": {
    "alias": "get_brand_settings",
    "method": "GET",
    "summary": "Retrieve brand settings",
    "short_description": "Lists all branding settings.",
    "description": "Lists all merchant branding settings for hosted surfaces and receipts.",
    "tags": ["Settings"],
    "parameters": {
      "path": [],
      "query": [
        {
          "name": "expand",
          "type": "array",
          "description": "Specifies which fields in the response should be expanded.",
          "required": false
        },
        {
          "name": "use_default_styles",
          "type": "boolean",
          "description": "If true, returns Stripe's default branding styles if unset on merchant instead of nil. Defaults to true.",
          "required": false
        }
      ],
      "body": []
    },
    "required_body_params": []
  }
}
```

The output shows the HTTP method, description, and all available parameters with their types and constraints. Pass `--json` for machine-readable output, or omit it for a human-readable summary. Run this before `execute` to understand what the operation expects.

## Execute an operation 

Use the `execute` subcommand to call an operation:

```bash
stripe tools execute get_brand_settings --live
stripe tools execute update_brand_settings --live --body '{"primary_color": "rgb(82, 95, 127)", "icon": "file_123"}'
```

For operations that accept a request body, pass it as JSON with the `--body` flag. Pass `--live` to execute against your live account.

## Command reference 

| Command                                           | Description                                  |
| ------------------------------------------------- | -------------------------------------------- |
| `stripe tools search <query>`                     | Search for operations by keyword.            |
| `stripe tools details <operation>`                | Show the parameter schema for an operation.  |
| `stripe tools execute <operation>`                | Execute an operation without a request body. |
| `stripe tools execute <operation> --body '{...}'` | Execute an operation with a request body.    |
| `stripe tools execute <operation> --live`         | Execute against your live account.           |

## Available operations 

The tools plugin currently exposes the following operations:

| Operation               | Description                                                                                 |
| ----------------------- | ------------------------------------------------------------------------------------------- |
| `get_brand_settings`    | Retrieve brand settings for Checkout, Payment Links, and receipts. Only works in live mode. |
| `update_brand_settings` | Update brand settings for Checkout, Payment Links, and receipts. Only works in live mode.   |

### Interested in fully managing your Stripe account from your CLI?

The tools plugin is in public preview. Add your email to get updates as new operations become available.

```bash
curl https://docs.stripe.com/preview/register \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Referer: https://docs.stripe.com/stripe-cli/tools-plugin" \
  -d '{"email": "EMAIL", "preview": "tools_plugin"}'
```