@whop/cli 0.14.1 → 0.14.3

package/skills/whop-notifications/SKILL.md

@@ -11,15 +11,94 @@ Every notification belongs to a topic: the category it falls under, such as new
 
 Use the Notifications API to list the authenticated user's feed, read per-experience unread badges, mark an experience (or everything) as read, send notifications from your app to an experience's users or an account's team, and list the topic catalog.
 
-## Commands
-
-| Command | Description |
-|---------|-------------|
-| `whop notifications list` | List Notifications |
-| `whop notifications create` | Send Notification |
-| `whop notifications badges` | List Notification Badges |
-| `whop notifications mark_read` | Mark Notifications Read |
-| `whop notifications topics` | List Notification Topics |
-| `whop notifications get` | Retrieve Notification |
-
-Run `whop notifications <command> --help` for options, or `whop notifications <command> --schema` for full argument details.
+# whop notifications badges
+
+List Notification Badges
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--experience_ids` | `array` | no |  | Only return badges for these experiences (`exp_` tags). |
+| `--last_fetched_at` | `string` | no |  | The client's last fetched-at ISO 8601 timestamp, used to partially refresh badges after a websocket message. |
+
+---
+
+# whop notifications create
+
+Send Notification
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | Account whose team members receive the notification (`biz_` tag). Exactly one of `experience_id` or `account_id` is required. |
+| `--content` | `string` | yes |  | Main body text of the notification. |
+| `--experience_id` | `string` | no |  | Experience whose users receive the notification (`exp_` tag). Exactly one of `experience_id` or `account_id` is required. |
+| `--icon_user_id` | `unknown` | no |  | User whose profile picture is used as the notification icon. Defaults to the experience or account avatar. |
+| `--rest_path` | `unknown` | no |  | Path segment appended to the generated deep link that opens your app, for example `/settings/billing`. |
+| `--subtitle` | `unknown` | no |  | Optional secondary line displayed below the title. |
+| `--title` | `string` | yes |  | Headline text of the notification. |
+| `--user_ids` | `array` | no |  | Optional `user_` tags narrowing the audience. When provided, only these users are notified (as a mention), provided they are in the targeted experience or account. |
+| `--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 notifications get
+
+Retrieve Notification
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `notification_id` | `string` | yes | A notification `id` from List Notifications, or the id delivered with a push/websocket event. |
+
+---
+
+# whop notifications list
+
+List Notifications
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--unread` | `boolean` | no |  | Only return notifications created since the user last viewed their source. |
+| `--experience_id` | `string` | no |  | Only return notifications from this experience (`exp_` tag). |
+| `--account_id` | `string` | no |  | Only return team notifications for this account (`biz_` tag). |
+| `--mentions` | `boolean` | no |  | Only return notifications that mention the user directly. |
+| `--first` | `number` | no |  | The number of notifications to return (default 20, max 100). |
+| `--after` | `string` | no |  | A cursor (a notification `id` from a previous page); returns notifications older than it. |
+
+---
+
+# whop notifications mark_read
+
+Mark Notifications Read
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--all` | `boolean` | no |  | Pass `true` to mark every notification read. Exactly one of `experience_id` or `all` is required. |
+| `--experience_id` | `string` | no |  | Experience to mark read (`exp_` tag). Exactly one of `experience_id` or `all` is required. |
+| `--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 notifications topics
+
+List Notification Topics
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--topic_type` | `string` | no |  | Only return topics of this scope: `user` (member notifications) or `account_team` (team notifications). |
+| `--first` | `number` | no |  | The number of topics to return (default 20, max 100). |
+| `--after` | `string` | no |  | A cursor; returns topics after this position. |

package/skills/whop-partners/SKILL.md

@@ -9,15 +9,105 @@ The Partners API covers your Whop partner activity: the users you referred onto
 
 Use it to enroll as a Whop partner, list the users you referred, list your referred businesses and review their earnings, and see the partner leaderboard.
 
