@whop/cli 0.14.1 → 0.14.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/index.js +22283 -7154
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/skills/whop-accounts/SKILL.md +195 -15
- package/skills/whop-ad-campaigns/SKILL.md +193 -15
- package/skills/whop-ad-groups/SKILL.md +258 -16
- package/skills/whop-ads/SKILL.md +190 -14
- package/skills/whop-api-keys/SKILL.md +113 -13
- package/skills/whop-app-builds/SKILL.md +68 -8
- package/skills/whop-apps/SKILL.md +135 -12
- package/skills/whop-audiences/SKILL.md +92 -8
- package/skills/whop-bounties/SKILL.md +104 -9
- package/skills/whop-bounty-submissions/SKILL.md +82 -9
- package/skills/whop-cards/SKILL.md +122 -12
- package/skills/whop-checkout-configurations/SKILL.md +64 -8
- package/skills/whop-deposits/SKILL.md +13 -5
- package/skills/whop-disputes/SKILL.md +86 -9
- package/skills/whop-events/SKILL.md +90 -8
- package/skills/whop-exports/SKILL.md +331 -7
- package/skills/whop-ledgers/SKILL.md +38 -6
- package/skills/whop-media/SKILL.md +28 -7
- package/skills/whop-members/SKILL.md +51 -6
- package/skills/whop-memberships/SKILL.md +137 -13
- package/skills/whop-notifications/SKILL.md +91 -12
- package/skills/whop-partners/SKILL.md +102 -12
- package/skills/whop-payments/SKILL.md +40 -0
- package/skills/whop-payouts/SKILL.md +130 -9
- package/skills/whop-people/SKILL.md +50 -6
- package/skills/whop-permissions/SKILL.md +8 -5
- package/skills/whop-plans/SKILL.md +152 -12
- package/skills/whop-products/SKILL.md +141 -13
- package/skills/whop-resolution-center-cases/SKILL.md +222 -17
- package/skills/whop-setup-intents/SKILL.md +20 -0
- package/skills/whop-shipments/SKILL.md +66 -8
- package/skills/whop-social-accounts/SKILL.md +112 -11
- package/skills/whop-stats/SKILL.md +50 -6
- package/skills/whop-swaps/SKILL.md +63 -8
- package/skills/whop-team-members/SKILL.md +80 -9
- package/skills/whop-transfers/SKILL.md +67 -8
- package/skills/whop-users/SKILL.md +295 -18
- package/skills/whop-verifications/SKILL.md +51 -9
|
@@ -9,15 +9,155 @@ A Plan defines how customers buy a product. It controls pricing, billing cadence
|
|
|
9
9
|
|
|
10
10
|
Use the Plans API to create plans for products, list existing plans, retrieve or update plan configuration, calculate tax for checkout, and delete plans that should no longer be offered.
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
|
19
|
-
|
|
20
|
-
| `
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
12
|
+
# whop plans calculate_tax
|
|
13
|
+
|
|
14
|
+
Calculate Tax
|
|
15
|
+
|
|
16
|
+
## Arguments
|
|
17
|
+
|
|
18
|
+
| Name | Type | Required | Description |
|
|
19
|
+
|------|------|----------|-------------|
|
|
20
|
+
| `id` | `string` | yes | Plan ID, prefixed `plan_`. |
|
|
21
|
+
|
|
22
|
+
## Options
|
|
23
|
+
|
|
24
|
+
| Flag | Type | Required | Default | Description |
|
|
25
|
+
|------|------|----------|---------|-------------|
|
|
26
|
+
| `--address` | `unknown` | no | | Buyer billing address used for tax calculation. Provide either `address.country` or `ip_address`; include state and postal code when available for more accurate results. |
|
|
27
|
+
| `--ip_address` | `string` | no | | Buyer IP address used to infer location when no billing address is provided. |
|
|
28
|
+
| `--tax_ids` | `unknown` | no | | Optional buyer tax ID for B2B exemptions. At most one entry is supported. |
|
|
29
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
30
|
+
|
|
31
|
+
> Confirm with the user before executing this destructive command.
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
# whop plans create
|
|
36
|
+
|
|
37
|
+
Create Plan
|
|
38
|
+
|
|
39
|
+
## Options
|
|
40
|
+
|
|
41
|
+
| Flag | Type | Required | Default | Description |
|
|
42
|
+
|------|------|----------|---------|-------------|
|
|
43
|
+
| `--account_id` | `string` | no | | The unique identifier of the account to create this plan for. Defaults to the caller's account. |
|
|
44
|
+
| `--adaptive_pricing_enabled` | `boolean` | no | | Whether this plan accepts local currency payments via adaptive pricing. |
|
|
45
|
+
| `--billing_period` | `number` | no | | Recurring billing interval in days, such as 30 for monthly or 365 for annual. |
|
|
46
|
+
| `--checkout_styling` | `unknown` | no | | Checkout styling overrides for this plan. |
|
|
47
|
+
| `--currency` | `string` | no | | The three-letter ISO currency code for the plan's pricing. Defaults to USD. |
|
|
48
|
+
| `--custom_fields` | `unknown` | no | | An array of custom field definitions to collect from customers at checkout. Omitting this field clears existing custom fields. |
|
|
49
|
+
| `--description` | `unknown` | no | | A text description of the plan displayed to customers on the product page. |
|
|
50
|
+
| `--expiration_days` | `number` | no | | Access duration in days before the membership expires. |
|
|
51
|
+
| `--image` | `unknown` | no | | An image displayed on the product page to represent this plan. |
|
|
52
|
+
| `--initial_price` | `number` | no | | Initial amount charged in the plan's currency, e.g. 10.43 for $10.43. |
|
|
53
|
+
| `--internal_notes` | `unknown` | no | | Private notes visible only to the account owner. Not shown to customers. |
|
|
54
|
+
| `--metadata` | `unknown` | no | | Custom key-value pairs to store on the plan. Included in webhook payloads for payment and membership events. Max 50 keys, 100 chars per key, 500 chars per string value. |
|
|
55
|
+
| `--override_tax_type` | `string` | no | | Override the default tax classification for this specific plan. |
|
|
56
|
+
| `--payment_method_configuration` | `unknown` | no | | Explicit payment method configuration for the plan. When not provided, the account's defaults apply. |
|
|
57
|
+
| `--plan_type` | `string` | no | | Plan billing type, such as `one_time` or `renewal`. |
|
|
58
|
+
| `--product_id` | `string` | no | | The unique identifier of the product to attach this plan to. |
|
|
59
|
+
| `--release_method` | `string` | no | | Sales method for this plan. |
|
|
60
|
+
| `--renewal_price` | `number` | no | | The amount charged each billing period for recurring plans, in the plan's currency. |
|
|
61
|
+
| `--split_pay_required_payments` | `number` | no | | Installment payments required before the subscription pauses. |
|
|
62
|
+
| `--stock` | `number` | no | | The maximum number of units available for purchase. Ignored when unlimited_stock is true. |
|
|
63
|
+
| `--three_ds_level` | `string` | no | | 3D Secure behavior for this plan. Send `null` to inherit the account default. |
|
|
64
|
+
| `--title` | `unknown` | no | | The display name of the plan shown to customers on the product page. |
|
|
65
|
+
| `--trial_period_days` | `number` | no | | Free trial duration before the first recurring charge. |
|
|
66
|
+
| `--unlimited_stock` | `boolean` | no | | Whether the plan has unlimited stock. When true, the stock field is ignored. |
|
|
67
|
+
| `--visibility` | `string` | no | | Whether the plan is visible to customers or hidden from public view. |
|
|
68
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
69
|
+
|
|
70
|
+
> Confirm with the user before executing this destructive command.
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
# whop plans delete
|
|
75
|
+
|
|
76
|
+
Delete Plan
|
|
77
|
+
|
|
78
|
+
## Arguments
|
|
79
|
+
|
|
80
|
+
| Name | Type | Required | Description |
|
|
81
|
+
|------|------|----------|-------------|
|
|
82
|
+
| `id` | `string` | yes | Plan ID, prefixed `plan_`. |
|
|
83
|
+
|
|
84
|
+
> Confirm with the user before executing this destructive command.
|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
# whop plans get
|
|
89
|
+
|
|
90
|
+
Retrieve Plan
|
|
91
|
+
|
|
92
|
+
## Arguments
|
|
93
|
+
|
|
94
|
+
| Name | Type | Required | Description |
|
|
95
|
+
|------|------|----------|-------------|
|
|
96
|
+
| `id` | `string` | yes | Plan ID, prefixed `plan_`. |
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
# whop plans list
|
|
101
|
+
|
|
102
|
+
List Plans
|
|
103
|
+
|
|
104
|
+
## Options
|
|
105
|
+
|
|
106
|
+
| Flag | Type | Required | Default | Description |
|
|
107
|
+
|------|------|----------|---------|-------------|
|
|
108
|
+
| `--account_id` | `string` | no | | The unique identifier of the account to list plans for. |
|
|
109
|
+
| `--direction` | `string` | no | | The sort direction for results. Defaults to descending. |
|
|
110
|
+
| `--order` | `string` | no | | The field to sort results by. Defaults to created_at. |
|
|
111
|
+
| `--release_methods` | `array` | no | | Filter to only plans matching these release methods. |
|
|
112
|
+
| `--visibilities` | `array` | no | | Filter to only plans matching these visibility states. |
|
|
113
|
+
| `--plan_types` | `array` | no | | Filter to only plans matching these billing types. |
|
|
114
|
+
| `--product_ids` | `array` | no | | Filter to only plans belonging to these product identifiers. |
|
|
115
|
+
| `--created_before` | `string` | no | | Only return plans created before this timestamp. |
|
|
116
|
+
| `--created_after` | `string` | no | | Only return plans created after this timestamp. |
|
|
117
|
+
| `--first` | `number` | no | | The number of plans to return (default and max 100). |
|
|
118
|
+
| `--after` | `string` | no | | A cursor; returns plans after this position. |
|
|
119
|
+
| `--last` | `number` | no | | The number of plans to return from the end of the range. |
|
|
120
|
+
| `--before` | `string` | no | | A cursor; returns plans before this position. |
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
# whop plans update
|
|
125
|
+
|
|
126
|
+
Update Plan
|
|
127
|
+
|
|
128
|
+
## Arguments
|
|
129
|
+
|
|
130
|
+
| Name | Type | Required | Description |
|
|
131
|
+
|------|------|----------|-------------|
|
|
132
|
+
| `id` | `string` | yes | Plan ID, prefixed `plan_`. |
|
|
133
|
+
|
|
134
|
+
## Options
|
|
135
|
+
|
|
136
|
+
| Flag | Type | Required | Default | Description |
|
|
137
|
+
|------|------|----------|---------|-------------|
|
|
138
|
+
| `--adaptive_pricing_enabled` | `boolean` | no | | Whether this plan accepts local currency payments via adaptive pricing. |
|
|
139
|
+
| `--billing_period` | `number` | no | | Recurring billing interval in days, such as 30 for monthly or 365 for annual. |
|
|
140
|
+
| `--checkout_styling` | `unknown` | no | | Checkout styling overrides for this plan. |
|
|
141
|
+
| `--currency` | `string` | no | | The three-letter ISO currency code for the plan's pricing. Defaults to USD. |
|
|
142
|
+
| `--custom_fields` | `unknown` | no | | An array of custom field definitions to collect from customers at checkout. Omitting this field clears existing custom fields. |
|
|
143
|
+
| `--description` | `unknown` | no | | A text description of the plan displayed to customers on the product page. |
|
|
144
|
+
| `--expiration_days` | `number` | no | | Access duration in days before the membership expires. |
|
|
145
|
+
| `--image` | `unknown` | no | | An image displayed on the product page to represent this plan. |
|
|
146
|
+
| `--initial_price` | `number` | no | | Initial amount charged in the plan's currency, e.g. 10.43 for $10.43. |
|
|
147
|
+
| `--internal_notes` | `unknown` | no | | Private notes visible only to the account owner. Not shown to customers. |
|
|
148
|
+
| `--metadata` | `unknown` | no | | Custom key-value pairs to store on the plan. Included in webhook payloads for payment and membership events. Max 50 keys, 100 chars per key, 500 chars per string value. |
|
|
149
|
+
| `--offer_cancel_discount` | `boolean` | no | | Whether to offer a retention discount when a customer attempts to cancel. |
|
|
150
|
+
| `--override_tax_type` | `string` | no | | Override the default tax classification for this specific plan. |
|
|
151
|
+
| `--payment_method_configuration` | `unknown` | no | | Explicit payment method configuration for the plan. When not provided, the account's defaults apply. |
|
|
152
|
+
| `--release_method` | `string` | no | | Sales method for this plan. |
|
|
153
|
+
| `--renewal_price` | `number` | no | | The amount charged each billing period for recurring plans, in the plan's currency. |
|
|
154
|
+
| `--stock` | `number` | no | | The maximum number of units available for purchase. Ignored when unlimited_stock is true. |
|
|
155
|
+
| `--strike_through_initial_price` | `number` | no | | A comparison price displayed with a strikethrough for the initial price. |
|
|
156
|
+
| `--strike_through_renewal_price` | `number` | no | | A comparison price displayed with a strikethrough for the renewal price. |
|
|
157
|
+
| `--three_ds_level` | `string` | no | | 3D Secure behavior for this plan. Send `null` to inherit the account default. |
|
|
158
|
+
| `--title` | `unknown` | no | | The display name of the plan shown to customers on the product page. |
|
|
159
|
+
| `--trial_period_days` | `number` | no | | Free trial duration before the first recurring charge. |
|
|
160
|
+
| `--unlimited_stock` | `boolean` | no | | Whether the plan has unlimited stock. When true, the stock field is ignored. |
|
|
161
|
+
| `--visibility` | `string` | no | | Whether the plan is visible to customers or hidden from public view. |
|
|
162
|
+
|
|
163
|
+
> Confirm with the user before executing this destructive command.
|
|
@@ -9,16 +9,144 @@ A Product is a digital good or service sold on Whop. Products may contain plans
|
|
|
9
9
|
|
|
10
10
|
Use the Products API to create products, list products visible to your credentials, retrieve product details, update product metadata or merchandising fields, and delete products that should no longer be sold.
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
|
19
|
-
|
|
20
|
-
| `
|
|
21
|
-
| `
|
|
22
|
-
| `
|
|
23
|
-
|
|
24
|
-
|
|
12
|
+
# whop products create
|
|
13
|
+
|
|
14
|
+
Create Product
|
|
15
|
+
|
|
16
|
+
## Options
|
|
17
|
+
|
|
18
|
+
| Flag | Type | Required | Default | Description |
|
|
19
|
+
|------|------|----------|---------|-------------|
|
|
20
|
+
| `--account_id` | `string` | no | | The unique identifier of the account to create this product for. |
|
|
21
|
+
| `--collect_shipping_address` | `boolean` | no | | Whether to collect a shipping address at checkout. |
|
|
22
|
+
| `--custom_cta` | `unknown` | no | | The call-to-action button label. |
|
|
23
|
+
| `--custom_cta_url` | `unknown` | no | | A URL the call-to-action button links to. |
|
|
24
|
+
| `--custom_statement_descriptor` | `unknown` | no | | Custom bank statement descriptor. Must start with WHOP*. |
|
|
25
|
+
| `--description` | `unknown` | no | | A written description displayed on the product page. |
|
|
26
|
+
| `--global_affiliate_percentage` | `number` | no | | The commission rate affiliates earn. |
|
|
27
|
+
| `--global_affiliate_status` | `string` | no | | The enrollment status in the global affiliate program. |
|
|
28
|
+
| `--headline` | `unknown` | no | | A short marketing headline for the product page. |
|
|
29
|
+
| `--member_affiliate_percentage` | `number` | no | | The commission rate members earn. |
|
|
30
|
+
| `--member_affiliate_status` | `string` | no | | The enrollment status in the member affiliate program. |
|
|
31
|
+
| `--metadata` | `unknown` | no | | Custom key-value pairs to store on the product. |
|
|
32
|
+
| `--product_tax_code_id` | `unknown` | no | | The unique identifier of the tax classification code. See the available [product categories](https://docs.numeral.com/essentials/product-categories). |
|
|
33
|
+
| `--redirect_purchase_url` | `unknown` | no | | A URL to redirect the customer to after purchase. |
|
|
34
|
+
| `--route` | `unknown` | no | | The URL slug for the product's public link. |
|
|
35
|
+
| `--send_welcome_message` | `boolean` | no | | Whether to send an automated welcome message via support chat when a user joins this product. Defaults to true. |
|
|
36
|
+
| `--title` | `string` | yes | | The display name of the product. Maximum 80 characters. |
|
|
37
|
+
| `--visibility` | `string` | no | | Whether the product is visible to customers. |
|
|
38
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
39
|
+
|
|
40
|
+
> Confirm with the user before executing this destructive command.
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
# whop products delete
|
|
45
|
+
|
|
46
|
+
Delete Product
|
|
47
|
+
|
|
48
|
+
## Arguments
|
|
49
|
+
|
|
50
|
+
| Name | Type | Required | Description |
|
|
51
|
+
|------|------|----------|-------------|
|
|
52
|
+
| `id` | `string` | yes | The unique identifier of the product. |
|
|
53
|
+
|
|
54
|
+
> Confirm with the user before executing this destructive command.
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
# whop products get
|
|
59
|
+
|
|
60
|
+
Retrieve Product
|
|
61
|
+
|
|
62
|
+
## Arguments
|
|
63
|
+
|
|
64
|
+
| Name | Type | Required | Description |
|
|
65
|
+
|------|------|----------|-------------|
|
|
66
|
+
| `id` | `string` | yes | The unique identifier of the product. |
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
# whop products list
|
|
71
|
+
|
|
72
|
+
List Products
|
|
73
|
+
|
|
74
|
+
## Options
|
|
75
|
+
|
|
76
|
+
| Flag | Type | Required | Default | Description |
|
|
77
|
+
|------|------|----------|---------|-------------|
|
|
78
|
+
| `--account_id` | `string` | no | | The unique identifier of the account to list products for. |
|
|
79
|
+
| `--visibilities` | `array` | no | | Filter to only products matching these visibility states. |
|
|
80
|
+
| `--access_pass_types` | `array` | no | | Filter to only products matching these types. |
|
|
81
|
+
| `--direction` | `string` | no | | The sort direction for results. Defaults to descending. |
|
|
82
|
+
| `--order` | `string` | no | | The field to sort results by. Defaults to created_at. |
|
|
83
|
+
| `--first` | `number` | no | | The number of products to return (default and max 100). |
|
|
84
|
+
| `--after` | `string` | no | | A cursor; returns products after this position. |
|
|
85
|
+
| `--last` | `number` | no | | The number of products to return from the end of the range. |
|
|
86
|
+
| `--before` | `string` | no | | A cursor; returns products before this position. |
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
# whop products publish
|
|
91
|
+
|
|
92
|
+
Publish Product
|
|
93
|
+
|
|
94
|
+
## Arguments
|
|
95
|
+
|
|
96
|
+
| Name | Type | Required | Description |
|
|
97
|
+
|------|------|----------|-------------|
|
|
98
|
+
| `id` | `string` | yes | The unique identifier of the product, prefixed `prod_`. |
|
|
99
|
+
|
|
100
|
+
## Options
|
|
101
|
+
|
|
102
|
+
| Flag | Type | Required | Default | Description |
|
|
103
|
+
|------|------|----------|---------|-------------|
|
|
104
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
105
|
+
|
|
106
|
+
> Confirm with the user before executing this destructive command.
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
# whop products unpublish
|
|
111
|
+
|
|
112
|
+
Unpublish Product
|
|
113
|
+
|
|
114
|
+
## Arguments
|
|
115
|
+
|
|
116
|
+
| Name | Type | Required | Description |
|
|
117
|
+
|------|------|----------|-------------|
|
|
118
|
+
| `id` | `string` | yes | The unique identifier of the product, prefixed `prod_`. |
|
|
119
|
+
|
|
120
|
+
## Options
|
|
121
|
+
|
|
122
|
+
| Flag | Type | Required | Default | Description |
|
|
123
|
+
|------|------|----------|---------|-------------|
|
|
124
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
125
|
+
|
|
126
|
+
> Confirm with the user before executing this destructive command.
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
# whop products update
|
|
131
|
+
|
|
132
|
+
Update Product
|
|
133
|
+
|
|
134
|
+
## Arguments
|
|
135
|
+
|
|
136
|
+
| Name | Type | Required | Description |
|
|
137
|
+
|------|------|----------|-------------|
|
|
138
|
+
| `id` | `string` | yes | The unique identifier of the product. |
|
|
139
|
+
|
|
140
|
+
## Options
|
|
141
|
+
|
|
142
|
+
| Flag | Type | Required | Default | Description |
|
|
143
|
+
|------|------|----------|---------|-------------|
|
|
144
|
+
| `--description` | `unknown` | no | | A written description displayed on the product page. |
|
|
145
|
+
| `--headline` | `unknown` | no | | A short marketing headline for the product page. |
|
|
146
|
+
| `--metadata` | `unknown` | no | | Custom key-value pairs to store on the product. |
|
|
147
|
+
| `--product_tax_code_id` | `unknown` | no | | The unique identifier of the tax classification code. See the available [product categories](https://docs.numeral.com/essentials/product-categories). |
|
|
148
|
+
| `--send_welcome_message` | `boolean` | no | | Whether to send an automated welcome message via support chat when a user joins this product. |
|
|
149
|
+
| `--title` | `string` | no | | The display name of the product. |
|
|
150
|
+
| `--visibility` | `string` | no | | Whether the product is visible to customers. |
|
|
151
|
+
|
|
152
|
+
> Confirm with the user before executing this destructive command.
|
|
@@ -9,20 +9,225 @@ A Resolution Center Case is opened by a buyer when something is wrong with a pur
|
|
|
9
9
|
|
|
10
10
|
Use the Resolution Center Cases API from either side: as the buyer, open a case, reply, appeal a decision, or withdraw it; as the merchant, accept it (refunding the payment), deny it, or ask the buyer for more information. Both sides read the same case, page its timeline, and summarize the cases they can see.
|
|
11
11
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
|
19
|
-
|
|
20
|
-
| `
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
|
25
|
-
|
|
26
|
-
| `
|
|
27
|
-
|
|
28
|
-
|
|
12
|
+
# whop resolution-center-cases accept
|
|
13
|
+
|
|
14
|
+
Accept a Case
|
|
15
|
+
|
|
16
|
+
## Arguments
|
|
17
|
+
|
|
18
|
+
| Name | Type | Required | Description |
|
|
19
|
+
|------|------|----------|-------------|
|
|
20
|
+
| `id` | `string` | yes | The resolution center case ID (`reso_` tag). |
|
|
21
|
+
|
|
22
|
+
## Options
|
|
23
|
+
|
|
24
|
+
| Flag | Type | Required | Default | Description |
|
|
25
|
+
|------|------|----------|---------|-------------|
|
|
26
|
+
| `--attachments` | `array` | no | | Up to 3 evidence files, by existing file `id` or `direct_upload_id`. |
|
|
27
|
+
| `--message` | `string` | no | | An optional note to the customer, recorded on the case timeline. |
|
|
28
|
+
| `--terminate_membership` | `boolean` | no | | Whether to also terminate the customer's membership. |
|
|
29
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
30
|
+
|
|
31
|
+
> Confirm with the user before executing this destructive command.
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
# whop resolution-center-cases appeal
|
|
36
|
+
|
|
37
|
+
Appeal a Case
|
|
38
|
+
|
|
39
|
+
## Arguments
|
|
40
|
+
|
|
41
|
+
| Name | Type | Required | Description |
|
|
42
|
+
|------|------|----------|-------------|
|
|
43
|
+
| `id` | `string` | yes | The resolution center case ID (`reso_` tag). |
|
|
44
|
+
|
|
45
|
+
## Options
|
|
46
|
+
|
|
47
|
+
| Flag | Type | Required | Default | Description |
|
|
48
|
+
|------|------|----------|---------|-------------|
|
|
49
|
+
| `--attachments` | `array` | no | | Up to 3 evidence files, by existing file `id` or `direct_upload_id`. |
|
|
50
|
+
| `--message` | `string` | yes | | Why you are appealing the decision. |
|
|
51
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
52
|
+
|
|
53
|
+
> Confirm with the user before executing this destructive command.
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
# whop resolution-center-cases create
|
|
58
|
+
|
|
59
|
+
Open a Case as the Customer
|
|
60
|
+
|
|
61
|
+
## Options
|
|
62
|
+
|
|
63
|
+
| Flag | Type | Required | Default | Description |
|
|
64
|
+
|------|------|----------|---------|-------------|
|
|
65
|
+
| `--attachments` | `array` | no | | |
|
|
66
|
+
| `--message` | `string` | yes | | The customer's explanation. |
|
|
67
|
+
| `--reason` | `string` | yes | | What went wrong. Uses the same vocabulary as `/disputes`. |
|
|
68
|
+
| `--receipt_id` | `string` | yes | | The payment to open the case against (`pay_` tag). |
|
|
69
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
70
|
+
|
|
71
|
+
> Confirm with the user before executing this destructive command.
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
# whop resolution-center-cases deny
|
|
76
|
+
|
|
77
|
+
Deny a Case
|
|
78
|
+
|
|
79
|
+
## Arguments
|
|
80
|
+
|
|
81
|
+
| Name | Type | Required | Description |
|
|
82
|
+
|------|------|----------|-------------|
|
|
83
|
+
| `id` | `string` | yes | The resolution center case ID (`reso_` tag). |
|
|
84
|
+
|
|
85
|
+
## Options
|
|
86
|
+
|
|
87
|
+
| Flag | Type | Required | Default | Description |
|
|
88
|
+
|------|------|----------|---------|-------------|
|
|
89
|
+
| `--attachments` | `array` | no | | Up to 3 evidence files, by existing file `id` or `direct_upload_id`. |
|
|
90
|
+
| `--message` | `string` | yes | | Why the claim is being denied. Shown to the customer. |
|
|
91
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
92
|
+
|
|
93
|
+
> Confirm with the user before executing this destructive command.
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
# whop resolution-center-cases events
|
|
98
|
+
|
|
99
|
+
List Resolution Center Case Events
|
|
100
|
+
|
|
101
|
+
## Arguments
|
|
102
|
+
|
|
103
|
+
| Name | Type | Required | Description |
|
|
104
|
+
|------|------|----------|-------------|
|
|
105
|
+
| `id` | `string` | yes | The resolution center case ID (`reso_` tag). |
|
|
106
|
+
|
|
107
|
+
## Options
|
|
108
|
+
|
|
109
|
+
| Flag | Type | Required | Default | Description |
|
|
110
|
+
|------|------|----------|---------|-------------|
|
|
111
|
+
| `--first` | `number` | no | | The number of events to return (default 20, max 100). |
|
|
112
|
+
| `--after` | `string` | no | | A cursor; returns events after this position. |
|
|
113
|
+
| `--last` | `number` | no | | The number of events to return from the end of the range. |
|
|
114
|
+
| `--before` | `string` | no | | A cursor; returns events before this position. |
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
# whop resolution-center-cases get
|
|
119
|
+
|
|
120
|
+
Retrieve Resolution Center Case
|
|
121
|
+
|
|
122
|
+
## Arguments
|
|
123
|
+
|
|
124
|
+
| Name | Type | Required | Description |
|
|
125
|
+
|------|------|----------|-------------|
|
|
126
|
+
| `id` | `string` | yes | The resolution center case ID (`reso_` tag). |
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
# whop resolution-center-cases list
|
|
131
|
+
|
|
132
|
+
List Resolution Center Cases
|
|
133
|
+
|
|
134
|
+
## Options
|
|
135
|
+
|
|
136
|
+
| Flag | Type | Required | Default | Description |
|
|
137
|
+
|------|------|----------|---------|-------------|
|
|
138
|
+
| `--account_id` | `string` | no | | Only cases filed against this account (`biz_` tag). With read access to the account this lists its whole queue; without, only the cases you opened against it. |
|
|
139
|
+
| `--user_id` | `string` | no | | Only cases opened by this customer — a `user_` tag, or `me` for the calling user. It narrows what you can already read, so `me` lists the cases you opened without the ones on accounts you are a team member of. |
|
|
140
|
+
| `--first` | `number` | no | | The number of cases to return (default 20, max 100). |
|
|
141
|
+
| `--after` | `string` | no | | A cursor; returns cases after this position. |
|
|
142
|
+
| `--last` | `number` | no | | The number of cases to return from the end of the range. |
|
|
143
|
+
| `--before` | `string` | no | | A cursor; returns cases before this position. |
|
|
144
|
+
| `--order` | `string` | no | | The field to sort cases by. |
|
|
145
|
+
| `--direction` | `string` | no | | Sort direction. |
|
|
146
|
+
| `--status` | `array` | no | | Only cases in these statuses. Repeat the parameter to pass several — one paginated list covers all of them. |
|
|
147
|
+
| `--reason` | `array` | no | | Only cases opened for these reasons. Repeat the parameter to pass several. |
|
|
148
|
+
| `--outcome` | `array` | no | | Only closed cases that ended these ways. Repeat the parameter to pass several. |
|
|
149
|
+
| `--created_before` | `string` | no | | Only cases created before this ISO 8601 timestamp. |
|
|
150
|
+
| `--created_after` | `string` | no | | Only cases created after this ISO 8601 timestamp. |
|
|
151
|
+
|
|
152
|
+
---
|
|
153
|
+
|
|
154
|
+
# whop resolution-center-cases reply
|
|
155
|
+
|
|
156
|
+
Reply to a Case
|
|
157
|
+
|
|
158
|
+
## Arguments
|
|
159
|
+
|
|
160
|
+
| Name | Type | Required | Description |
|
|
161
|
+
|------|------|----------|-------------|
|
|
162
|
+
| `id` | `string` | yes | The resolution center case ID (`reso_` tag). |
|
|
163
|
+
|
|
164
|
+
## Options
|
|
165
|
+
|
|
166
|
+
| Flag | Type | Required | Default | Description |
|
|
167
|
+
|------|------|----------|---------|-------------|
|
|
168
|
+
| `--attachments` | `array` | no | | Up to 3 evidence files, by existing file `id` or `direct_upload_id`. |
|
|
169
|
+
| `--message` | `string` | yes | | The reply to add to the case. |
|
|
170
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
171
|
+
|
|
172
|
+
> Confirm with the user before executing this destructive command.
|
|
173
|
+
|
|
174
|
+
---
|
|
175
|
+
|
|
176
|
+
# whop resolution-center-cases request_info
|
|
177
|
+
|
|
178
|
+
Request Information from the Customer
|
|
179
|
+
|
|
180
|
+
## Arguments
|
|
181
|
+
|
|
182
|
+
| Name | Type | Required | Description |
|
|
183
|
+
|------|------|----------|-------------|
|
|
184
|
+
| `id` | `string` | yes | The resolution center case ID (`reso_` tag). |
|
|
185
|
+
|
|
186
|
+
## Options
|
|
187
|
+
|
|
188
|
+
| Flag | Type | Required | Default | Description |
|
|
189
|
+
|------|------|----------|---------|-------------|
|
|
190
|
+
| `--attachments` | `array` | no | | Up to 3 evidence files, by existing file `id` or `direct_upload_id`. |
|
|
191
|
+
| `--message` | `string` | no | | What you need from the customer. |
|
|
192
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
193
|
+
|
|
194
|
+
> Confirm with the user before executing this destructive command.
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
# whop resolution-center-cases summary
|
|
199
|
+
|
|
200
|
+
Retrieve Resolution Center Case Summary
|
|
201
|
+
|
|
202
|
+
## Options
|
|
203
|
+
|
|
204
|
+
| Flag | Type | Required | Default | Description |
|
|
205
|
+
|------|------|----------|---------|-------------|
|
|
206
|
+
| `--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. |
|
|
207
|
+
| `--account_id` | `string` | no | | The account to summarize cases for (`biz_` tag). |
|
|
208
|
+
| `--user_id` | `string` | no | | Only cases opened by this customer — a `user_` tag, or `me` for the calling user. |
|
|
209
|
+
| `--status` | `array` | no | | Only cases in these statuses. |
|
|
210
|
+
| `--reason` | `array` | no | | Only cases opened for these reasons. |
|
|
211
|
+
| `--outcome` | `array` | no | | Only closed cases that ended these ways. |
|
|
212
|
+
| `--created_before` | `string` | no | | Only count cases created before this ISO 8601 timestamp. |
|
|
213
|
+
| `--created_after` | `string` | no | | Only count cases created after this ISO 8601 timestamp. |
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
# whop resolution-center-cases withdraw
|
|
218
|
+
|
|
219
|
+
Withdraw a Case
|
|
220
|
+
|
|
221
|
+
## Arguments
|
|
222
|
+
|
|
223
|
+
| Name | Type | Required | Description |
|
|
224
|
+
|------|------|----------|-------------|
|
|
225
|
+
| `id` | `string` | yes | The resolution center case ID (`reso_` tag). |
|
|
226
|
+
|
|
227
|
+
## Options
|
|
228
|
+
|
|
229
|
+
| Flag | Type | Required | Default | Description |
|
|
230
|
+
|------|------|----------|---------|-------------|
|
|
231
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
232
|
+
|
|
233
|
+
> Confirm with the user before executing this destructive command.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-setup-intents
|
|
3
|
+
description: Saving a buyer's payment method without charging it. Run `whop setup-intents --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop setup-intents
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Setup Intent saves a buyer's payment method for later without taking money now. It runs the same collection flow a payment does, so the buyer may still owe a step — 3D Secure on a card, a hosted enrollment, or linking a bank account.
|
|
9
|
+
|
|
10
|
+
Poll [Retrieve status](https://docs.whop.com/api-reference/beta/setup-intents/retrieve-status) for how far the setup has got and what is outstanding. Once it reaches `succeeded` the method is on file and can be charged.
|
|
11
|
+
|
|
12
|
+
# whop setup-intents status
|
|
13
|
+
|
|
14
|
+
Retrieve setup status
|
|
15
|
+
|
|
16
|
+
## Arguments
|
|
17
|
+
|
|
18
|
+
| Name | Type | Required | Description |
|
|
19
|
+
|------|------|----------|-------------|
|
|
20
|
+
| `setup_intent_id` | `string` | yes | The unique identifier of the setup intent. |
|
|
@@ -9,13 +9,71 @@ A Shipment attaches a carrier tracking number to a payment and follows the packa
|
|
|
9
9
|
|
|
10
10
|
Use the Shipments API to list an account's shipments, retrieve one by its id or the payment it fulfills, attach a tracking number to a payment, and update the tracking number on an existing shipment.
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
# whop shipments create
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|---------|-------------|
|
|
16
|
-
| `whop shipments list` | List Shipments |
|
|
17
|
-
| `whop shipments create` | Create Shipment |
|
|
18
|
-
| `whop shipments get` | Retrieve Shipment |
|
|
19
|
-
| `whop shipments update` | Update Shipment |
|
|
14
|
+
Create Shipment
|
|
20
15
|
|
|
21
|
-
|
|
16
|
+
## Options
|
|
17
|
+
|
|
18
|
+
| Flag | Type | Required | Default | Description |
|
|
19
|
+
|------|------|----------|---------|-------------|
|
|
20
|
+
| `--account_id` | `string` | no | | The unique identifier of the account, prefixed `biz_`. |
|
|
21
|
+
| `--payment_id` | `string` | yes | | The payment to attach the shipment to, prefixed `pay_`. |
|
|
22
|
+
| `--tracking_number` | `string` | yes | | The carrier-assigned tracking number. |
|
|
23
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
24
|
+
|
|
25
|
+
> Confirm with the user before executing this destructive command.
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
# whop shipments get
|
|
30
|
+
|
|
31
|
+
Retrieve Shipment
|
|
32
|
+
|
|
33
|
+
## Arguments
|
|
34
|
+
|
|
35
|
+
| Name | Type | Required | Description |
|
|
36
|
+
|------|------|----------|-------------|
|
|
37
|
+
| `id` | `string` | yes | The shipment id (`ship_`), or the payment id (`pay_`) it fulfills. |
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
# whop shipments list
|
|
42
|
+
|
|
43
|
+
List Shipments
|
|
44
|
+
|
|
45
|
+
## Options
|
|
46
|
+
|
|
47
|
+
| Flag | Type | Required | Default | Description |
|
|
48
|
+
|------|------|----------|---------|-------------|
|
|
49
|
+
| `--account_id` | `string` | no | | The account to list shipments for. Defaults to the acting account. |
|
|
50
|
+
| `--status` | `string` | no | | Filter to shipments with this delivery status. |
|
|
51
|
+
| `--payment_id` | `array` | no | | Only shipments fulfilling these payments, each prefixed `pay_`. Repeat the parameter to pass several, up to 100 per request — one paginated list covers all of them. |
|
|
52
|
+
| `--created_before` | `string` | no | | Return shipments created before this ISO 8601 timestamp. |
|
|
53
|
+
| `--created_after` | `string` | no | | Return shipments created after this ISO 8601 timestamp. |
|
|
54
|
+
| `--order` | `string` | no | | The field to sort by. |
|
|
55
|
+
| `--direction` | `string` | no | | The sort direction. |
|
|
56
|
+
| `--first` | `number` | no | | The number of shipments to return. |
|
|
57
|
+
| `--after` | `string` | no | | A cursor; returns shipments after this position. |
|
|
58
|
+
| `--last` | `number` | no | | The number of shipments to return from the end of the range. |
|
|
59
|
+
| `--before` | `string` | no | | A cursor; returns shipments before this position. |
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
# whop shipments update
|
|
64
|
+
|
|
65
|
+
Update Shipment
|
|
66
|
+
|
|
67
|
+
## Arguments
|
|
68
|
+
|
|
69
|
+
| Name | Type | Required | Description |
|
|
70
|
+
|------|------|----------|-------------|
|
|
71
|
+
| `id` | `string` | yes | The shipment id (`ship_`), or the payment id (`pay_`) it fulfills. |
|
|
72
|
+
|
|
73
|
+
## Options
|
|
74
|
+
|
|
75
|
+
| Flag | Type | Required | Default | Description |
|
|
76
|
+
|------|------|----------|---------|-------------|
|
|
77
|
+
| `--tracking_number` | `string` | yes | | The new carrier-assigned tracking number. |
|
|
78
|
+
|
|
79
|
+
> Confirm with the user before executing this destructive command.
|