@whop/cli 0.16.0 → 0.16.1

package/skills/whop-memberships/SKILL.md

@@ -1,165 +0,0 @@
----
-name: whop-memberships
-description: A customer's purchase of a plan, from checkout through cancellation. Run `whop memberships --help` for usage details.
-requires_bin: whop
-command: whop memberships
----
-
-A Membership is a customer's purchase of a plan: the subscription or one-time grant that gives them access to a product. It tracks billing state (`active`, `trialing`, `past_due`, and so on), the current period, pending cancellations, custom metadata, and the software license key when the product includes licensing.
-
-Use the Memberships API to list an account's memberships or the caller's own, retrieve one by ID or license key, invite a recipient to join through a free plan, 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.
-
-# 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 invite
-
-Invite to a Membership
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--email` | `string` | no |  | Recipient email address. Mutually exclusive with `user_id`. |
-| `--plan_id` | `string` | yes |  | Free plan whose membership the recipient is invited to, prefixed `plan_`. |
-| `--user_id` | `string` | no |  | Recipient user ID, prefixed `user_`. Mutually exclusive with `email`. |
-| `--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 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

@@ -1,104 +0,0 @@
----
-name: whop-notifications
-description: "The user's notification feed: unread badges, mark-read, app sends, and the topic catalog. Run `whop notifications --help` for usage details."
-requires_bin: whop
-command: whop notifications
----
-
-A Notification is a message delivered to a user — a new post, a payment, a mention. Every notification comes from an experience the user belongs to or a team they are on, and users control what they receive with notification preferences.
-
-Every notification belongs to a topic: the category it falls under, such as new sales or account activity. Topics carry a default, so a user only needs a preference row where they diverge from it. `GET /notifications/topics` lists the platform's visible topics, and a topic's `id` is what the notification preference endpoints take as `topic_id` — the catalog is the only place those ids come from, so read it rather than hardcoding. Each topic also carries an `identifier` such as `new-follower`, which is stable across environments and is the value to match on in code.
-
-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.
-
-# 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 |
-|------|------|----------|-------------|
-| `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

@@ -1,113 +0,0 @@
----
-name: whop-partners
-description: The users and businesses you referred to Whop, and what you earn from them. Run `whop partners --help` for usage details.
-requires_bin: whop
-command: whop partners
----
-
-The Partners API covers your Whop partner activity: the users you referred onto Whop, the businesses you referred and the earnings generated from their processing volume, and the partner leaderboard.
-
-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.
-
-# 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-payment-method-domains/SKILL.md

@@ -1,93 +0,0 @@
----
-name: whop-payment-method-domains
-description: Domains verified to show wallet payment methods like Apple Pay at checkout. Run `whop payment-method-domains --help` for usage details.
-requires_bin: whop
-command: whop payment-method-domains
----
-
-A Payment Method Domain registers a hostname with a wallet provider so its payment methods can appear at a checkout served from that domain. The domain proves ownership by hosting the provider's association file — for Apple Pay, at `/.well-known/apple-developer-merchantid-domain-association` — and `status` reports whether verification has completed.
-
-Use the Payment Method Domains API to register domains for your account or its connected accounts, retry verification once the association file is hosted, and remove domains that should no longer serve wallet payments. A domain a platform shares with its connected accounts at checkout is listed on the platform's account, not on each connected account.
-
-# whop payment-method-domains create
-
-Create Payment Method Domain
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--account_id` | `string` | no |  | Account to register the domain for (`biz_` tag). Defaults to the caller's account. |
-| `--hostname` | `string` | yes |  | Hostname to register (e.g. `checkout.shinetime.example`). |
-| `--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 payment-method-domains delete
-
-Delete Payment Method Domain
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The unique identifier of the payment method domain, prefixed `pmd_`. |
-
-> Confirm with the user before executing this destructive command.
-
----
-
-# whop payment-method-domains get
-
-Retrieve Payment Method Domain
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The unique identifier of the payment method domain, prefixed `pmd_`. |
-
----
-
-# whop payment-method-domains list
-
-List Payment Method Domains
-
-## Options
-
-| Flag | Type | Required | Default | Description |
-|------|------|----------|---------|-------------|
-| `--account_id` | `string` | no |  | Only domains registered for this account (`biz_` tag). Defaults to the caller's account plus its connected accounts. |
-| `--hostname` | `string` | no |  | Only the domain with this exact hostname. |
-| `--status` | `string` | no |  | Only domains with this verification status. |
-| `--provider` | `string` | no |  | Only domains registered with this wallet provider. |
-| `--created_before` | `string` | no |  | Only domains created before this ISO 8601 timestamp. |
-| `--created_after` | `string` | no |  | Only domains created after this ISO 8601 timestamp. |
-| `--order` | `string` | no |  | Sort field. |
-| `--direction` | `string` | no |  | Sort direction. |
-| `--first` | `number` | no | `20` | Number of domains to return from the start of the window. |
-| `--after` | `string` | no |  | Cursor to paginate forwards from. |
-| `--last` | `number` | no |  | Number of domains to return from the end of the window. |
-| `--before` | `string` | no |  | Cursor to paginate backwards from. |
-
----
-
-# whop payment-method-domains verify
-
-Verify Payment Method Domain
-
-## Arguments
-
-| Name | Type | Required | Description |
-|------|------|----------|-------------|
-| `id` | `string` | yes | The unique identifier of the payment method domain, prefixed `pmd_`. |
-
-## 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.

package/skills/whop-payments/SKILL.md

@@ -1,40 +0,0 @@
----
-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 (http is allowed for localhost), 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. |