-## Commands
-
-| Command | Description |
-|---------|-------------|
-| `whop partners create` | Enroll as a Whop partner |
-| `whop partners list` | List referred businesses |
-| `whop partners get` | Retrieve a referred business |
-| `whop partners earnings` | List referred business earnings |
-| `whop partners leaderboard` | Retrieve the leaderboard |
-| `whop partners referred_users` | List the users the caller referred |
-
-Run `whop partners <command> --help` for options, or `whop partners <command> --schema` for full argument details.
+# whop partners create
+
+Enroll as a Whop partner
+
+## 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 partners earnings
+
+List referred business earnings
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | The partner business ID (a coma_ identifier). |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--status` | `string` | no |  | Filter by earning status. |
+| `--first` | `number` | no | `20` |  |
+| `--after` | `string` | no |  |  |
+| `--last` | `number` | no |  |  |
+| `--before` | `string` | no |  |  |
+| `--order` | `string` | no |  | The field to sort earnings by. |
+| `--direction` | `string` | no |  | Sort direction. |
+| `--created_before` | `string` | no |  | Only return earnings created before this timestamp. |
+| `--created_after` | `string` | no |  | Only return earnings created after this timestamp. |
+
+---
+
+# whop partners get
+
+Retrieve a referred business
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | The partner business ID (a coma_ identifier). |
+
+---
+
+# whop partners leaderboard
+
+Retrieve the leaderboard
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--period` | `string` | no |  | Time window for the rankings. `day`, `month`, and `year` count earnings since the start of the current calendar day, month, or year; `last_30_days` counts earnings over the trailing 30 days; `all_time` ranks lifetime earnings. |
+
+---
+
+# whop partners list
+
+List referred businesses
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--status` | `string` | no |  | Filter by referral status. |
+| `--has_earnings` | `boolean` | no |  | When true, only businesses with pending or completed earnings paid to the caller. |
+| `--first` | `number` | no | `20` | Number of partner businesses to return from the start of the window. |
+| `--after` | `string` | no |  | Cursor to fetch the page after (from page_info.end_cursor). |
+| `--last` | `number` | no |  | Number of partner businesses to return from the end of the window. |
+| `--before` | `string` | no |  | Cursor to fetch the page before (from page_info.start_cursor). |
+| `--order` | `string` | no |  | The field to sort partner businesses by. |
+| `--direction` | `string` | no |  | Sort direction. |
+| `--created_before` | `string` | no |  | Only return partner businesses created before this timestamp. |
+| `--created_after` | `string` | no |  | Only return partner businesses created after this timestamp. |
+| `--referred_user_id` | `string` | no |  | Filter to referrals attributed to this user. For first-tier referrals, this is the referred account owner; for second-tier referrals, this is the partner you recruited. |
+| `--referred_username` | `string` | no |  | Filter by the referred user's exact username. Ignored when `referred_user_id` is present. |
+| `--tier` | `string` | no |  | Filter to only first-tier referrals or only second-tier referrals. |
+
+---
+
+# whop partners referred_users
+
+List the users the caller referred
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--has_businesses` | `boolean` | no |  | When true, only referred users who brought at least one business onto Whop. |
+| `--has_earning_businesses` | `boolean` | no |  | When true, only referred users with at least one business that has generated earnings. |
+| `--first` | `number` | no | `20` | Number of referred users to return from the start of the window. |
+| `--after` | `string` | no |  | Cursor to fetch the page after (from page_info.end_cursor). |
+| `--last` | `number` | no |  | Number of referred users to return from the end of the window. |
+| `--before` | `string` | no |  | Cursor to fetch the page before (from page_info.start_cursor). |

package/skills/whop-payments/SKILL.md

