@whop/cli 0.14.1 → 0.14.3

package/skills/whop-cards/SKILL.md

@@ -9,15 +9,125 @@ Cards represent Whop-issued virtual payment cards that spend from an account or
 
 Use the Cards API to issue cards, list cards for an account or user, and retrieve active card details such as the card number and CVC.
 
-## Commands
-
-| Command | Description |
-|---------|-------------|
-| `whop cards transactions` | List Card Transactions |
-| `whop cards get-transaction` | Retrieve Card Transaction |
-| `whop cards list` | List Cards |
-| `whop cards create` | Create Card |
-| `whop cards get` | Retrieve Card |
-| `whop cards update` | Update Card |
-
-Run `whop cards <command> --help` for options, or `whop cards <command> --schema` for full argument details.
+# whop cards create
+
+Create Card
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | The owning account ID (a biz_ identifier). Provide this or user_id. |
+| `--assigned_user_id` | `string` | no |  | The account member (a user_ identifier) to assign the card to. Required for business card issuing accounts. |
+| `--name` | `string` | no |  | A display name for the card. |
+| `--spend_limit` | `number` | no |  | Spending limit amount, in dollars. |
+| `--spend_limit_frequency` | `string` | no |  | The window the spend limit applies to. |
+| `--transaction_limit` | `number` | no |  | Per-transaction limit amount, in dollars. |
+| `--user_id` | `string` | no |  | The owning user ID (a user_ identifier). Provide this or account_id. |
+| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
+
+> Confirm with the user before executing this destructive command.
+
+---
+
+# whop cards get
+
+Retrieve Card
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `card_id` | `string` | yes | Card ID to retrieve, prefixed `icrd_`. |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | The owning account ID (a biz_ identifier). Provide this or user_id. |
+| `--user_id` | `string` | no |  | The owning user ID (a user_ identifier). Provide this or account_id. |
+
+---
+
+# whop cards get-transaction
+
+Retrieve Card Transaction
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | The card transaction ID, prefixed `citx_`. |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | The account that owns the transaction, prefixed `biz_`. Defaults to the credential's account. |
+
+---
+
+# whop cards list
+
+List Cards
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | The owning account ID (a biz_ identifier). Provide this or user_id. |
+| `--user_id` | `string` | no |  | The owning user ID (a user_ identifier). Provide this or account_id. |
+
+---
+
+# whop cards transactions
+
+List Card Transactions
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | The account whose card transactions to list, prefixed `biz_`. Defaults to the credential's account. |
+| `--transaction_ids` | `array` | no |  | Return only these card transactions, each prefixed `citx_`. Repeat the parameter, or pass one comma-separated value. |
+| `--card_id` | `array` | no |  | Return only transactions charged to these cards, each prefixed `icrd_`. |
+| `--cardholder_id` | `array` | no |  | Return only transactions on cards assigned to these users, each prefixed `user_`. |
+| `--status` | `string` | no |  | Return only transactions with this status. |
+| `--created_after` | `string` | no |  | Return only transactions authorized at or after this ISO 8601 timestamp. |
+| `--created_before` | `string` | no |  | Return only transactions authorized at or before this ISO 8601 timestamp. |
+| `--order` | `string` | no |  | The field to sort by. Defaults to `created_at`. |
+| `--direction` | `string` | no |  | The sort direction. Defaults to `desc`. |
+| `--first` | `number` | no |  | The number of card transactions to return. |
+| `--after` | `string` | no |  | A cursor; returns card transactions after this position. |
+| `--last` | `number` | no |  | The number of card transactions to return, counting back from the end. |
+| `--before` | `string` | no |  | A cursor; returns card transactions before this position. |
+
+---
+
+# whop cards update
+
+Update Card
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `card_id` | `string` | yes | Card ID to retrieve, prefixed `icrd_`. |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | The owning account ID (a biz_ identifier). Provide this or user_id. |
+| `--billing` | `object` | no |  | New billing address. Requires line1, city, region, postal_code, and country_code. On an invited card, passing billing alone (as the invited user) completes onboarding and starts card provisioning. |
+| `--canceled` | `boolean` | no |  | Pass `true` to permanently cancel the card. A canceled card cannot be uncanceled. Cannot be combined with other fields. |
+| `--frozen` | `boolean` | no |  | Pass `true` to freeze the card, `false` to unfreeze it. The assigned cardholder may freeze their own card without the payout:account:update scope. |
+| `--name` | `string` | no |  | A display name for the card. |
+| `--pin` | `string` | no |  | New 4-digit PIN. Can only be set on a card assigned to the acting user, who may set it without the payout:account:update scope. |
+| `--remove_limit` | `boolean` | no |  | Pass `true` to remove the spending limit (make the card unlimited). |
+| `--spend_limit` | `number` | no |  | Spending limit amount, in dollars. |
+| `--spend_limit_frequency` | `string` | no |  | The window the spend limit applies to. |
+| `--transaction_limit` | `number` | no |  | Per-transaction limit amount, in dollars. |
+| `--user_id` | `string` | no |  | The owning user ID (a user_ identifier). Provide this or account_id. |
+
+> Confirm with the user before executing this destructive command.

