Skip to content

command-reference.generated.md

Latest commit

 

History

History
445 lines (255 loc) · 8.82 KB

command-reference.generated.md

File metadata and controls

445 lines (255 loc) · 8.82 KB
Raw

Generated Command Reference

login [options]

Authenticate with a WooPayments store.

Options:

  • --site <url> — Store site URL.
  • --name <name> — Profile name. Defaults to the site hostname.
  • --consumer-key <key> — WooCommerce consumer key. Defaults to WCPAY_CONSUMER_KEY.
  • --consumer-secret <secret> — WooCommerce consumer secret. Defaults to WCPAY_CONSUMER_SECRET.
  • --allow-insecure-local — Allow HTTP for local development stores.
  • --no-verify — Save credentials without verifying them first.
  • --yes — Continue even if a profile is already configured.
  • --json — Emit JSON output.

auth [command]

Manage WooCommerce REST API credentials.

auth add [options]

Add a site profile.

Options:

  • --site <url> — Store site URL.
  • --name <name> — Profile name. Defaults to the site hostname.
  • --consumer-key <key> — WooCommerce consumer key. Defaults to WCPAY_CONSUMER_KEY.
  • --consumer-secret <secret> — WooCommerce consumer secret. Defaults to WCPAY_CONSUMER_SECRET.
  • --allow-insecure-local — Allow HTTP for local development stores.
  • --no-verify — Save credentials without verifying them first.
  • --json — Emit JSON output.

auth list [options]

List site profiles.

Options:

  • --json — Emit JSON output.

auth remove <profile>

Remove a site profile.

Options:

  • --json — Emit JSON output.

auth test [profile]

Validate credentials for a profile.

Options:

  • --json — Emit JSON output.

profile [command]

Manage the active site profile.

profile use <profile>

Set the default profile.

Options:

  • --json — Emit JSON output.

whoami [options]

Show authenticated site/user context.

Options:

  • --json — Emit JSON output.

api <method> <path> [fields...]

Make an authenticated store REST API request.

Options:

  • --json — Emit JSON output.
  • --dry-run — Print the request without sending it.
  • --allow-unsafe-path — Allow raw write requests outside reviewed WooPayments/WooCommerce paths.

mode [options]

Show WooPayments mode for the selected profile.

Options:

  • --json — Emit JSON output.

doctor [options]

Run WooPayments diagnostics.

Options:

  • --json — Emit JSON output.
  • --redact — Redact sensitive values.

account [command]

Inspect WooPayments account information.

account status [options]

Show account status.

Options:

  • --json — Emit JSON output.

settings [command]

Inspect WooPayments settings.

settings get [options]

Show settings.

Options:

  • --json — Emit JSON output.

deposits [command]

Inspect WooPayments deposits.

deposits list [options]

List deposits.

Options:

  • --json — Emit JSON output.
  • --page <page> — Page number.
  • --limit <limit> — Page size.
  • --since <date> — Filter after this date.
  • --until <date> — Filter before this date.
  • --status <status> — Filter status.
  • --all — Fetch all pages (up to 10 pages of 100 records).

deposits get <id>

Get a deposit.

Options:

  • --json — Emit JSON output.

deposits overview [options]

Show deposit and balance overview across currencies.

Options:

  • --json — Emit JSON output.

disputes [command]

Inspect WooPayments disputes.

disputes list [options]

List disputes.

Options:

  • --json — Emit JSON output.
  • --page <page> — Page number.
  • --limit <limit> — Page size.
  • --since <date> — Filter after this date.
  • --until <date> — Filter before this date.
  • --status <status> — Filter status.
  • --all — Fetch all pages (up to 10 pages of 100 records).

disputes get <id>

Get a dispute.

Options:

  • --json — Emit JSON output.

disputes summary [options]

Show dispute counts by status.

Options:

  • --json — Emit JSON output.

disputes close <id>

Close (concede) a test/dev-mode dispute.

Options:

  • --dry-run — Print the request without sending it.
  • --yes — Confirm the test/dev-mode write.
  • --json — Emit JSON output.

transactions [command]

Inspect WooPayments transactions.

transactions list [options]

List transactions.