@@ -0,0 +1,40 @@
+---
+name: whop-payments
+description: A charge against a buyer, and the step they still owe. Run `whop payments --help` for usage details.
+requires_bin: whop
+command: whop payments
+---
+
+A Payment is one charge against a buyer. Create it with a payment method already on file, or with a `confirmation_token` describing a method the buyer has just supplied.
+
+Collection runs in the background, so the create response is not the outcome. Poll [Retrieve status](https://docs.whop.com/api-reference/beta/payments/retrieve-status) for how far the payment has got and, while it is `requires_action`, what the buyer must do next — follow a redirect, complete 3D Secure, display transfer instructions, or link a bank account. Use the return_url operation to change where they land afterwards, up until they come back.
+
+# whop payments return_url
+
+Update payment return URL
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `payment_id` | `string` | yes | The unique identifier of the payment. |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--return_url` | `string` | yes |  | Where the buyer continues after completing an off-site step. Must be an absolute https URL without credentials, at most 2,048 characters. |
+
+> Confirm with the user before executing this destructive command.
+
+---
+
+# whop payments status
+
+Retrieve payment status
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `payment_id` | `string` | yes | The unique identifier of the payment. |

package/skills/whop-payouts/SKILL.md

@@ -7,15 +7,136 @@ command: whop payouts
 
 Payouts represent money sent from an account or user balance to an external destination, such as a bank account, wallet, or other saved payout method.
 
-Use the Payouts API to create payouts from stablecoin accounts, list payout history for accounts or users, monitor payout statuses, and show expected arrival details for funds leaving Whop.
+Use the Payouts API to create payouts from accounts, list payout history for accounts or users, monitor payout statuses, and show expected arrival details for funds leaving Whop.
 
-## Commands
+# whop payouts create
 
-| Command | Description |
-|---------|-------------|
-| `whop payouts list` | List Payouts |
-| `whop payouts create` | Create Payout |
-| `whop payouts methods` | List Payout Methods |
-| `whop payouts create-method` | Create Payout Method |
+Create Payout
 
-Run `whop payouts <command> --help` for options, or `whop payouts <command> --schema` for full argument details.
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | yes |  | The account to pay out from (a biz_ identifier). |
+| `--amount` | `number` | yes |  | The amount to pay out in the specified currency. |
+| `--currency` | `string` | no |  | The payout currency. Defaults to usd. |
+| `--payout_method_id` | `string` | yes |  | The saved payout method to deliver to (a potk_ identifier). |
+| `--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 payouts create-method
+
+Create Saved Payout Method
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | The account to add the payout method for (a biz_ identifier). Provide this or user_id. |
+| `--destination_currency` | `string` | no | `usd` | Currency the supported payout method delivers payouts in. |
+| `--fields` | `object` | yes |  | The supported payout method's required field values, keyed by field id — list them with `GET /payouts/supported_methods?supported_payout_method_id=...`. A Basis Theory token id may be passed in place of a raw value. A validation failure returns the method's full required_fields schema alongside the error. |
+| `--is_default` | `boolean` | no | `false` | Whether to make this the account's default payout method. |
+| `--nickname` | `string` | yes |  | A label for the payout method, unique per destination. |
+| `--supported_payout_method_id` | `string` | yes |  | The supported payout method to save (a podst_ identifier from a previous listing). |
+| `--user_id` | `string` | no |  | The user to add the payout method for (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 payouts delete-method
+
+Delete Saved Payout Method
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `payout_method_id` | `string` | yes | Payout method ID, prefixed `potk_`. |
+
+> Confirm with the user before executing this destructive command.
+
+---
+
+# whop payouts list
+
+List Payouts
+
+## 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. |
+| `--currency` | `string` | no |  | Optional currency code filter, for example `usd`. |
+| `--first` | `number` | no | `20` | Number of payouts to return from the start of the window. |
+| `--after` | `string` | no |  | Cursor to fetch the page after (from page_info.end_cursor). |
+| `--last` | `number` | no |  | Number of payouts to return from the end of the window. |
+| `--before` | `string` | no |  | Cursor to fetch the page before (from page_info.start_cursor). |
+
+---
+
+# whop payouts methods
+
+List Saved Payout Methods
+
+## 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. |
+| `--status` | `string` | no |  | Optional status filter. `created` means saved but unused, `active` means a payout through it succeeded, `broken` means the last payout failed and the method needs fixing. |
+| `--amount` | `number` | no |  | Optional withdrawal amount in whole currency units, for example `250.00`. When provided, each method includes a quote with the estimated fee, amount received, and delivery date for that amount. |
+| `--currency` | `string` | no | `usd` | Currency code of the amount, for example `usd`. Only meaningful with amount or include_limits. |
+| `--include_limits` | `boolean` | no | `false` | When true, the response also carries limits — the live per-speed payout caps the account's payout requests are validated against, in the requested currency. Requires the payout:withdrawal:read scope. |
+| `--first` | `number` | no | `20` | Number of payout methods to return from the start of the window. |
+| `--after` | `string` | no |  | Cursor to fetch the page after (from page_info.end_cursor). |
+| `--last` | `number` | no |  | Number of payout methods to return from the end of the window. |
+| `--before` | `string` | no |  | Cursor to fetch the page before (from page_info.start_cursor). |
+
+---
+
+# whop payouts supported-methods
+
+List Supported Payout Methods
+
+## 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. |
+| `--country` | `string` | no |  | ISO 3166-1 alpha-2 country code for the bank account or wallet, such as `US`. Defaults to the payout account's country. |
+| `--amount` | `number` | no |  | Optional withdrawal amount in whole currency units, for example `250.00`. When provided, each destination includes per-currency fee and delivery quotes. |
+| `--currency` | `string` | no | `usd` | Currency code of the amount, for example `usd`. Only meaningful with amount. |
+| `--supported_payout_method_id` | `string` | no |  | Narrows the list to one supported payout method (a podst_ identifier) and includes the required_fields needed to save it as a payout method. |
+| `--destination_currency` | `string` | no | `usd` | Currency the supported payout method would deliver payouts in. Only meaningful with supported_payout_method_id; required fields vary by destination currency. |
+| `--first` | `number` | no | `20` | Number of supported payout methods to return from the start of the window. |
+| `--after` | `string` | no |  | Cursor to fetch the page after (from page_info.end_cursor). |
+| `--last` | `number` | no |  | Number of supported payout methods to return from the end of the window. |
+| `--before` | `string` | no |  | Cursor to fetch the page before (from page_info.start_cursor). |
+
+---
+
+# whop payouts update-method
+
+Rename Saved Payout Method
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `payout_method_id` | `string` | yes | Payout method ID, prefixed `potk_`. |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--nickname` | `string` | yes |  | New label for the payout method. |
+
+> Confirm with the user before executing this destructive command.

package/skills/whop-people/SKILL.md

@@ -9,11 +9,55 @@ A Person is an identity-linked profile of a visitor or customer of an account, a
 
 Use the People API to list and segment the people of an account — filter by activity, purchases, traffic source, location, or marketing touch, and sort by value — or retrieve one person by person ID, user ID, email address, or phone number.
 
-## Commands
+# whop people get
 
-| Command | Description |
-|---------|-------------|
-| `whop people list` | List People |
-| `whop people get` | Retrieve Person |
+Retrieve Person
 
-Run `whop people <command> --help` for options, or `whop people <command> --schema` for full argument details.
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `person_id` | `string` | yes | The person ID, user ID, email address, or phone number to look up. |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | Account ID, prefixed `biz_`. Optional for account API keys; required for credentials that can access multiple accounts. |
+
+---
+
+# whop people list
+
+List People
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | Account ID, prefixed `biz_`. Optional for account API keys; required for credentials that can access multiple accounts. |
+| `--query` | `string` | no |  | Search people by name, email, phone, or whop user ID (case-insensitive substring match). |
+| `--source` | `array` | no |  | Only include people acquired from any of these sources — canonical paths (whop:<campaign>:<group>:<ad>, ext:<platform>:..., referrer:<domain>, direct, other), exact or with a trailing :* prefix. The same vocabulary the events / people metrics use. |
+| `--attribution_model` | `string` | no |  | Attribution model the source filter matches against (defaults to last_touch). |
+| `--event_name` | `array` | no |  | Only include people who fired any of these events, e.g. payment.completed or page.checkout.view. |
+| `--custom_event` | `string` | no |  | Only include people who fired this custom pixel event. |
+| `--event_from` | `string` | no |  | With event_to plus an event or source filter, switches to exact-population mode: person ids are resolved and paginated on the events side within this window (the same query the people metric counts), then hydrated per page. |
+| `--event_to` | `string` | no |  | The inclusive end of the event window for exact-population mode. |
+| `--audience_id` | `string` | no |  | Only include people in this audience. An audience that keeps itself up to date resolves to the People filters that define it, so this always reflects who matches now; uploaded lists and point-in-time snapshots match their recorded members. |
+| `--user_id` | `string` | no |  | Only include the person linked to this whop user ID. |
+| `--email` | `string` | no |  | Only include the person linked to this email address. |
+| `--phone` | `string` | no |  | Only include the person linked to this phone number. |
+| `--country` | `string` | no |  | Only include people whose most recent visit came from this ISO 3166-1 alpha-2 country code. |
+| `--has_purchased` | `boolean` | no |  | true for customers only, false for people who have never purchased. |
+| `--contactable` | `boolean` | no |  | true for people who have an email address or phone number — the ones an ad platform can match. |
+| `--first_seen_within_days` | `number` | no |  | Only include people first seen within this many days, as a rolling window. |
+| `--last_seen_within_days` | `number` | no |  | Only include people last seen within this many days, as a rolling window. |
+| `--first_seen_after` | `string` | no |  | Only include people first seen at or after this ISO 8601 timestamp. |
+| `--first_seen_before` | `string` | no |  | Only include people first seen before this ISO 8601 timestamp. |
+| `--last_seen_after` | `string` | no |  | Only include people last seen at or after this ISO 8601 timestamp. |
+| `--last_seen_before` | `string` | no |  | Only include people last seen before this ISO 8601 timestamp. |
+| `--first` | `number` | no |  | The number of people to return (default 100, max 100). |
+| `--after` | `string` | no |  | A cursor for fetching people after a previous page. |
+| `--before` | `string` | no |  | A cursor for fetching people before a later page. |
+| `--order` | `string` | no |  | Column to sort by. Defaults to last_seen_at. |
+| `--direction` | `string` | no |  | Sort direction. Defaults to desc. |

package/skills/whop-permissions/SKILL.md

@@ -9,10 +9,13 @@ A Permission is one action, such as `stats:read`, paired with whether your crede
 
 Use the Permissions API to check an account, product, experience, or app, narrowing to the actions you care about. It reports only your own access — to manage who else can reach an account, use the Team Members API.
 
-## Commands
+# whop permissions check
 
-| Command | Description |
-|---------|-------------|
-| `whop permissions check` | Check Permissions |
+Check Permissions
 
-Run `whop permissions <command> --help` for options, or `whop permissions <command> --schema` for full argument details.
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--resource_id` | `string` | yes |  | Tag of the resource to check against: an account (`biz_`), product (`prod_`), experience (`exp_`), or app (`app_`). A resource the credential cannot see is reported as granted nothing rather than as an error. |
+| `--actions` | `string` | no |  | Comma-separated permission actions to check, for example `stats:read,payment:basic:read`. Every action is returned when omitted. |