package/skills/whop-checkout-configurations/SKILL.md

@@ -9,13 +9,69 @@ A Checkout Configuration is a reusable checkout link owned by an account. In `pa
 
 Use the Checkout Configurations API to create checkout links for an existing or inline plan, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used.
 
-## Commands
+# whop checkout-configurations create
 
-| Command | Description |
-|---------|-------------|
-| `whop checkout-configurations list` | List checkout configurations |
-| `whop checkout-configurations create` | Create a checkout configuration |
-| `whop checkout-configurations delete` | Delete a checkout configuration |
-| `whop checkout-configurations get` | Retrieve a checkout configuration |
+Create a checkout configuration
 
-Run `whop checkout-configurations <command> --help` for options, or `whop checkout-configurations <command> --schema` for full argument details.
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | Account ID, prefixed `biz_`. |
+| `--affiliate_code` | `unknown` | no |  | Affiliate code to apply to the checkout. |
+| `--currency` | `unknown` | no |  | Currency used for setup-mode payment method availability. |
+| `--metadata` | `unknown` | no |  | Custom key-value metadata copied to payments and memberships. |
+| `--mode` | `string` | no |  | Controls whether checkout charges the buyer immediately or saves payment details for later. Defaults to `payment`. |
+| `--payment_method_configuration` | `unknown` | no |  | Payment method overrides for this checkout. `null` uses the plan or platform defaults. |
+| `--plan` | `unknown` | no |  | Plan attributes used to create or find a plan for this checkout configuration. Mutually exclusive with `plan_id`. |
+| `--plan_id` | `unknown` | no |  | Existing plan ID, prefixed `plan_`. Mutually exclusive with `plan`. |
+| `--redirect_url` | `unknown` | no |  | URL customers are sent to after checkout. |
+| `--three_ds_level` | `unknown` | no |  | 3D Secure behavior for this checkout. |
+| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
+
+> Confirm with the user before executing this destructive command.
+
+---
+
+# whop checkout-configurations delete
+
+Delete a checkout configuration
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | The ID of the checkout configuration. |
+
+> Confirm with the user before executing this destructive command.
+
+---
+
+# whop checkout-configurations get
+
+Retrieve a checkout configuration
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | The ID of the checkout configuration. |
+
+---
+
+# whop checkout-configurations list
+
+List checkout configurations
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | Account ID, prefixed `biz_`. |
+| `--plan_id` | `string` | no |  | Only return checkout configurations for this plan ID, prefixed `plan_`. |
+| `--created_before` | `string` | no |  | Only return checkout configurations created before this ISO 8601 timestamp. |
+| `--created_after` | `string` | no |  | Only return checkout configurations created after this ISO 8601 timestamp. |
+| `--order` | `string` | no |  | Field used to sort checkout configurations. |
+| `--direction` | `string` | no |  | Sort direction. Defaults to `desc`. |
+| `--first` | `number` | no |  | Number of checkout configurations to return. |
+| `--after` | `string` | no |  | Cursor for the next page of results. |

package/skills/whop-deposits/SKILL.md

@@ -9,10 +9,18 @@ Deposits describe ways to add funds to an account balance, including hosted depo
 
 Use the Deposits API to create deposit instructions for an account.
 
-## Commands
+# whop deposits create
 
-| Command | Description |
-|---------|-------------|
-| `whop deposits create` | Create Deposit |
+Create Deposit
 
-Run `whop deposits <command> --help` for options, or `whop deposits <command> --schema` for full argument details.
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--amount` | `number` | no |  | Amount to prefill on hosted deposit page. |
+| `--destination` | `unknown` | yes |  | Destination account ID or wallet address. Object form is supported for compatibility. Any business resolves by its account ID without authentication; a user account resolves only for that same authenticated user. |
+| `--metadata` | `object` | no |  | Metadata to include with the deposit response. |
+| `--network` | `unknown` | no |  | Destination network override. Defaults to the destination wallet's own network. |
+| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
+
+> Confirm with the user before executing this destructive command.

package/skills/whop-disputes/SKILL.md

