@usethrottle/cli

Command-line tool for the Throttle multi-tenant payments platform.

Install

npm install -g @usethrottle/cli

Usage

Connect a BigCommerce store

throttle bc-connect

You'll be prompted for:

1. Your Throttle API key (sk_*) — create one in the Throttle dashboard.
2. Your BigCommerce store hash (the part of your store URL after stores/)
3. Your BigCommerce API token (Settings → API accounts → Create V2/V3 API token; needs Modify scopes for Orders, Customers, Carts, Webhooks)

Or non-interactive:

throttle bc-connect --api-key sk_xxx --store-hash abc123 --access-token tok_xxx

Disconnect a store

throttle bc-disconnect conn_xxx

(Soft-delete; throttle hard-deletes after 90 days.)

Embed config (allowlist + branding)

The <PaymentEmbed/> / <CheckoutEmbed/> React components and the hosted page in iframe mode require your parent origin to be on the merchant's allowlist before they'll render.

throttle embed-config show

throttle embed-config set \
  --origins https://shop.example.com,https://staging.shop.example.com \
  --primary "#ff6b00" \
  --logo https://shop.example.com/logo.png \
  --merchant-name "Shop"

Origins must be https://host[:port]. No paths, no trailing slashes, no wildcards. Up to 20 entries.

Configuration

| Flag | Env var | Default | | ----------- | ------------------ | ----------------------------- | | --api | THROTTLE_API_URL | https://api.usethrottle.dev | | --api-key | THROTTLE_API_KEY | (interactive prompt) |