@whop/cli 0.14.0 → 0.14.2

package/skills/whop-ledgers/SKILL.md

@@ -9,11 +9,43 @@ A Ledger Activity row is a single financial event on an account's ledger — a p
 
 Use Ledger Activity to build a statement or transaction feed for an account or user. Reconcile against your own records with `amount` (signed, in the currency's smallest precision units) and `posted_at`, and use `available_at` to know when inflows became withdrawable.
 
-## Commands
+# whop ledgers list
 
-| Command | Description |
-|---------|-------------|
-| `whop ledgers list` | List Financial Activity |
-| `whop ledgers report` | Get Financial Report |
+List Financial Activity
 
-Run `whop ledgers <command> --help` for options, or `whop ledgers <command> --schema` for full argument details.
+## 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. |
+| `--include_owned_accounts` | `boolean` | no |  | When true, aggregates the authenticated user's personal ledger with the businesses they own (owner role with balance read) into one feed. Requires user_id to be the authenticated user; cannot be combined with account_id or the settlement-date filters. Each returned row includes the owning `account`. |
+| `--line_types` | `array` | no |  | Optional ledger line categories to include. Some categories (for example `onchain_deposit`, which covers inbound crypto deposits such as MoonPay onramps) are only returned when explicitly requested here. |
+| `--currency` | `string` | no |  | Optional currency code filter, for example `usd`. |
+| `--posted_after` | `string` | no |  | Only include rows posted after this ISO 8601 timestamp. |
+| `--posted_before` | `string` | no |  | Only include rows posted before this ISO 8601 timestamp. |
+| `--available_after` | `string` | no |  | Only include rows whose funds became withdrawable on or after this `YYYY-MM-DD` settlement date (UTC), distinct from posted_at. Requires currency. |
+| `--available_before` | `string` | no |  | Only include rows whose funds became withdrawable on or before this `YYYY-MM-DD` settlement date (UTC). Set equal to available_after for a single day. Requires currency. |
+| `--limit` | `number` | no | `20` | Maximum number of rows to return. |
+| `--cursor` | `string` | no |  | Cursor returned by the previous page. |
+
+---
+
+# whop ledgers report
+
+Get Financial Report
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | The owning account ID (a biz_ identifier), or `global` for a platform-wide report across all ledger accounts (requires internal admin access). |
+| `--report_type` | `string` | yes |  | The type of financial report to generate. |
+| `--currency` | `string` | no |  | Filter rows to this currency, for example `usd`. Defaults to `usd` unless `in_currency` is provided. |
+| `--in_currency` | `string` | no |  | Aggregate all activity into this display currency via FX conversion. |
+| `--from_date` | `string` | no |  | Start of the report window as an ISO 8601 timestamp (UTC). Required for platform-wide (global) reports. |
+| `--to_date` | `string` | no |  | End of the report window as an ISO 8601 timestamp (UTC). Required for platform-wide (global) reports. |
+| `--group_by` | `string` | no |  | Grouping granularity for report rows. |
+| `--timezone` | `string` | no |  | IANA timezone (for example `America/New_York`) used to bucket report periods and to interpret calendar-day boundaries for balance snapshots. Defaults to UTC. from_date/to_date remain exact instants regardless of this setting. |
+| `--cumulative` | `boolean` | no | `false` | Platform-wide (global) reports only: when true, return cumulative balances as of to_date (all history, no lower bound) instead of activity within the period. |
+| `--scope_account_id` | `string` | no |  | Platform-wide (global) reports only: narrow the report to ledger lines on the ledger account owned by this account ID (a biz_ identifier). Ignored unless account_id is `global`. |

package/skills/whop-media/SKILL.md

@@ -9,15 +9,36 @@ A Media Asset is an AI-generated image or video created from a prompt and billed
 
 Use the Media API to start a generation job and retrieve the asset while it processes or after it is ready.
 
-## Commands
+# whop media generate
 
-| Command | Description |
-|---------|-------------|
-| `whop media generate` | Generate Media Asset |
-| `whop media get` | Retrieve Media Asset |
+Generate Media Asset
 
-Run `whop media <command> --help` for options, or `whop media <command> --schema` for full argument details.
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | Account ID, prefixed `biz_`. Defaults to the account the API key belongs to. |
+| `--duration_seconds` | `unknown` | no |  | Video length in seconds. Video only; defaults to 5. |
+| `--prompt` | `string` | yes |  | What to generate. Up to 2,000 characters. |
+| `--reference_media` | `array` | no |  | Optional reference image file IDs (`file_` prefixed), up to 4. For video, a single reference seeds the opening frame; multiple references guide subject and style instead. |
+| `--resolution` | `string` | no |  | Video resolution. Video only; defaults to `1080p`. `1080p` is not supported by Seedance 2.0 Fast or Mini; `4k` is only supported by Seedance 2.0. |
+| `--type` | `string` | yes |  | The kind of media to generate. |
+| `--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 media get
+
+Retrieve Media Asset
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | Media asset ID, prefixed `media_`. |
 
 ## Steps that finish in the browser
 
-Some commands respond with a URL the user must open in a browser to finish the flow (`authorize_url`, `session_url`, `deposit_url`) — the CLI cannot complete that step itself. When a response contains one of these fields, or the CLI prints "Action required: open this link in the user's browser", open that link in the user's browser for them, tell them what to complete there, then re-run the matching `get`/`list` command to confirm the step finished.
+Some commands respond with a URL the user must open in a browser to finish the flow (`authorize_url`, `session_url`, `deposit_url`, `checkout_url`) — the CLI cannot complete that step itself. When a response contains one of these fields, or the CLI prints "Action required: open this link in the user's browser", open that link in the user's browser for them, tell them what to complete there, then re-run the matching `get`/`list` command to confirm the step finished.

package/skills/whop-members/SKILL.md

@@ -9,11 +9,56 @@ A Member is one buyer's relationship with an account — one record per customer
 
 Use the Members API to list an account's members with filtering by access level, status, join date, and name or username search, and to retrieve a single member. Member rows are created and maintained by the membership lifecycle; to grant or revoke access, work with memberships instead.
 
-## Commands
+# whop members get
 
-| Command | Description |
-|---------|-------------|
-| `whop members list` | List Members |
-| `whop members get` | Retrieve Member |
+Retrieve Member
 
-Run `whop members <command> --help` for options, or `whop members <command> --schema` for full argument details.
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | Member ID (`mber_` tag). |
+
+---
+
+# whop members list
+
+List Members
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | The account to list members for (`biz_` tag). Defaults to the account the credential acts as. |
+| `--access_level` | `string` | no |  | Filter by what the member can reach on the account. |
+| `--status` | `string` | no |  | Filter by whether the member is still part of the account. |
+| `--query` | `string` | no |  | Search members by name or username. An exact email address also matches when the credential holds the member:email:read scope. |
+| `--created_after` | `string` | no |  | Only members who joined after this ISO 8601 timestamp. |
+| `--created_before` | `string` | no |  | Only members who joined before this ISO 8601 timestamp. |
+| `--order` | `string` | no |  | Sort field. |
+| `--direction` | `string` | no |  | Sort direction. |
+| `--first` | `number` | no | `20` | Number of members to return from the start of the window. |
+| `--after` | `string` | no |  | Cursor to paginate forwards from. |
+| `--last` | `number` | no |  | Number of members to return from the end of the window. |
+| `--before` | `string` | no |  | Cursor to paginate backwards from. |
+
+---
+
+# whop members logs
+
+List Member Logs
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | Member ID (`mber_` tag). |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--first` | `number` | no | `20` | Number of log entries to return from the start of the window. |
+| `--after` | `string` | no |  | Cursor to paginate forwards from. |
+| `--last` | `number` | no |  | Number of log entries to return from the end of the window. |
+| `--before` | `string` | no |  | Cursor to paginate backwards from. |

package/skills/whop-memberships/SKILL.md

@@ -9,16 +9,140 @@ A Membership is a customer's purchase of a plan: the subscription or one-time gr
 
 Use the Memberships API to list an account's memberships or the caller's own, retrieve one by ID or license key, and manage the lifecycle: cancel immediately or at period end, reverse a scheduled period-end cancellation, pause and resume payment collection, extend with free days, and update metadata.
 
-## Commands
-
-| Command | Description |
-|---------|-------------|
-| `whop memberships list` | List Memberships |
-| `whop memberships get` | Retrieve Membership |
-| `whop memberships update` | Update Membership |
-| `whop memberships cancel` | Cancel Membership |
-| `whop memberships extend` | Extend Membership |
-| `whop memberships pause` | Pause Membership |
-| `whop memberships resume` | Resume Membership |
-
-Run `whop memberships <command> --help` for options, or `whop memberships <command> --schema` for full argument details.
+# whop memberships cancel
+
+Cancel Membership
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | Membership ID (`mem_` tag). |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--reason` | `string` | no |  | Free-form note recording why the membership was canceled. |
+| `--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 memberships extend
+
+Extend Membership
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | Membership ID (`mem_` tag). |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--days` | `number` | yes |  | Number of free days to add (1-1095). |
+| `--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 memberships get
+
+Retrieve Membership
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | Membership ID (`mem_` tag), or a software license key. |
+
+---
+
+# whop memberships list
+
+List Memberships
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--account_id` | `string` | no |  | Narrow to one account (`biz_` tag). With read access to the account this lists all of its memberships; without, only the caller's own memberships in it. |
+| `--user_id` | `string` | no |  | Narrow to one user's memberships (`user_` tag, or `me` for the caller). A user outside the caller's visible set returns an empty list. |
+| `--status` | `string` | no |  | Filter by billing state. `canceling` matches active memberships set to cancel at period end; `paused` matches memberships with payment collection paused. |
+| `--product_id` | `string` | no |  | Filter to memberships of this product (`prod_` tag). Repeat as product_ids[] for several. |
+| `--plan_id` | `string` | no |  | Filter to memberships of this plan (`plan_` tag). Repeat as plan_ids[] for several. |
+| `--created_after` | `string` | no |  | Only memberships created after this ISO 8601 timestamp. |
+| `--created_before` | `string` | no |  | Only memberships created before this ISO 8601 timestamp. |
+| `--order` | `string` | no |  | Sort field. |
+| `--direction` | `string` | no |  | Sort direction. |
+| `--first` | `number` | no | `20` | Number of memberships to return from the start of the window. |
+| `--after` | `string` | no |  | Cursor to paginate forwards from. |
+| `--last` | `number` | no |  | Number of memberships to return from the end of the window. |
+| `--before` | `string` | no |  | Cursor to paginate backwards from. |
+
+---
+
+# whop memberships pause
+
+Pause Membership
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | Membership ID (`mem_` tag). |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--until` | `string` | no |  | ISO 8601 time to automatically resume payment collection. Must be in the future; only supported for memberships billed by Whop. |
+| `--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 memberships resume
+
+Resume Membership
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | Membership ID (`mem_` 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 memberships update
+
+Update Membership
+
+## Arguments
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `id` | `string` | yes | Membership ID (`mem_` tag), or a software license key. |
+
+## Options
+
+| Flag | Type | Required | Default | Description |
+|------|------|----------|---------|-------------|
+| `--cancel_at_period_end` | `boolean` | no |  | `true` cancels at the end of the current billing period (the customer keeps access until then); `false` reverses a pending cancellation. |
+| `--metadata` | `object` | no |  | Key-value pairs to merge into the membership's metadata. Pass an empty object to clear it. |
+
+> Confirm with the user before executing this destructive command.

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). |