@@ -9,14 +9,91 @@ A Dispute is a chargeback a customer files against a payment through their bank,
 
 Disputes are opened by the customer's bank, never through the API, so you can read them but not create or delete them. Use the Disputes API to list and filter disputes, summarize them by status and currency for a queue view, edit the evidence packet while the dispute is still contestable, and submit that evidence for review.
 
-## Commands
+# whop disputes get
 
-| Command | Description |
-|---------|-------------|
-| `whop disputes list` | List Disputes |
-| `whop disputes summary` | Retrieve Dispute Summary |
-| `whop disputes get` | Retrieve Dispute |
-| `whop disputes update` | Update Dispute |
-| `whop disputes submit` | Submit Dispute |
+Retrieve Dispute
 
-Run `whop disputes <command> --help` for options, or `whop disputes <command> --schema` for full argument details.
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | The dispute ID (`dspt_` tag). |
+
+---
+
+# whop disputes list
+
+List Disputes
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | Only disputes filed against this account (`biz_` tag). Omit it to cover every account you can read. |
+| `--first` | `number` | no |  | The number of disputes to return (default 20, max 100). |
+| `--after` | `string` | no |  | A cursor; returns disputes after this position. |
+| `--last` | `number` | no |  | The number of disputes to return from the end of the range. |
+| `--before` | `string` | no |  | A cursor; returns disputes before this position. |
+| `--order` | `string` | no |  | The field to sort disputes by. |
+| `--direction` | `string` | no |  | Sort direction. |
+| `--status` | `array` | no |  | Only disputes in these statuses. Repeat the parameter to pass several — one paginated list covers all of them. Covers both chargebacks and inquiries at each stage. |
+| `--currency` | `string` | no |  | Only disputes in this three-letter ISO currency. |
+| `--created_before` | `string` | no |  | Only disputes opened before this ISO 8601 timestamp. |
+| `--created_after` | `string` | no |  | Only disputes opened after this ISO 8601 timestamp. |
+
+---
+
+# whop disputes submit
+
+Submit Dispute
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | The dispute ID (`dspt_` tag). |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
+
+> Confirm with the user before executing this destructive command.
+
+---
+
+# whop disputes summary
+
+Retrieve Dispute Summary
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--groups` | `array` | no |  | Which breakdowns to return, keyed by these names under `groups`. Repeat the parameter to ask for several; omit it for all of them. |
+| `--account_id` | `string` | no |  | Only disputes filed against this account (`biz_` tag). Omit it to cover every account you can read. |
+| `--status` | `array` | no |  | Only disputes in these statuses. Repeat the parameter to pass several. |
+| `--currency` | `string` | no |  | Only disputes in this three-letter ISO currency. |
+| `--created_before` | `string` | no |  | Only disputes opened before this ISO 8601 timestamp. |
+| `--created_after` | `string` | no |  | Only disputes opened after this ISO 8601 timestamp. |
+
+---
+
+# whop disputes update
+
+Update Dispute
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | The dispute ID (`dspt_` tag). |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--evidence` | `object` | no |  | The evidence packet to send to the processor. Only the fields you provide are changed. |
+
+> Confirm with the user before executing this destructive command.

package/skills/whop-events/SKILL.md