Options:

  • --json — Emit JSON output.
  • --page <page> — Page number.
  • --limit <limit> — Page size.
  • --since <date> — Filter after this date.
  • --until <date> — Filter before this date.
  • --currency <code> — Filter store currency.
  • --all — Fetch all pages (up to 10 pages of 100 records).

transactions summary [options]

Show transaction totals for the selected filters.

Options:

  • --json — Emit JSON output.
  • --since <date> — Filter after this date.
  • --until <date> — Filter before this date.

transactions get <id>

Get a transaction by ID if the store endpoint supports it.

Options:

  • --json — Emit JSON output.

charges [command]

Inspect WooPayments charges.

charges get <id>

Get a charge.

Options:

  • --json — Emit JSON output.

payment-intents [command]

Inspect WooPayments payment intents.

payment-intents get <id>

Get a payment intent.

Options:

  • --json — Emit JSON output.

timeline [command]

Inspect WooPayments payment timelines.

timeline get <intent-id>

Get the event timeline for a payment intent.

Options:

  • --json — Emit JSON output.

authorizations [command]

Inspect and manage uncaptured payment authorizations.

authorizations list [options]

List uncaptured authorizations.

Options:

  • --json — Emit JSON output.
  • --page <page> — Page number.
  • --limit <limit> — Page size.
  • --all — Fetch all pages (up to 10 pages of 100 records).

authorizations get <payment-intent-id>

Get an authorization by payment intent ID.

Options:

  • --json — Emit JSON output.

authorizations summary [options]

Show a summary of uncaptured authorizations.

Options:

  • --json — Emit JSON output.

authorizations capture [options]

Capture a test/dev-mode authorization.

Options:

  • --order <order-id> — WooCommerce order ID.
  • --intent <payment-intent-id> — Payment intent ID.
  • --dry-run — Print the request without sending it.
  • --yes — Confirm the test/dev-mode write.
  • --json — Emit JSON output.

authorizations cancel [options]

Cancel a test/dev-mode authorization.

Options:

  • --order <order-id> — WooCommerce order ID.
  • --intent <payment-intent-id> — Payment intent ID.
  • --dry-run — Print the request without sending it.
  • --yes — Confirm the test/dev-mode write.
  • --json — Emit JSON output.

orders [command]

Inspect WooCommerce orders and their WooPayments metadata.

orders get <order-id>

Get an order with its WooPayments payment metadata.

Options:

  • --json — Emit JSON output.

refunds [command]

Create and inspect refunds.

refunds create [options]

Create a test/dev-mode refund.

Options:

  • --order <order-id> — WooCommerce order ID.
  • --charge <charge-id> — WooPayments/Stripe charge ID.
  • --amount <minor-units> — Refund amount in minor currency units.
  • --reason <reason> — Refund reason: requested_by_customer, duplicate, or fraudulent.
  • --dry-run — Print the request without sending it.
  • --yes — Confirm the test/dev-mode write.
  • --json — Emit JSON output.

test [command]

Run test/dev-mode WooPayments workflows.

test order [command]

Test order workflows.

test order create [options]

Create a test order from an existing product.

Options:

  • --product <product-id> — Existing WooCommerce product ID.
  • --quantity <quantity> — Quantity.
  • --email <email> — Billing email for the order.
  • --dry-run — Print the request without sending it.
  • --yes — Confirm the test/dev-mode write.
  • --json — Emit JSON output.

test payment [command]

Test payment workflows.

test payment scenarios [options]

List built-in test payment scenarios.

Options:

  • --json — Emit JSON output.

test payment create [options]

Create a test payment using a built-in scenario alias.

Options:

  • --order <order-id> — WooCommerce order ID.
  • --scenario <scenario> — Built-in scenario alias.
  • --payment-method <payment-method-id> — Override the scenario payment method ID.
  • --dry-run — Print the request without sending it.
  • --yes — Confirm the test/dev-mode write.
  • --json — Emit JSON output.

mcp [options]

Run the WooPayments CLI MCP server over stdio.

completions <shell>

Print shell completion script for bash, zsh, or fish.

Options:

  • --json — Emit JSON output.

tools [command]

Inspect agent/tool metadata.

tools describe [options]

Print machine-readable command/tool descriptions.

Options:

  • --json — Emit JSON output.

tools schema [options]

Print JSON schemas for standard CLI envelopes.

Options:

  • --json — Emit JSON output.