@@ -11,13 +11,95 @@ Use the Events API to send new tracking events, list recent identity-linked even
 
 Events are only as good as the pixel sending them, so [Validate Pixel](https://docs.whop.com/api-reference/beta/events/validate-pixel) answers whether an account's pixel is working: it reads the events the pixel has sent, and when you pass a `url` whose page hasn't sent any lately, it fetches that page and looks for the pixel in its source. Use it before launching an ad to confirm its destination is tracked, or in a setup flow to tell a merchant whether their install is live.
 
-## Commands
+# whop events create
 
-| Command | Description |
-|---------|-------------|
-| `whop events list` | List Events |
-| `whop events create` | Create Event |
-| `whop events pulse` | Retrieve the pulse feed |
-| `whop events validate_pixel` | Validate Pixel |
+Create Event
 
-Run `whop events <command> --help` for options, or `whop events <command> --schema` for full argument details.
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | yes |  | The account to associate with this event. |
+| `--action_source` | `unknown` | no |  | Where the event originated. |
+| `--context` | `unknown` | no |  | Tracking and attribution context. |
+| `--currency` | `unknown` | no |  | ISO 4217 currency code. |
+| `--custom_name` | `unknown` | no |  | Custom event name when event_name is 'custom'. Maximum 35 chars for this value. |
+| `--duration` | `number` | no |  | For 'leave' events: milliseconds the visitor spent on the page. |
+| `--event_id` | `unknown` | no |  | Client-provided identifier for deduplication. Generated if omitted. |
+| `--event_name` | `string` | yes |  | The type of event.
+
+Use a standard event (lead, submit_application, contact, complete_registration, schedule, view_content, add_to_cart) or pass your own name directly for a custom event. |
+| `--event_time` | `unknown` | no |  | When the event occurred. Defaults to now. |
+| `--plan_id` | `unknown` | no |  | The plan associated with the event. |
+| `--product_id` | `unknown` | no |  | The product associated with the event. |
+| `--referrer_url` | `unknown` | no |  | The referring URL. |
+| `--resumed` | `boolean` | no |  | For 'page' events: true when the page was restored from the back/forward cache. |
+| `--source` | `unknown` | no |  | For 'identify' events: where the identity was captured (url, form, manual, iframe). |
+| `--title` | `unknown` | no |  | For 'page' events: the document title. |
+| `--url` | `unknown` | no |  | The URL where the event occurred. |
+| `--user` | `unknown` | no |  | User identity and profile data. |
+| `--value` | `number` | no |  | Monetary value associated with the event. |
+| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
+
+> Confirm with the user before executing this destructive command.
+
+---
+
+# whop events list
+
+List Events
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--identifier` | `string` | no |  | Any hard identifier of the person: a person ID (prsn_*), user ID, email, phone number, or a tracking cookie value (wuid, anonymous ID, fbp/fbc/ttp/ga). Omit to list recent events for the account. |
+| `--account_id` | `string` | no |  | Account ID, prefixed `biz_`. Optional for account API keys; required for credentials that can access multiple accounts. |
+| `--from` | `string` | no |  | Start of the time range as an ISO 8601 timestamp. Required when identifier is omitted. |
+| `--to` | `string` | no |  | End of the time range as an ISO 8601 timestamp. Required when identifier is omitted; otherwise defaults to now. |
+| `--first` | `number` | no |  | The number of events to return. |
+| `--after` | `string` | no |  | A cursor for fetching events after a previous page. |
+| `--before` | `string` | no |  | A cursor for fetching events before a later page. |
+| `--direction` | `string` | no |  | The order events are returned in by time. Defaults to desc (most recent first); asc reads a journey forwards from where it starts. after and before always page forwards and backwards through that order. |
+| `--event` | `string` | no |  | Full event names to filter by, comma-separated (payment.completed, pixel.lead, pixel.page, pixel.custom:<name>) — the same vocabulary the events / people metrics use. |
+| `--source` | `string` | no |  | Canonical source path, exact or with a trailing :* prefix (whop:<campaign>:*, ext:meta:*, referrer:<domain>, direct). Restricts the list to conversion targets attributed to that source — the debuggability twin of a metric cell's source parameter. |
+| `--attribution_model` | `string` | no |  | Attribution model for the source filter (defaults to last_touch). |
+| `--country` | `string` | no |  | Country codes to filter by, comma-separated. |
+| `--city` | `string` | no |  | Cities to filter by, comma-separated. |
+| `--device` | `string` | no |  | Device families to filter by, comma-separated (e.g. iPhone, Mac). |
+| `--browser` | `string` | no |  | Browser families to filter by, comma-separated (e.g. Chrome, Mobile Safari). |
+| `--os` | `string` | no |  | Operating system families to filter by, comma-separated (e.g. iOS, Windows). |
+| `--utm_source` | `string` | no |  | utm_source values to filter by, comma-separated. |
+| `--hostname` | `string` | no |  | Page hostnames to filter by, comma-separated. |
+| `--page` | `string` | no |  | Page paths to filter by, comma-separated. |
+
+---
+
+# whop events pulse
+
+Retrieve the pulse feed
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--event` | `string` | no |  | Filter to one or more types, comma separated — for example `withdrawal,card_spend`. These are the item's `type`, not its `event_name`: several types share the `ledger_line.created` event name. Omit for every type in the feed. Values outside the feed's own set are rejected. |
+| `--first` | `number` | no |  | The number of events to return. |
+| `--after` | `string` | no |  | A cursor for fetching events after a previous page. |
+| `--before` | `string` | no |  | A cursor for fetching events before a later page. |
+
+---
+
+# whop events validate_pixel
+
+Validate Pixel
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | Account to check. Defaults to the authenticated account. |
+| `--url` | `string` | no |  | A page to read for the pixel, e.g. an ad destination. Omit it to check the account from its events alone. |
+| `--idempotency-key` | `string` | no |  | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
+
+> Confirm with the user before executing this destructive command.