# Reference
## AccessTokens
client.accessTokens.create({ ...params }) -> Whop.AccessToken
-
#### 📝 Description
-
-
Creates a short-lived access token for Whop's web and mobile embedded components. With API key authentication, pass `account_id` or `user_id`; with OAuth, the token is issued for the OAuth user.
#### 🔌 Usage
-
-
```typescript
await client.accessTokens.create();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAccessTokensRequest`
-
**requestOptions:** `AccessTokensClient.RequestOptions`
client.accountLinks.create({ ...params }) -> Whop.AccountLink
-
#### 📝 Description
-
-
Generates a URL that sends a sub-merchant to a hosted Whop page, such as the payouts dashboard or the KYC onboarding flow. Requires an API key.
#### 🔌 Usage
-
-
```typescript
await client.accountLinks.create({
account_id: "biz_xxxxxxxxxxxxxx",
refresh_url: "refresh_url",
return_url: "return_url",
use_case: "account_onboarding"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAccountLinksRequest`
-
**requestOptions:** `AccountLinksClient.RequestOptions`
client.accounts.list({ ...params }) -> core.Page<Whop.Account, Whop.ListAccountsResponse>
-
#### 📝 Description
-
-
Lists accounts visible to the credential. User tokens return the user's business accounts; Account API keys return the requesting account and its connected accounts.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.accounts.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.accounts.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListAccountsRequest`
-
**requestOptions:** `AccountsClient.RequestOptions`
client.accounts.create({ ...params }) -> Whop.Account
-
#### 📝 Description
-
-
Creates an account. User tokens create business accounts; Account API keys create connected accounts. Tax fields (`tax_remitted_by`, `tax_type`, `product_tax_code_id`, `business_address`, `tax_identifiers`) are configured with Update Account, not at creation.
#### 🔌 Usage
-
-
```typescript
await client.accounts.create();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAccountsRequest`
-
**requestOptions:** `AccountsClient.RequestOptions`
client.accounts.me({ ...params }) -> Whop.Account
-
#### 📝 Description
-
-
Retrieves the account associated with the current Account API key.
#### 🔌 Usage
-
-
```typescript
await client.accounts.me();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.MeAccountsRequest`
-
**requestOptions:** `AccountsClient.RequestOptions`
client.accounts.search({ ...params }) -> core.Page<Whop.AccountSearchResult, Whop.SearchAccountsResponse>
-
#### 📝 Description
-
-
Finds accounts by name among the accounts the credential can list. Support searches cover every company and return only the 50 best matches.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.accounts.search({
query: "query"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.accounts.search({
query: "query"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.SearchAccountsRequest`
-
**requestOptions:** `AccountsClient.RequestOptions`
client.accounts.retrieve({ ...params }) -> Whop.Account
-
#### 📝 Description
-
-
Retrieves an account visible to the credential by ID or public route, including its crypto wallet.
#### 🔌 Usage
-
-
```typescript
await client.accounts.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveAccountsRequest`
-
**requestOptions:** `AccountsClient.RequestOptions`
client.accounts.delete({ ...params }) -> Whop.DeleteAccountsResponse
-
#### 📝 Description
-
-
Deletes a connected account directly owned by the authenticated platform account. The account must have no settled, pending, or reserved balance in any currency and no active, trialing, or past-due memberships. The account stops resolving immediately, and its products, plans, and team access are removed in the background; payment history is retained. Deletion cannot be undone through the API. This cannot delete the platform account itself or an account owned by another platform.
#### 🔌 Usage
-
-
```typescript
await client.accounts.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteAccountsRequest`
-
**requestOptions:** `AccountsClient.RequestOptions`
client.accounts.update({ ...params }) -> Whop.Account
-
#### 📝 Description
-
-
Updates an account. User tokens can update business accounts; Account API keys can update connected accounts.
#### 🔌 Usage
-
-
```typescript
await client.accounts.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateAccountsRequest`
-
**requestOptions:** `AccountsClient.RequestOptions`
client.accounts.formCompany({ ...params }) -> Whop.FormCompanyAccountsResponse
-
#### 📝 Description
-
-
Starts an LLC or C-Corp formation for a business account. The application is validated and the response returns a hosted checkout URL; once paid, the filing is submitted. Track progress through the account's [`company_formation`](/api-reference/beta/accounts/retrieve-account) field on Retrieve Account.
#### 🔌 Usage
-
-
```typescript
await client.accounts.formCompany({
id: "id",
business_address: {
city: "Austin",
country: "US",
line1: "4180 Burnet Rd",
line2: "Suite 2",
postal_code: "78756",
state: "TX"
},
business_name: "Shine Time Auto Detailing",
business_phone: "+15125550142",
business_website: "https://shinetime.example",
entity_suffix: "LLC",
entity_type: "llc",
expedite_ein: true,
formation_state: "WY",
founders: [{
address: {
city: "Austin",
country: "US",
line1: "907 Ridgemont Dr",
line2: "Apt 4",
postal_code: "78704",
state: "TX"
},
date_of_birth: "1988-03-14",
email: "marcus@shinetime.example",
first_name: "Marcus",
is_primary: true,
last_name: "Webb",
ownership_percentage: 100,
phone: "+15125550142",
roles: ["president"],
ssn: "123-45-6789"
}],
share_structure: {
number_of_shares: 123,
value: 123
},
use_registered_agent: true
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.FormCompanyAccountsRequest`
-
**requestOptions:** `AccountsClient.RequestOptions`
client.accounts.retryAdsPayment({ ...params }) -> Whop.RetryAdsPaymentAccountsResponse
-
#### 📝 Description
-
-
Queues one background retry of the account's failed ads payments across its campaigns, using the account's configured ads payment methods. A queued response does not mean payment succeeded; read each campaign's `delivery_status` and `issues` for the outcome. Successful settlement clears the payment block without changing a configured `active` or `paused` status; a legacy `payment_failed` status becomes `paused`. Returns an error when the account has no failed ads payments, or while a previous retry for the account is queued or running.
#### 🔌 Usage
-
-
```typescript
await client.accounts.retryAdsPayment({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetryAdsPaymentAccountsRequest`
-
**requestOptions:** `AccountsClient.RequestOptions`
client.accounts.suspend({ ...params }) -> Whop.Account
-
#### 📝 Description
-
-
Suspends a connected account directly owned by the authenticated platform account. This cannot suspend the platform account itself or an account owned by another platform.
#### 🔌 Usage
-
-
```typescript
await client.accounts.suspend({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.SuspendAccountsRequest`
-
**requestOptions:** `AccountsClient.RequestOptions`
client.accounts.transferOwnership({ ...params }) -> Whop.TransferOwnershipAccountsResponse
-
#### 📝 Description
-
-
Transfers ownership of the account to another user, identified by user ID or email address. If the recipient already holds the owner role, ownership moves immediately; otherwise they get an invite and ownership moves when they accept. The Whop CLI and MCP can hand off a business their user owns as a partner (`as_partner: true`) with the `partner:handoff` scope; other OAuth apps cannot transfer ownership.
#### 🔌 Usage
-
-
```typescript
await client.accounts.transferOwnership({
id: "id",
identifier: "marcus@shinetime.example"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.TransferOwnershipAccountsRequest`
-
**requestOptions:** `AccountsClient.RequestOptions`
client.adCampaigns.list({ ...params }) -> core.Page<Whop.AdCampaign, Whop.ListAdCampaignsResponse>
-
#### 📝 Description
-
-
Lists the ad campaigns for an account, with stats over the requested window.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.adCampaigns.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.adCampaigns.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListAdCampaignsRequest`
-
**requestOptions:** `AdCampaignsClient.RequestOptions`
client.adCampaigns.create({ ...params }) -> Whop.AdCampaign
-
#### 📝 Description
-
-
Creates an ad campaign in `draft` status for an account. Nothing runs until you launch it by setting `status` to `active` with `PATCH /ad_campaigns/:id`.
#### 🔌 Usage
-
-
```typescript
await client.adCampaigns.create({
objective: "awareness",
platform: "whop",
title: "Now hiring mobile detailers \u2014 Austin"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAdCampaignsRequest`
-
**requestOptions:** `AdCampaignsClient.RequestOptions`
client.adCampaigns.retrieve({ ...params }) -> Whop.AdCampaign
-
#### 📝 Description
-
-
Retrieves a single ad campaign with stats over the requested window.
#### 🔌 Usage
-
-
```typescript
await client.adCampaigns.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveAdCampaignsRequest`
-
**requestOptions:** `AdCampaignsClient.RequestOptions`
client.adCampaigns.delete({ ...params }) -> Whop.DeleteAdCampaignsResponse
-
#### 📝 Description
-
-
Deletes an ad campaign and archives it on the ad platform (cascades to ad groups and ads).
#### 🔌 Usage
-
-
```typescript
await client.adCampaigns.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteAdCampaignsRequest`
-
**requestOptions:** `AdCampaignsClient.RequestOptions`
client.adCampaigns.update({ ...params }) -> Whop.AdCampaign
-
#### 📝 Description
-
-
Updates an ad campaign's settings, or launches a draft campaign by setting `status` to `active`. The objective is fixed at creation and cannot be changed.
#### 🔌 Usage
-
-
```typescript
await client.adCampaigns.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateAdCampaignsRequest`
-
**requestOptions:** `AdCampaignsClient.RequestOptions`
client.adCampaigns.duplicate({ ...params }) -> Whop.DuplicateAdCampaignsResponse
-
#### 📝 Description
-
-
Creates copies of the campaign in `duplicating` status and returns them; each copy transitions to `draft` once duplication completes. Poll each returned campaign until it leaves `duplicating` — a copy that could not be completed is deleted and returns 404.
#### 🔌 Usage
-
-
```typescript
await client.adCampaigns.duplicate({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DuplicateAdCampaignsRequest`
-
**requestOptions:** `AdCampaignsClient.RequestOptions`
client.adCampaigns.pause({ ...params }) -> Whop.AdCampaign
-
#### 📝 Description
-
-
Pauses an active ad campaign.
#### 🔌 Usage
-
-
```typescript
await client.adCampaigns.pause({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.PauseAdCampaignsRequest`
-
**requestOptions:** `AdCampaignsClient.RequestOptions`
client.adCampaigns.unpause({ ...params }) -> Whop.AdCampaign
-
#### 📝 Description
-
-
Resumes a paused ad campaign. Requires an ads payment method on the account.
#### 🔌 Usage
-
-
```typescript
await client.adCampaigns.unpause({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UnpauseAdCampaignsRequest`
-
**requestOptions:** `AdCampaignsClient.RequestOptions`
client.adConversionValueRules.list({ ...params }) -> core.Page<Whop.AdConversionValueRule, Whop.ListAdConversionValueRulesResponse>
-
#### 📝 Description
-
-
Lists the conversion value rules you can read.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.adConversionValueRules.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.adConversionValueRules.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListAdConversionValueRulesRequest`
-
**requestOptions:** `AdConversionValueRulesClient.RequestOptions`
client.adConversionValueRules.create({ ...params }) -> Whop.AdConversionValueRule
-
#### 📝 Description
-
-
Creates one rule covering every selected target and event combination. Active rules cannot overlap for the same platform and event. Customer prices and Whop revenue stay unchanged.
#### 🔌 Usage
-
-
```typescript
await client.adConversionValueRules.create({
account_id: "biz_xxxxxxxxxxxxxx",
adjustment_type: "fixed",
events: [{
event_name: "purchase"
}],
targets: [{
platform: "tiktok",
scope: "business"
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAdConversionValueRulesRequest`
-
**requestOptions:** `AdConversionValueRulesClient.RequestOptions`
client.adConversionValueRules.retrieve({ ...params }) -> Whop.AdConversionValueRule
-
#### 📝 Description
-
-
Retrieves a conversion value rule with its targets, events, and value adjustment.
#### 🔌 Usage
-
-
```typescript
await client.adConversionValueRules.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveAdConversionValueRulesRequest`
-
**requestOptions:** `AdConversionValueRulesClient.RequestOptions`
client.adConversionValueRules.delete({ ...params }) -> Whop.DeleteAdConversionValueRulesResponse
-
#### 📝 Description
-
-
Deletes a rule and deactivates all its coverage. The rule's stored settings are preserved.
#### 🔌 Usage
-
-
```typescript
await client.adConversionValueRules.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteAdConversionValueRulesRequest`
-
**requestOptions:** `AdConversionValueRulesClient.RequestOptions`
client.adConversionValueRules.update({ ...params }) -> Whop.AdConversionValueRule
-
#### 📝 Description
-
-
Edits a rule without changing its status. Supplied `targets` or `events` replace that selection in full, and omitted fields stay unchanged. All changes succeed or fail together.
#### 🔌 Usage
-
-
```typescript
await client.adConversionValueRules.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateAdConversionValueRulesRequest`
-
**requestOptions:** `AdConversionValueRulesClient.RequestOptions`
client.adConversionValueRules.pause({ ...params }) -> Whop.AdConversionValueRule
-
#### 📝 Description
-
-
Pauses the rule across all selected targets and events.
#### 🔌 Usage
-
-
```typescript
await client.adConversionValueRules.pause({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.PauseAdConversionValueRulesRequest`
-
**requestOptions:** `AdConversionValueRulesClient.RequestOptions`
client.adConversionValueRules.unpause({ ...params }) -> Whop.AdConversionValueRule
-
#### 📝 Description
-
-
Resumes the rule and automatically replaces overlapping selections in the same transaction. Other selections keep their values, and broader rules remain as defaults. Rules with no remaining selections are paused. Resuming an already-active rule makes no changes.
#### 🔌 Usage
-
-
```typescript
await client.adConversionValueRules.unpause({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UnpauseAdConversionValueRulesRequest`
-
**requestOptions:** `AdConversionValueRulesClient.RequestOptions`
client.adGroups.list({ ...params }) -> core.Page<Whop.AdGroup, Whop.ListAdGroupsResponse>
-
#### 📝 Description
-
-
Lists ad groups for the account, newest first.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.adGroups.list({
ad_campaign_ids: ["adcamp_xxxxxxxxxxxxxx"]
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.adGroups.list({
ad_campaign_ids: ["adcamp_xxxxxxxxxxxxxx"]
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListAdGroupsRequest`
-
**requestOptions:** `AdGroupsClient.RequestOptions`
client.adGroups.create({ ...params }) -> Whop.AdGroup
-
#### 📝 Description
-
-
Creates an ad group (ad set) in a campaign.
#### 🔌 Usage
-
-
```typescript
await client.adGroups.create({
ad_campaign_id: "adcamp_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAdGroupsRequest`
-
**requestOptions:** `AdGroupsClient.RequestOptions`
client.adGroups.estimateReach({ ...params }) -> Whop.ReachEstimate
-
#### 📝 Description
-
-
Estimates how many people a draft targeting spec can reach, before an ad group is created. The body takes the same targeting fields as creating an ad group, and nothing is persisted.
#### 🔌 Usage
-
-
```typescript
await client.adGroups.estimateReach({
platform: "meta"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.EstimateReachAdGroupsRequest`
-
**requestOptions:** `AdGroupsClient.RequestOptions`
client.adGroups.searchTargetingOptions({ ...params }) -> Whop.SearchTargetingOptionsAdGroupsResponse
-
#### 📝 Description
-
-
Searches the ad platform's targeting taxonomy for options to target an ad group with. Each result comes back in the exact shape the ad-group body accepts for its `type`, so it can be used in `detailed_targeting`, `regions`, or `languages` as-is.
#### 🔌 Usage
-
-
```typescript
await client.adGroups.searchTargetingOptions({
platform: "meta"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.SearchTargetingOptionsAdGroupsRequest`
-
**requestOptions:** `AdGroupsClient.RequestOptions`
client.adGroups.retrieve({ ...params }) -> Whop.AdGroup
-
#### 📝 Description
-
-
Retrieves an ad group, with performance stats for the window set by `stats_from` and `stats_to`.
#### 🔌 Usage
-
-
```typescript
await client.adGroups.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveAdGroupsRequest`
-
**requestOptions:** `AdGroupsClient.RequestOptions`
client.adGroups.delete({ ...params }) -> Whop.DeleteAdGroupsResponse
-
#### 📝 Description
-
-
Deletes an ad group, removing it from the ad platform so it stops delivering.
#### 🔌 Usage
-
-
```typescript
await client.adGroups.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteAdGroupsRequest`
-
**requestOptions:** `AdGroupsClient.RequestOptions`
client.adGroups.update({ ...params }) -> Whop.AdGroup
-
#### 📝 Description
-
-
Updates an ad group's editable fields. Only the keys you send are changed.
#### 🔌 Usage
-
-
```typescript
await client.adGroups.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateAdGroupsRequest`
-
**requestOptions:** `AdGroupsClient.RequestOptions`
client.adGroups.duplicate({ ...params }) -> Whop.DuplicateAdGroupsResponse
-
#### 📝 Description
-
-
Starts copying an ad group and returns the copies in `duplicating` status. Poll each returned ad group until it leaves `duplicating`: it then takes the source's `active` or `paused` status, or, if the copy could not be completed, is deleted and returns 404.
#### 🔌 Usage
-
-
```typescript
await client.adGroups.duplicate({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DuplicateAdGroupsRequest`
-
**requestOptions:** `AdGroupsClient.RequestOptions`
client.adGroups.pause({ ...params }) -> Whop.AdGroup
-
#### 📝 Description
-
-
Pauses delivery of an ad group.
#### 🔌 Usage
-
-
```typescript
await client.adGroups.pause({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.PauseAdGroupsRequest`
-
**requestOptions:** `AdGroupsClient.RequestOptions`
client.adGroups.unpause({ ...params }) -> Whop.AdGroup
-
#### 📝 Description
-
-
Resumes delivery of a paused ad group.
#### 🔌 Usage
-
-
```typescript
await client.adGroups.unpause({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UnpauseAdGroupsRequest`
-
**requestOptions:** `AdGroupsClient.RequestOptions`
client.adPixels.list({ ...params }) -> core.Page<Whop.AdPixel, Whop.ListAdPixelsResponse>
-
#### 📝 Description
-
-
List the pixels you added for businesses whose campaigns you claimed.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.adPixels.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.adPixels.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListAdPixelsRequest`
-
**requestOptions:** `AdPixelsClient.RequestOptions`
client.adPixels.create({ ...params }) -> Whop.AdPixel
-
#### 📝 Description
-
-
Add your pixel for a business whose campaigns you claimed. Whop checks the access token with the ad platform, then sends the pixel the conversions credited to your claimed campaigns for that business. Each business takes one pixel per ad platform, and each pixel can serve one business. On Google, the pixel is your Google Ads account, which can serve several businesses, and Whop creates its conversion actions there with your service account key.
#### 🔌 Usage
-
-
```typescript
await client.adPixels.create({
access_token: "new-token",
account_id: "biz_xxxxxxxxxxxxxx",
external_id: "998877665544",
platform: "meta"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAdPixelsRequest`
-
**requestOptions:** `AdPixelsClient.RequestOptions`
client.adPixels.retrieve({ ...params }) -> Whop.AdPixel
-
#### 🔌 Usage
-
-
```typescript
await client.adPixels.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveAdPixelsRequest`
-
**requestOptions:** `AdPixelsClient.RequestOptions`
client.adPixels.delete({ ...params }) -> Whop.DeleteAdPixelsResponse
-
#### 📝 Description
-
-
Remove the pixel and its access token. Whop stops sending it conversions.
#### 🔌 Usage
-
-
```typescript
await client.adPixels.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteAdPixelsRequest`
-
**requestOptions:** `AdPixelsClient.RequestOptions`
client.adPixels.update({ ...params }) -> Whop.AdPixel
-
#### 📝 Description
-
-
Replace the pixel's access token. Whop checks the new token with the ad platform and resumes deliveries to an `errored` pixel.
#### 🔌 Usage
-
-
```typescript
await client.adPixels.update({
id: "id",
access_token: "new-token"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateAdPixelsRequest`
-
**requestOptions:** `AdPixelsClient.RequestOptions`
client.ads.reportStats({ ...params }) -> Whop.AdStat
-
#### 📝 Description
-
-
Records a runner's stats for one of their ads in one hour, and pays them for the spend. Send the ad's totals so far for an hour that started in the last 24 hours; they replace what the ad held for that hour, and its ad group's and campaign's hours are rebuilt from their ads. The spend can go up but never down. Reporting on a campaign starts with the hour of its first recorded report; earlier hours are refused. Spend over what is left of a budget (the runner's share of the day, the campaign's daily budget or the ad group's budget) is refused with the most the ad can record. Takes the runner's Whop session or a user OAuth token with `ad_campaign:update`. A token without that scope gets a 403, and anyone not holding the ad's campaign gets a 404.
#### 🔌 Usage
-
-
```typescript
await client.ads.reportStats({
ad_id: "ad_xxxxxxxxxxxxxx",
hour_started_at: "2026-01-01T12:00:00Z",
spend: 1.1
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ReportStatsAdsRequest`
-
**requestOptions:** `AdsClient.RequestOptions`
client.ads.list({ ...params }) -> core.Page<Whop.Ad, Whop.ListAdsResponse>
-
#### 📝 Description
-
-
Lists the ads for an account, with stats over the requested window.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.ads.list({
ad_campaign_ids: ["adcamp_xxxxxxxxxxxxxx"],
ad_group_ids: ["adgrp_xxxxxxxxxxxxxx"]
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.ads.list({
ad_campaign_ids: ["adcamp_xxxxxxxxxxxxxx"],
ad_group_ids: ["adgrp_xxxxxxxxxxxxxx"]
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListAdsRequest`
-
**requestOptions:** `AdsClient.RequestOptions`
client.ads.create({ ...params }) -> Whop.Ad
-
#### 📝 Description
-
-
Creates an ad in an ad group. Any campaign status other than `draft` launches the campaign, which requires an ads payment method on the account.
#### 🔌 Usage
-
-
```typescript
await client.ads.create();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAdsRequest`
-
**requestOptions:** `AdsClient.RequestOptions`
client.ads.retrieve({ ...params }) -> Whop.Ad
-
#### 📝 Description
-
-
Retrieves a single ad with stats over the requested window.
#### 🔌 Usage
-
-
```typescript
await client.ads.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveAdsRequest`
-
**requestOptions:** `AdsClient.RequestOptions`
client.ads.delete({ ...params }) -> Whop.DeleteAdsResponse
-
#### 📝 Description
-
-
Deletes an ad.
#### 🔌 Usage
-
-
```typescript
await client.ads.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteAdsRequest`
-
**requestOptions:** `AdsClient.RequestOptions`
client.ads.update({ ...params }) -> Whop.Ad
-
#### 📝 Description
-
-
Updates an ad's editable fields.
#### 🔌 Usage
-
-
```typescript
await client.ads.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateAdsRequest`
-
**requestOptions:** `AdsClient.RequestOptions`
client.ads.duplicate({ ...params }) -> Whop.DuplicateAdsResponse
-
#### 📝 Description
-
-
Copies an ad into its own ad group or into another one. Copies keep the source ad's active or paused state.
#### 🔌 Usage
-
-
```typescript
await client.ads.duplicate({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DuplicateAdsRequest`
-
**requestOptions:** `AdsClient.RequestOptions`
client.ads.pause({ ...params }) -> Whop.Ad
-
#### 📝 Description
-
-
Pauses an active ad.
#### 🔌 Usage
-
-
```typescript
await client.ads.pause({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.PauseAdsRequest`
-
**requestOptions:** `AdsClient.RequestOptions`
client.ads.unpause({ ...params }) -> Whop.Ad
-
#### 📝 Description
-
-
Resumes a paused ad.
#### 🔌 Usage
-
-
```typescript
await client.ads.unpause({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UnpauseAdsRequest`
-
**requestOptions:** `AdsClient.RequestOptions`
client.affiliates.list({ ...params }) -> core.Page<Whop.AffiliateListItem, Whop.ListAffiliatesResponse>
-
#### 📝 Description
-
-
Lists the affiliates of an account.
Required permissions:
- `affiliate:basic:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.affiliates.list({
first: 42,
last: 42,
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.affiliates.list({
first: 42,
last: 42,
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListAffiliatesRequest`
-
**requestOptions:** `AffiliatesClient.RequestOptions`
client.affiliates.create({ ...params }) -> Whop.Affiliate
-
#### 📝 Description
-
-
Creates an affiliate for a user on an account. If the user is already an affiliate of the account, returns that affiliate, reactivating it if it was archived.
Required permissions:
- `affiliate:create`
#### 🔌 Usage
-
-
```typescript
await client.affiliates.create({
account_id: "biz_xxxxxxxxxxxxxx",
user_identifier: "user_identifier"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAffiliatesRequest`
-
**requestOptions:** `AffiliatesClient.RequestOptions`
client.affiliates.retrieve({ ...params }) -> Whop.Affiliate
-
#### 📝 Description
-
-
Retrieves the details of an existing affiliate.
Required permissions:
- `affiliate:basic:read`
#### 🔌 Usage
-
-
```typescript
await client.affiliates.retrieve({
id: "aff_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveAffiliatesRequest`
-
**requestOptions:** `AffiliatesClient.RequestOptions`
client.affiliates.archive({ ...params }) -> boolean
-
#### 📝 Description
-
-
Archives an affiliate. The affiliate that handles Whop marketplace referrals cannot be archived.
Required permissions:
- `affiliate:update`
#### 🔌 Usage
-
-
```typescript
await client.affiliates.archive({
id: "aff_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ArchiveAffiliatesRequest`
-
**requestOptions:** `AffiliatesClient.RequestOptions`
client.affiliates.unarchive({ ...params }) -> boolean
-
#### 📝 Description
-
-
Unarchives an archived affiliate.
Required permissions:
- `affiliate:update`
#### 🔌 Usage
-
-
```typescript
await client.affiliates.unarchive({
id: "aff_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UnarchiveAffiliatesRequest`
-
**requestOptions:** `AffiliatesClient.RequestOptions`
client.aiChats.list({ ...params }) -> core.Page<Whop.AiChatListItem, Whop.ListAiChatsResponse>
-
#### 📝 Description
-
-
Returns a paginated list of AI chat threads for the current authenticated user.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.aiChats.list({
first: 42,
last: 42
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.aiChats.list({
first: 42,
last: 42
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListAiChatsRequest`
-
**requestOptions:** `AiChatsClient.RequestOptions`
client.aiChats.create({ ...params }) -> Whop.AiChat
-
#### 📝 Description
-
-
Create a new AI chat thread and send the first message to the AI agent.
Required permissions:
- `ai_chat:create`
#### 🔌 Usage
-
-
```typescript
await client.aiChats.create({
message_text: "message_text"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAiChatsRequest`
-
**requestOptions:** `AiChatsClient.RequestOptions`
client.aiChats.retrieve({ ...params }) -> Whop.AiChat
-
#### 📝 Description
-
-
Retrieves the details of an existing AI chat.
#### 🔌 Usage
-
-
```typescript
await client.aiChats.retrieve({
id: "aich_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveAiChatsRequest`
-
**requestOptions:** `AiChatsClient.RequestOptions`
client.aiChats.delete({ ...params }) -> boolean
-
#### 📝 Description
-
-
Delete an AI chat thread so it no longer appears in the user's chat list.
Required permissions:
- `ai_chat:delete`
#### 🔌 Usage
-
-
```typescript
await client.aiChats.delete({
id: "aich_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteAiChatsRequest`
-
**requestOptions:** `AiChatsClient.RequestOptions`
client.aiChats.update({ ...params }) -> Whop.AiChat
-
#### 📝 Description
-
-
Update an AI chat's title, notification preferences, or associated account context.
Required permissions:
- `ai_chat:update`
#### 🔌 Usage
-
-
```typescript
await client.aiChats.update({
id: "aich_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateAiChatsRequest`
-
**requestOptions:** `AiChatsClient.RequestOptions`
client.apiKeys.list({ ...params }) -> core.Page<Whop.ApiKey, Whop.ListApiKeysResponse>
-
#### 📝 Description
-
-
Lists the API keys of an account or app, newest first. Responses never include the full secret — only its obfuscated form.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.apiKeys.list({
resource_id: "resource_id",
resource_type: "account"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.apiKeys.list({
resource_id: "resource_id",
resource_type: "account"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListApiKeysRequest`
-
**requestOptions:** `ApiKeysClient.RequestOptions`
client.apiKeys.create({ ...params }) -> Whop.ApiKey
-
#### 📝 Description
-
-
Creates an API key for an account or app. The response is the only place the full `secret_key` is returned — store it immediately. Requires a user session; API keys cannot manage API keys.
#### 🔌 Usage
-
-
```typescript
await client.apiKeys.create({
name: "Shine Time Booking (production)",
permissions: {},
resource_id: "biz_xxxxxxxxxxxxxx",
resource_type: "account"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateApiKeysRequest`
-
**requestOptions:** `ApiKeysClient.RequestOptions`
client.apiKeys.listPermissions() -> Whop.ListPermissionsApiKeysResponse
-
#### 📝 Description
-
-
Lists the catalog of permission actions that can be granted to users, apps, and API keys. Use it to choose the `permissions` for an API key or to build a permission picker. Small and returned in full on one page.
#### 🔌 Usage
-
-
```typescript
await client.apiKeys.listPermissions();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `ApiKeysClient.RequestOptions`
client.apiKeys.retrieve({ ...params }) -> Whop.ApiKey
-
#### 📝 Description
-
-
Retrieves an API key with its effective permission grants. The full secret is never returned — rotate the key if it was lost.
#### 🔌 Usage
-
-
```typescript
await client.apiKeys.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveApiKeysRequest`
-
**requestOptions:** `ApiKeysClient.RequestOptions`
client.apiKeys.delete({ ...params }) -> Whop.DeleteApiKeysResponse
-
#### 📝 Description
-
-
Permanently revokes an API key; requests using its secret stop authenticating immediately. Default and agent-backend keys cannot be deleted.
#### 🔌 Usage
-
-
```typescript
await client.apiKeys.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteApiKeysRequest`
-
**requestOptions:** `ApiKeysClient.RequestOptions`
client.apiKeys.update({ ...params }) -> Whop.ApiKey
-
#### 📝 Description
-
-
Updates an API key's name, permissions, API version, expiration, or IP allowlist. Fields that are omitted keep their current value; default keys cannot be modified.
#### 🔌 Usage
-
-
```typescript
await client.apiKeys.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateApiKeysRequest`
-
**requestOptions:** `ApiKeysClient.RequestOptions`
client.apiKeys.rotate({ ...params }) -> Whop.ApiKey
-
#### 📝 Description
-
-
Rotates the API key's secret, invalidating the previous secret immediately. The response is the only place the new `secret_key` is returned.
#### 🔌 Usage
-
-
```typescript
await client.apiKeys.rotate({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RotateApiKeysRequest`
-
**requestOptions:** `ApiKeysClient.RequestOptions`
client.apiLogs.list({ ...params }) -> core.Page<Whop.ListApiLogsResponse.Data.Item, Whop.ListApiLogsResponse>
-
#### 📝 Description
-
-
Lists the requests served by Whop's API with the account's API keys, newest first — every surface (GraphQL, REST, and native /api/v1), reads and failed requests included.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.apiLogs.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.apiLogs.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListApiLogsRequest`
-
**requestOptions:** `ApiLogsClient.RequestOptions`
client.appBuilds.list({ ...params }) -> core.Page<Whop.AppBuild, Whop.ListAppBuildsResponse>
-
#### 📝 Description
-
-
Returns a paginated list of build artifacts for an app, newest first, with optional platform, status, and creation-date filters.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.appBuilds.list({
app_id: "app_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.appBuilds.list({
app_id: "app_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListAppBuildsRequest`
-
**requestOptions:** `AppBuildsClient.RequestOptions`
client.appBuilds.create({ ...params }) -> Whop.AppBuild
-
#### 📝 Description
-
-
Uploads a new build artifact for an app. Upload the file first with `POST /files` or a direct upload, then reference it in `attachment`.
#### 🔌 Usage
-
-
```typescript
await client.appBuilds.create({
attachment: {},
checksum: "xxxxxxxxxxxxxxx",
platform: "ios"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAppBuildsRequest`
-
**requestOptions:** `AppBuildsClient.RequestOptions`
client.appBuilds.retrieve({ ...params }) -> Whop.AppBuild
-
#### 📝 Description
-
-
Retrieves the details of an existing app build.
#### 🔌 Usage
-
-
```typescript
await client.appBuilds.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveAppBuildsRequest`
-
**requestOptions:** `AppBuildsClient.RequestOptions`
client.appBuilds.promote({ ...params }) -> Whop.AppBuild
-
#### 📝 Description
-
-
Promotes a draft or approved app build to production so it becomes the active version served to users. Draft builds enter review first.
#### 🔌 Usage
-
-
```typescript
await client.appBuilds.promote({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.PromoteAppBuildsRequest`
-
**requestOptions:** `AppBuildsClient.RequestOptions`
client.appInstallations.list({ ...params }) -> core.Page<Whop.AppInstallation, Whop.ListAppInstallationsResponse>
-
#### 📝 Description
-
-
Lists app installations, newest first. An app's API key lists the accounts that installed it. An account lists the apps installed on it; a user passes that account's `account_id`. The developer of an app lists every installation of it by passing `app_id`. Uninstalled apps, deleted apps and deleted accounts are left out.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.appInstallations.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.appInstallations.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListAppInstallationsRequest`
-
**requestOptions:** `AppInstallationsClient.RequestOptions`
client.appInstallations.retrieve({ ...params }) -> Whop.AppInstallation
-
#### 📝 Description
-
-
Retrieves an app installation, with the metadata the app stores on it. The app, its developer and the account it's installed on can retrieve it.
#### 🔌 Usage
-
-
```typescript
await client.appInstallations.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveAppInstallationsRequest`
-
**requestOptions:** `AppInstallationsClient.RequestOptions`
client.appInstallations.update({ ...params }) -> Whop.AppInstallation
-
#### 📝 Description
-
-
Updates the `metadata` and `external_id` your app keeps on an installation. Only the metadata keys you send change, so separate jobs can each keep their own keys.
#### 🔌 Usage
-
-
```typescript
await client.appInstallations.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateAppInstallationsRequest`
-
**requestOptions:** `AppInstallationsClient.RequestOptions`
client.apps.list({ ...params }) -> core.Page<Whop.AppListItem, Whop.ListAppsResponse>
-
#### 📝 Description
-
-
Lists apps on the Whop platform: the app store's live apps, or — with `account_id` and developer access to that account — every app the account owns. Requires authentication except for Whop's public app and website discovery lists. Public website discovery includes built official blueprints (verified apps with a product) and built, live community blueprints that Whop recommends.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.apps.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.apps.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListAppsRequest`
-
**requestOptions:** `AppsClient.RequestOptions`
client.apps.create({ ...params }) -> Whop.App
-
#### 📝 Description
-
-
Registers a new app on the Whop developer platform. Apps provide custom experiences that can be added to products.
#### 🔌 Usage
-
-
```typescript
await client.apps.create({
name: "Shine Time Booking"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAppsRequest`
-
**requestOptions:** `AppsClient.RequestOptions`
client.apps.retrieve({ ...params }) -> Whop.App
-
#### 📝 Description
-
-
Retrieves an app by ID, claimed route, active verified custom hostname, or proxy domain id. Authentication is optional; credential fields stay `null` unless you have the matching developer permission on the owning account.
#### 🔌 Usage
-
-
```typescript
await client.apps.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveAppsRequest`
-
**requestOptions:** `AppsClient.RequestOptions`
client.apps.delete({ ...params }) -> Whop.DeleteAppsResponse
-
#### 📝 Description
-
-
Deletes an app. The app stops resolving within seconds — a website's site stops serving, and any claimed subdomain is reserved for a month before it can be claimed again.
#### 🔌 Usage
-
-
```typescript
await client.apps.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteAppsRequest`
-
**requestOptions:** `AppsClient.RequestOptions`
client.apps.update({ ...params }) -> Whop.App
-
#### 📝 Description
-
-
Updates the settings, metadata, or status of an app. Fields that are omitted keep their current value.
#### 🔌 Usage
-
-
```typescript
await client.apps.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateAppsRequest`
-
**requestOptions:** `AppsClient.RequestOptions`
client.apps.deploy({ ...params }) -> Whop.AppDeployment
-
#### 📝 Description
-
-
Builds the app's current source and ships it. Returns the run it started, so the caller can render progress from this response and then follow it on the app's `deployment` field. Only one deployment runs per app at a time — calling this while one is in flight reports that run rather than starting a second, and calling it with nothing to publish reports that instead of starting one.
#### 🔌 Usage
-
-
```typescript
await client.apps.deploy({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeployAppsRequest`
-
**requestOptions:** `AppsClient.RequestOptions`
client.apps.logs({ ...params }) -> core.Page<Whop.LogsAppsResponse.Data.Item, Whop.LogsAppsResponse>
-
#### 📝 Description
-
-
Lists a hosted app's server runtime logs, most recent first: console output, uncaught exceptions, and failed-request summaries captured on whop.site hosting. Logs are retained for 7 days.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.apps.logs({
id: "id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.apps.logs({
id: "id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.LogsAppsRequest`
-
**requestOptions:** `AppsClient.RequestOptions`
client.apps.updatePermissions({ ...params }) -> Whop.App
-
#### 📝 Description
-
-
Replaces the set of permissions the app requests from users when they install it. Requires a user session: the `developer:update_app_authorization` scope cannot be delegated to API keys. Sensitive permissions require step-up verification.
#### 🔌 Usage
-
-
```typescript
await client.apps.updatePermissions({
id: "id",
requested_permissions: [{
action: "company:basic:read",
is_required: true,
justification: "Reads basic account info to render the dashboard home."
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdatePermissionsAppsRequest`
-
**requestOptions:** `AppsClient.RequestOptions`
client.audiences.list({ ...params }) -> core.Page<Whop.Audience, Whop.ListAudiencesResponse>
-
#### 📝 Description
-
-
Lists an account's custom and lookalike audiences.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.audiences.list({
account_id: "account_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.audiences.list({
account_id: "account_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListAudiencesRequest`
-
**requestOptions:** `AudiencesClient.RequestOptions`
client.audiences.create({ ...params }) -> Whop.CreateAudiencesResponse
-
#### 📝 Description
-
-
Creates a custom audience from a customer list, your account's Whop People data, or engagement with videos, lead forms, Instagram profiles, or Facebook pages, or a lookalike audience that reaches people similar to an existing one. Processing runs asynchronously. A custom audience returns one audience; a lookalike returns the requested similarity bands in `data`.
#### 🔌 Usage
-
-
```typescript
await client.audiences.create({
account_id: "biz_xxxxxxxxxxxxxx",
engagement: {
include: [{
object: "facebook_page",
event: "engaged",
external_account_id: "sacc_xxxxxxxxxxxxxx",
retention_days: 30
}],
platform: "meta"
},
name: "Page engagers",
source_type: "engagement"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAudiencesRequest`
-
**requestOptions:** `AudiencesClient.RequestOptions`
client.audiences.delete({ ...params }) -> Whop.DeleteAudiencesResponse
-
#### 📝 Description
-
-
Deletes an audience so it is no longer available for targeting.
#### 🔌 Usage
-
-
```typescript
await client.audiences.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteAudiencesRequest`
-
**requestOptions:** `AudiencesClient.RequestOptions`
client.audiences.update({ ...params }) -> Whop.Audience
-
#### 📝 Description
-
-
Renames an audience. For an audience built from People filters that keeps itself up to date, pass `filters` to replace them, which rebuilds membership immediately. Whether an audience auto refreshes is set when it is created.
#### 🔌 Usage
-
-
```typescript
await client.audiences.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateAudiencesRequest`
-
**requestOptions:** `AudiencesClient.RequestOptions`
client.audiences.addPeople({ ...params }) -> Whop.Audience
-
#### 📝 Description
-
-
Adds users from a new CSV file to an existing uploaded custom audience. The file uses the audience's saved column mapping, processing happens in the background, and existing audience members remain unchanged.
#### 🔌 Usage
-
-
```typescript
await client.audiences.addPeople({
id: "id",
file_id: "file_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.AddPeopleAudiencesRequest`
-
**requestOptions:** `AudiencesClient.RequestOptions`
client.authorizedUsers.list({ ...params }) -> core.Page<Whop.AuthorizedUserListItem, Whop.ListAuthorizedUsersResponse>
-
#### 📝 Description
-
-
Lists the authorized users on an account's team.
Required permissions:
- `company:authorized_user:read`
- `member:email:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.authorizedUsers.list({
first: 42,
last: 42,
user_id: "user_xxxxxxxxxxxxx",
created_before: "2023-12-01T05:00:00Z",
created_after: "2023-12-01T05:00:00Z",
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.authorizedUsers.list({
first: 42,
last: 42,
user_id: "user_xxxxxxxxxxxxx",
created_before: "2023-12-01T05:00:00Z",
created_after: "2023-12-01T05:00:00Z",
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListAuthorizedUsersRequest`
-
**requestOptions:** `AuthorizedUsersClient.RequestOptions`
client.authorizedUsers.create({ ...params }) -> Whop.AuthorizedUser
-
#### 📝 Description
-
-
Adds a user to an account's team as an authorized user with the given role.
Required permissions:
- `authorized_user:create`
- `member:email:read`
#### 🔌 Usage
-
-
```typescript
await client.authorizedUsers.create({
account_id: "biz_xxxxxxxxxxxxxx",
role: "owner",
user_id: "user_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateAuthorizedUsersRequest`
-
**requestOptions:** `AuthorizedUsersClient.RequestOptions`
client.authorizedUsers.retrieve({ ...params }) -> Whop.AuthorizedUser
-
#### 📝 Description
-
-
Retrieves the details of an existing authorized user.
Required permissions:
- `company:authorized_user:read`
- `member:email:read`
#### 🔌 Usage
-
-
```typescript
await client.authorizedUsers.retrieve({
id: "ausr_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveAuthorizedUsersRequest`
-
**requestOptions:** `AuthorizedUsersClient.RequestOptions`
client.authorizedUsers.delete({ ...params }) -> boolean
-
#### 📝 Description
-
-
Removes an authorized user from an account's team.
Required permissions:
- `authorized_user:delete`
#### 🔌 Usage
-
-
```typescript
await client.authorizedUsers.delete({
id: "ausr_xxxxxxxxxxxxx",
account_id: "biz_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteAuthorizedUsersRequest`
-
**requestOptions:** `AuthorizedUsersClient.RequestOptions`
client.bounties.list({ ...params }) -> core.Page<Whop.BountyListItem, Whop.ListBountiesResponse>
-
#### 📝 Description
-
-
Lists bounties visible to the credential — for an account API key, the account's bounties including scheduled drafts; for a user token, the bounties the user can see and work.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.bounties.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.bounties.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListBountiesRequest`
-
**requestOptions:** `BountiesClient.RequestOptions`
client.bounties.create({ ...params }) -> Whop.Bounty
-
#### 📝 Description
-
-
Creates a bounty and escrows its reward pool. Publishes immediately, or as a scheduled draft when you set `publish_at`.
#### 🔌 Usage
-
-
```typescript
await client.bounties.create({
description: "Record one continuous pass of a full interior detail, dash to trunk, on a customer vehicle.",
gross_reward_amount: 40,
title: "Record interior detailing passes"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateBountiesRequest`
-
**requestOptions:** `BountiesClient.RequestOptions`
client.bounties.retrieve({ ...params }) -> Whop.Bounty
-
#### 📝 Description
-
-
Retrieves a bounty by ID. Authentication is optional: a request with no credential reads the bounty when it is publicly visible — published or completed, and not restricted to a private experience's members. Bounties outside the caller's scope, and bounties not publicly visible to an anonymous caller, return `404`.
#### 🔌 Usage
-
-
```typescript
await client.bounties.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveBountiesRequest`
-
**requestOptions:** `BountiesClient.RequestOptions`
client.bounties.update({ ...params }) -> Whop.Bounty
-
#### 📝 Description
-
-
Updates a bounty. A published bounty accepts title, description, and country targeting while it is still open with nothing under review. A scheduled (not-yet-published) draft additionally accepts the reward, winner slots, and schedule.
#### 🔌 Usage
-
-
```typescript
await client.bounties.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateBountiesRequest`
-
**requestOptions:** `BountiesClient.RequestOptions`
client.bounties.cancel({ ...params }) -> Whop.Bounty
-
#### 📝 Description
-
-
Cancels a bounty. With no in-flight work, it cancels immediately and refunds the funder. Otherwise it stops new submissions and cancels once the in-flight work resolves and pays out. Repeating the request is a no-op. A bounty that already paid out every slot returns `400`.
#### 🔌 Usage
-
-
```typescript
await client.bounties.cancel({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CancelBountiesRequest`
-
**requestOptions:** `BountiesClient.RequestOptions`
client.bountySubmissions.list({ ...params }) -> core.Page<Whop.BountySubmission, Whop.ListBountySubmissionsResponse>
-
#### 📝 Description
-
-
Lists bounty submissions visible to the credential — for a user token, the submissions they authored plus those on bounties they posted; for an account API key, the submissions on the account's bounties. For the anonymous view of one bounty's reviewed work, use the submissions list under the bounty instead.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.bountySubmissions.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.bountySubmissions.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListBountySubmissionsRequest`
-
**requestOptions:** `BountySubmissionsClient.RequestOptions`
client.bountySubmissions.create({ ...params }) -> Whop.BountySubmission
-
#### 📝 Description
-
-
Creates a submission on a workforce bounty. Include a `deliverable` and the submission goes straight to review; create is the only step. For `data_capture` bounties, omit the deliverable: this starts a claimed attempt whose proof accumulates server-side, and `POST /bounty_submissions/:id/submit` sends it to review once complete. Requires a user credential — account API keys cannot author submissions.
#### 🔌 Usage
-
-
```typescript
await client.bountySubmissions.create({
bounty_id: "bnty_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateBountySubmissionsRequest`
-
**requestOptions:** `BountySubmissionsClient.RequestOptions`
client.bountySubmissions.retrieve({ ...params }) -> Whop.BountySubmission
-
#### 📝 Description
-
-
Retrieves one bounty submission the credential can see — one the caller authored, or one on a bounty they posted or their account owns. Reading another member's work on an account's bounty takes `account_id`, the same way the list does.
#### 🔌 Usage
-
-
```typescript
await client.bountySubmissions.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveBountySubmissionsRequest`
-
**requestOptions:** `BountySubmissionsClient.RequestOptions`
client.bountySubmissions.delete({ ...params }) -> Whop.DeleteBountySubmissionsResponse
-
#### 📝 Description
-
-
Cancels the caller's own active attempt on a bounty and discards any accumulated capture clips. Only the worker who started the attempt can cancel it — account API keys cannot.
#### 🔌 Usage
-
-
```typescript
await client.bountySubmissions.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteBountySubmissionsRequest`
-
**requestOptions:** `BountySubmissionsClient.RequestOptions`
client.bountySubmissions.submit({ ...params }) -> Whop.BountySubmission
-
#### 📝 Description
-
-
Submits a claimed attempt for review. A livestream attempt needs an ended proof stream and can attach a `deliverable`; a data capture attempt instead needs enough validated clip time and takes no payload. Only the worker who started the attempt can submit it — account API keys cannot.
#### 🔌 Usage
-
-
```typescript
await client.bountySubmissions.submit({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.SubmitBountySubmissionsRequest`
-
**requestOptions:** `BountySubmissionsClient.RequestOptions`
client.cardTransactions.list({ ...params }) -> core.Page<Whop.CardTransaction, Whop.ListCardTransactionsResponse>
-
#### 📝 Description
-
-
Lists the card transactions of an account or a user, newest first. Covers every card the owner has ever had, including canceled cards and spend that predates a re-application, and team members only see transactions on the cards assigned to them. Pass `transaction_ids` to fetch specific transactions instead of paging for them.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.cardTransactions.list({
transaction_ids: ["citx_xxxxxxxxxxxxxx"],
card_id: ["icrd_xxxxxxxxxxxxxx"],
cardholder_id: ["user_xxxxxxxxxxxxxx"]
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.cardTransactions.list({
transaction_ids: ["citx_xxxxxxxxxxxxxx"],
card_id: ["icrd_xxxxxxxxxxxxxx"],
cardholder_id: ["user_xxxxxxxxxxxxxx"]
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListCardTransactionsRequest`
-
**requestOptions:** `CardTransactionsClient.RequestOptions`
client.cardTransactions.retrieve({ ...params }) -> Whop.CardTransaction
-
#### 📝 Description
-
-
Retrieves a single card transaction from any card the owner has ever had, including canceled cards. Team members can retrieve only transactions on the cards assigned to them.
#### 🔌 Usage
-
-
```typescript
await client.cardTransactions.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveCardTransactionsRequest`
-
**requestOptions:** `CardTransactionsClient.RequestOptions`
client.cards.list({ ...params }) -> Whop.ListCardsResponse
-
#### 📝 Description
-
-
Lists the Whop cards of an account or user, including ones still being set up. Team members only see the cards assigned to them.
#### 🔌 Usage
-
-
```typescript
await client.cards.list();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListCardsRequest`
-
**requestOptions:** `CardsClient.RequestOptions`
client.cards.create({ ...params }) -> Whop.CreateCardsResponse
-
#### 📝 Description
-
-
Issues a virtual card, or applies for card issuing. An account with no application files one here and gets back a `202`; call again to issue the card once it is approved. An account whose application was denied or canceled applies again the same way, replacing that application.
#### 🔌 Usage
-
-
```typescript
await client.cards.create();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateCardsRequest`
-
**requestOptions:** `CardsClient.RequestOptions`
client.cards.retrieve({ ...params }) -> Whop.RetrieveCardsResponse
-
#### 📝 Description
-
-
Retrieves a single card, including its `secrets` (card number, CVC, and PIN), which List Cards does not return.
#### 🔌 Usage
-
-
```typescript
await client.cards.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveCardsRequest`
-
**requestOptions:** `CardsClient.RequestOptions`
client.cards.update({ ...params }) -> Whop.UpdateCardsResponse
-
#### 📝 Description
-
-
Updates, freezes, or cancels a card. Updating the card's name, billing address, or limits requires both `payout:account:update` and `company:balance:read`; a card's assigned holder may update their own card's pin and frozen state with any user token.
#### 🔌 Usage
-
-
```typescript
await client.cards.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateCardsRequest`
-
**requestOptions:** `CardsClient.RequestOptions`
client.cashbackRules.create({ ...params }) -> Whop.CashbackRule
-
#### 📝 Description
-
-
Creates a future-dated card cashback rule for your direct connected accounts, funded by the authenticated platform account. Creating a rule does not transfer funds; pay cashback out with `POST /cashback_rules/payout`. Requires `payout:transfer_funds`. Supports `Idempotency-Key` for safe retries.
#### 🔌 Usage
-
-
```typescript
await client.cashbackRules.create({
rate_bps: 500,
starts_at: "2026-01-01T12:00:00Z"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateCashbackRulesRequest`
-
**requestOptions:** `CashbackRulesClient.RequestOptions`
client.cashbackRules.list({ ...params }) -> core.Page<Whop.CashbackRule, Whop.ListCashbackRulesResponse>
-
#### 📝 Description
-
-
Lists the cashback rules funded by the authenticated platform account, including scheduled, expired, and discarded rules. Requires an account-scoped credential with `payout:transfer:read`.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.cashbackRules.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.cashbackRules.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListCashbackRulesRequest`
-
**requestOptions:** `CashbackRulesClient.RequestOptions`
client.cashbackRules.payout({ ...params }) -> Whop.CashbackPayout
-
#### 📝 Description
-
-
Pays out cashback on demand from the authenticated platform's available USD balance to its direct connected accounts. Covers completed, unpaid card transactions created before the request, each under its latest matching rule, which must be funded by the authenticated platform. Filters combine, and an empty body includes every eligible transaction. Payouts process in the background and amounts are calculated then, so the response confirms queuing, not payment. If a payout fails for insufficient funds, add USD to the platform's balance. Requires `payout:transfer_funds`. Supports `Idempotency-Key`, and overlapping requests cannot pay the same card transaction twice.
#### 🔌 Usage
-
-
```typescript
await client.cashbackRules.payout();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.PayoutCashbackRulesRequest`
-
**requestOptions:** `CashbackRulesClient.RequestOptions`
client.cashbackRules.update({ ...params }) -> Whop.CashbackRule
-
#### 📝 Description
-
-
Updates the merchant filters, description, or expiration of a cashback rule funded by the authenticated platform account; its start, rate, and accounts can't change. Omitted fields stay unchanged. Scheduled, active, and expired rules can be updated, but discarded rules can't. Updating a rule does not transfer funds. Requires `payout:transfer_funds`.
#### 🔌 Usage
-
-
```typescript
await client.cashbackRules.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateCashbackRulesRequest`
-
**requestOptions:** `CashbackRulesClient.RequestOptions`
client.chatChannels.list({ ...params }) -> core.Page<Whop.ChatChannelListItem, Whop.ListChatChannelsResponse>
-
#### 📝 Description
-
-
Lists the chat channels in an account.
Required permissions:
- `chat:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.chatChannels.list({
first: 42,
last: 42,
product_id: "prod_xxxxxxxxxxxxx",
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.chatChannels.list({
first: 42,
last: 42,
product_id: "prod_xxxxxxxxxxxxx",
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListChatChannelsRequest`
-
**requestOptions:** `ChatChannelsClient.RequestOptions`
client.chatChannels.retrieve({ ...params }) -> Whop.ChatChannel
-
#### 📝 Description
-
-
Retrieves the details of an existing chat channel.
Required permissions:
- `chat:read`
#### 🔌 Usage
-
-
```typescript
await client.chatChannels.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveChatChannelsRequest`
-
**requestOptions:** `ChatChannelsClient.RequestOptions`
client.chatChannels.update({ ...params }) -> Whop.ChatChannel
-
#### 📝 Description
-
-
Updates a chat channel's moderation settings, such as who can post, banned words, and media restrictions.
Required permissions:
- `chat:moderate`
#### 🔌 Usage
-
-
```typescript
await client.chatChannels.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateChatChannelsRequest`
-
**requestOptions:** `ChatChannelsClient.RequestOptions`
client.checkoutConfigurations.list({ ...params }) -> core.Page<Whop.ListCheckoutConfigurationsResponse.Data.Item, Whop.ListCheckoutConfigurationsResponse>
-
#### 📝 Description
-
-
Lists checkout configurations for an account.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.checkoutConfigurations.list({
account_id: "account_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.checkoutConfigurations.list({
account_id: "account_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListCheckoutConfigurationsRequest`
-
**requestOptions:** `CheckoutConfigurationsClient.RequestOptions`
client.checkoutConfigurations.create({ ...params }) -> Whop.CreateCheckoutConfigurationsResponse
-
#### 📝 Description
-
-
Creates a reusable checkout configuration for an existing or inline variant. Send customers to its `purchase_url` to check out.
#### 🔌 Usage
-
-
```typescript
await client.checkoutConfigurations.create({
account_id: "biz_xxxxxxxxxxxxxx",
variant_id: "plan_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateCheckoutConfigurationsRequest`
-
**requestOptions:** `CheckoutConfigurationsClient.RequestOptions`
client.checkoutConfigurations.retrieve({ ...params }) -> Whop.RetrieveCheckoutConfigurationsResponse
-
#### 📝 Description
-
-
Retrieves a checkout configuration by ID. This endpoint is public so a checkout page can load from the configuration URL.
#### 🔌 Usage
-
-
```typescript
await client.checkoutConfigurations.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveCheckoutConfigurationsRequest`
-
**requestOptions:** `CheckoutConfigurationsClient.RequestOptions`
client.checkoutConfigurations.delete({ ...params }) -> Whop.DeleteCheckoutConfigurationsResponse
-
#### 📝 Description
-
-
Deletes a checkout configuration so its checkout URL can no longer be used.
#### 🔌 Usage
-
-
```typescript
await client.checkoutConfigurations.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteCheckoutConfigurationsRequest`
-
**requestOptions:** `CheckoutConfigurationsClient.RequestOptions`
client.claimLinks.retrieve({ ...params }) -> Whop.RetrieveClaimLinksResponse
-
#### 📝 Description
-
-
Retrieves a funded claim link by ID or by its public claim code. By ID, the caller needs `airdrop_link:basic:read` on the funding account, or must own the funding personal account; `code` and `claim_url` are `null` without `airdrop_link:manage` on the funding account or `payout:withdraw_funds` on the personal account. A claim code previews the sender, amount, expiry, and claim availability without authentication. Treat codes as secrets: anyone holding one can claim after signing in.
#### 🔌 Usage
-
-
```typescript
await client.claimLinks.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveClaimLinksRequest`
-
**requestOptions:** `ClaimLinksClient.RequestOptions`
client.claimLinks.claim({ ...params }) -> Whop.ClaimClaimLinksResponse
-
#### 📝 Description
-
-
Claims a funded link into the authenticated user's personal balance and returns the updated link. Requires a signed-in user and the public claim code; account API keys cannot claim on a recipient's behalf. Each user can claim a link once. Reuse the same `Idempotency-Key` when retrying the same request. On-chain claims may take several minutes to complete.
#### 🔌 Usage
-
-
```typescript
await client.claimLinks.claim({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ClaimClaimLinksRequest`
-
**requestOptions:** `ClaimLinksClient.RequestOptions`
client.companyTokenTransactions.list({ ...params }) -> core.Page<Whop.CompanyTokenTransactionListItem, Whop.ListCompanyTokenTransactionsResponse>
-
#### 📝 Description
-
-
Lists an account's token transactions, newest first.
Required permissions:
- `company_token_transaction:read`
- `member:basic:read`
- `company:basic:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.companyTokenTransactions.list({
first: 42,
last: 42,
user_id: "user_xxxxxxxxxxxxx",
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.companyTokenTransactions.list({
first: 42,
last: 42,
user_id: "user_xxxxxxxxxxxxx",
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListCompanyTokenTransactionsRequest`
-
**requestOptions:** `CompanyTokenTransactionsClient.RequestOptions`
client.companyTokenTransactions.create({ ...params }) -> Whop.CompanyTokenTransaction
-
#### 📝 Description
-
-
Creates a token transaction that adds, subtracts, or transfers tokens for a member of an account.
Required permissions:
- `company_token_transaction:create`
- `member:basic:read`
- `company:basic:read`
#### 🔌 Usage
-
-
```typescript
await client.companyTokenTransactions.create({
transaction_type: "transfer",
account_id: "biz_xxxxxxxxxxxxxx",
amount: 6.9,
destination_user_id: "destination_user_id",
user_id: "user_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateCompanyTokenTransactionsRequest`
-
**requestOptions:** `CompanyTokenTransactionsClient.RequestOptions`
client.companyTokenTransactions.retrieve({ ...params }) -> Whop.CompanyTokenTransaction
-
#### 📝 Description
-
-
Retrieves a token transaction.
Required permissions:
- `company_token_transaction:read`
- `member:basic:read`
- `company:basic:read`
#### 🔌 Usage
-
-
```typescript
await client.companyTokenTransactions.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveCompanyTokenTransactionsRequest`
-
**requestOptions:** `CompanyTokenTransactionsClient.RequestOptions`
client.confirmationTokens.retrieve({ ...params }) -> Whop.ConfirmationToken
-
#### 📝 Description
-
-
Retrieves a confirmation token's payment method and billing details, never the underlying payment credential, to display what the buyer chose or check that the token is still usable. Requires no authentication and is rate-limited.
#### 🔌 Usage
-
-
```typescript
await client.confirmationTokens.retrieve({
id: "id",
account_id: "account_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveConfirmationTokensRequest`
-
**requestOptions:** `ConfirmationTokensClient.RequestOptions`
client.courseChapters.list({ ...params }) -> core.Page<Whop.CourseChapterListItem, Whop.ListCourseChaptersResponse>
-
#### 📝 Description
-
-
Returns a paginated list of chapters within a course, ordered by position.
Required permissions:
- `courses:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.courseChapters.list({
first: 42,
last: 42,
course_id: "cors_xxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.courseChapters.list({
first: 42,
last: 42,
course_id: "cors_xxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListCourseChaptersRequest`
-
**requestOptions:** `CourseChaptersClient.RequestOptions`
client.courseChapters.create({ ...params }) -> Whop.CourseChapter
-
#### 📝 Description
-
-
Create a new chapter within a course to organize lessons into sections.
Required permissions:
- `courses:update`
#### 🔌 Usage
-
-
```typescript
await client.courseChapters.create({
course_id: "cors_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateCourseChaptersRequest`
-
**requestOptions:** `CourseChaptersClient.RequestOptions`
client.courseChapters.retrieve({ ...params }) -> Whop.CourseChapter
-
#### 📝 Description
-
-
Retrieves the details of an existing course chapter.
Required permissions:
- `courses:read`
#### 🔌 Usage
-
-
```typescript
await client.courseChapters.retrieve({
id: "chap_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveCourseChaptersRequest`
-
**requestOptions:** `CourseChaptersClient.RequestOptions`
client.courseChapters.delete({ ...params }) -> boolean
-
#### 📝 Description
-
-
Permanently delete a chapter and all of its lessons from a course.
Required permissions:
- `courses:update`
#### 🔌 Usage
-
-
```typescript
await client.courseChapters.delete({
id: "chap_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteCourseChaptersRequest`
-
**requestOptions:** `CourseChaptersClient.RequestOptions`
client.courseChapters.update({ ...params }) -> Whop.CourseChapter
-
#### 📝 Description
-
-
Update a chapter's title within a course.
Required permissions:
- `courses:update`
#### 🔌 Usage
-
-
```typescript
await client.courseChapters.update({
id: "chap_xxxxxxxxxxxxx",
title: "title"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateCourseChaptersRequest`
-
**requestOptions:** `CourseChaptersClient.RequestOptions`
client.courseLessonInteractions.list({ ...params }) -> core.Page<Whop.CourseLessonInteractionListItem, Whop.ListCourseLessonInteractionsResponse>
-
#### 📝 Description
-
-
Returns a paginated list of lesson interactions for a lesson or course. Callers without admin access to the course's experience see only their own interactions.
Required permissions:
- `courses:read`
- `course_analytics:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.courseLessonInteractions.list({
first: 42,
last: 42,
user_id: "user_xxxxxxxxxxxxx",
lesson_id: "lesn_xxxxxxxxxxxxx",
course_id: "cors_xxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.courseLessonInteractions.list({
first: 42,
last: 42,
user_id: "user_xxxxxxxxxxxxx",
lesson_id: "lesn_xxxxxxxxxxxxx",
course_id: "cors_xxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListCourseLessonInteractionsRequest`
-
**requestOptions:** `CourseLessonInteractionsClient.RequestOptions`
client.courseLessonInteractions.retrieve({ ...params }) -> Whop.CourseLessonInteraction
-
#### 📝 Description
-
-
Retrieves the details of an existing course lesson interaction.
Required permissions:
- `courses:read`
- `course_analytics:read`
#### 🔌 Usage
-
-
```typescript
await client.courseLessonInteractions.retrieve({
id: "crsli_xxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveCourseLessonInteractionsRequest`
-
**requestOptions:** `CourseLessonInteractionsClient.RequestOptions`
client.courseLessons.list({ ...params }) -> core.Page<Whop.CourseLessonListItem, Whop.ListCourseLessonsResponse>
-
#### 📝 Description
-
-
Returns a paginated list of lessons within a course or chapter, ordered by position.
Required permissions:
- `courses:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.courseLessons.list({
first: 42,
last: 42,
course_id: "cors_xxxxxxxxxxxxx",
chapter_id: "chap_xxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.courseLessons.list({
first: 42,
last: 42,
course_id: "cors_xxxxxxxxxxxxx",
chapter_id: "chap_xxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListCourseLessonsRequest`
-
**requestOptions:** `CourseLessonsClient.RequestOptions`
client.courseLessons.create({ ...params }) -> Whop.CourseLesson
-
#### 📝 Description
-
-
Create a new lesson within a course chapter. Lessons can contain video, text, or assessment content.
Required permissions:
- `courses:update`
#### 🔌 Usage
-
-
```typescript
await client.courseLessons.create({
chapter_id: "chap_xxxxxxxxxxxxx",
lesson_type: "text"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateCourseLessonsRequest`
-
**requestOptions:** `CourseLessonsClient.RequestOptions`
client.courseLessons.retrieve({ ...params }) -> Whop.CourseLesson
-
#### 📝 Description
-
-
Retrieves the details of an existing course lesson.
Required permissions:
- `courses:read`
#### 🔌 Usage
-
-
```typescript
await client.courseLessons.retrieve({
id: "lesn_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveCourseLessonsRequest`
-
**requestOptions:** `CourseLessonsClient.RequestOptions`
client.courseLessons.delete({ ...params }) -> boolean
-
#### 📝 Description
-
-
Permanently delete a lesson and remove it from its chapter.
Required permissions:
- `courses:update`
#### 🔌 Usage
-
-
```typescript
await client.courseLessons.delete({
id: "lesn_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteCourseLessonsRequest`
-
**requestOptions:** `CourseLessonsClient.RequestOptions`
client.courseLessons.update({ ...params }) -> Whop.CourseLesson
-
#### 📝 Description
-
-
Update a lesson's content, type, visibility, assessment questions, or media attachments.
Required permissions:
- `courses:update`
#### 🔌 Usage
-
-
```typescript
await client.courseLessons.update({
id: "lesn_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateCourseLessonsRequest`
-
**requestOptions:** `CourseLessonsClient.RequestOptions`
client.courseLessons.markAsCompleted({ ...params }) -> boolean
-
#### 📝 Description
-
-
Mark a lesson as completed for the current user after they finish the content.
#### 🔌 Usage
-
-
```typescript
await client.courseLessons.markAsCompleted({
lesson_id: "lesson_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.MarkAsCompletedCourseLessonsRequest`
-
**requestOptions:** `CourseLessonsClient.RequestOptions`
client.courseLessons.start({ ...params }) -> boolean
-
#### 📝 Description
-
-
Record that the current user has started viewing a lesson, creating progress tracking records.
#### 🔌 Usage
-
-
```typescript
await client.courseLessons.start({
lesson_id: "lesson_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.StartCourseLessonsRequest`
-
**requestOptions:** `CourseLessonsClient.RequestOptions`
client.courseLessons.submitAssessment({ ...params }) -> Whop.SubmitAssessmentCourseLessonsResponse
-
#### 📝 Description
-
-
Submit answers for a quiz or knowledge check lesson and receive a graded result.
#### 🔌 Usage
-
-
```typescript
await client.courseLessons.submitAssessment({
lesson_id: "lesson_id",
answers: [{
question_id: "question_id"
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.SubmitAssessmentCourseLessonsRequest`
-
**requestOptions:** `CourseLessonsClient.RequestOptions`
client.courseStudents.list({ ...params }) -> core.Page<Whop.CourseStudentListItem, Whop.ListCourseStudentsResponse>
-
#### 📝 Description
-
-
Returns a paginated list of students enrolled in a course, with optional name filtering.
Required permissions:
- `courses:read`
- `course_analytics:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.courseStudents.list({
first: 42,
last: 42,
course_id: "cors_xxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.courseStudents.list({
first: 42,
last: 42,
course_id: "cors_xxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListCourseStudentsRequest`
-
**requestOptions:** `CourseStudentsClient.RequestOptions`
client.courseStudents.retrieve({ ...params }) -> Whop.CourseStudent
-
#### 📝 Description
-
-
Retrieves the details of an existing course student.
Required permissions:
- `courses:read`
- `course_analytics:read`
#### 🔌 Usage
-
-
```typescript
await client.courseStudents.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveCourseStudentsRequest`
-
**requestOptions:** `CourseStudentsClient.RequestOptions`
client.courses.list({ ...params }) -> core.Page<Whop.CourseListItem, Whop.ListCoursesResponse>
-
#### 📝 Description
-
-
Returns a paginated list of the courses in an experience or an account. `hidden` courses are included only for callers with `courses:update`.
Required permissions:
- `courses:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.courses.list({
first: 42,
last: 42,
experience_id: "exp_xxxxxxxxxxxxxx",
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.courses.list({
first: 42,
last: 42,
experience_id: "exp_xxxxxxxxxxxxxx",
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListCoursesRequest`
-
**requestOptions:** `CoursesClient.RequestOptions`
client.courses.create({ ...params }) -> Whop.Course
-
#### 📝 Description
-
-
Create a new course within an experience, with optional chapters, lessons, and a certificate.
Required permissions:
- `courses:update`
#### 🔌 Usage
-
-
```typescript
await client.courses.create({
experience_id: "exp_xxxxxxxxxxxxxx",
title: "title"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateCoursesRequest`
-
**requestOptions:** `CoursesClient.RequestOptions`
client.courses.retrieve({ ...params }) -> Whop.Course
-
#### 📝 Description
-
-
Retrieves the details of an existing course. A `hidden` course is returned only to callers with `courses:update`.
Required permissions:
- `courses:read`
#### 🔌 Usage
-
-
```typescript
await client.courses.retrieve({
id: "cors_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveCoursesRequest`
-
**requestOptions:** `CoursesClient.RequestOptions`
client.courses.delete({ ...params }) -> boolean
-
#### 📝 Description
-
-
Permanently delete a course and all of its chapters, lessons, and student progress.
Required permissions:
- `courses:update`
#### 🔌 Usage
-
-
```typescript
await client.courses.delete({
id: "cors_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteCoursesRequest`
-
**requestOptions:** `CoursesClient.RequestOptions`
client.courses.update({ ...params }) -> Whop.Course
-
#### 📝 Description
-
-
Update a course's title, description, visibility, thumbnail, or chapter ordering.
Required permissions:
- `courses:update`
#### 🔌 Usage
-
-
```typescript
await client.courses.update({
id: "cors_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateCoursesRequest`
-
**requestOptions:** `CoursesClient.RequestOptions`
client.deposits.create({ ...params }) -> Whop.CreateDepositsResponse
-
#### 📝 Description
-
-
Returns the deposit methods for an account or user, including crypto addresses, bank transfer instructions, and, for a business, a hosted deposit page. Bitcoin deposits are converted to USDT on Plasma in the destination's wallet. Business destinations require no authentication. Pass `payment_method_id` to also charge a business's saved payment method for `amount` in USD and add it to the business's balance; that requires authentication with the `payment:charge` scope. The charge has no fees or taxes and does not count as revenue.
#### 🔌 Usage
-
-
```typescript
await client.deposits.create({
destination: "biz_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateDepositsRequest`
-
**requestOptions:** `DepositsClient.RequestOptions`
client.deposits.reverse({ ...params }) -> Whop.LedgerActivity
-
#### 📝 Description
-
-
Sends a bank deposit back to the bank account that wired it and takes it back out of the balance. Identify the deposit by its `vbt_` ID, the `source.id` of its row in the account's financial activity. The available balance has to cover the deposit minus the deposit fee, which is refunded. Returns the reversal's own row in the financial activity: a `topup_reversal` debit for the full deposit amount, whose `source` is the bank deposit. The source's `status` is `reversal_in_progress` until the money is back with the sender, then `reversed`.
#### 🔌 Usage
-
-
```typescript
await client.deposits.reverse({
id: "vbt_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ReverseDepositsRequest`
-
**requestOptions:** `DepositsClient.RequestOptions`
client.disputeAlerts.list({ ...params }) -> core.Page<Whop.DisputeAlert, Whop.ListDisputeAlertsResponse>
-
#### 📝 Description
-
-
Lists the dispute alerts and early fraud warnings across the accounts you can read.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.disputeAlerts.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.disputeAlerts.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListDisputeAlertsRequest`
-
**requestOptions:** `DisputeAlertsClient.RequestOptions`
client.disputeAlerts.retrieve({ ...params }) -> Whop.DisputeAlert
-
#### 📝 Description
-
-
Retrieves a single dispute alert or early fraud warning by ID.
#### 🔌 Usage
-
-
```typescript
await client.disputeAlerts.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveDisputeAlertsRequest`
-
**requestOptions:** `DisputeAlertsClient.RequestOptions`
client.disputes.list({ ...params }) -> core.Page<Whop.Dispute, Whop.ListDisputesResponse>
-
#### 📝 Description
-
-
Lists the disputes across the accounts you can read.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.disputes.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.disputes.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListDisputesRequest`
-
**requestOptions:** `DisputesClient.RequestOptions`
client.disputes.summary({ ...params }) -> Whop.SummaryDisputesResponse
-
#### 📝 Description
-
-
Totals up the same disputes the list returns, so you can build status tabs and totals without paging through them.
#### 🔌 Usage
-
-
```typescript
await client.disputes.summary();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.SummaryDisputesRequest`
-
**requestOptions:** `DisputesClient.RequestOptions`
client.disputes.retrieve({ ...params }) -> Whop.Dispute
-
#### 📝 Description
-
-
Retrieves a single dispute.
#### 🔌 Usage
-
-
```typescript
await client.disputes.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveDisputesRequest`
-
**requestOptions:** `DisputesClient.RequestOptions`
client.disputes.update({ ...params }) -> Whop.Dispute
-
#### 📝 Description
-
-
Edits a dispute's evidence while it is still editable. When the evidence is ready, send it to the payment processor with `POST /disputes/:id/submit`.
#### 🔌 Usage
-
-
```typescript
await client.disputes.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateDisputesRequest`
-
**requestOptions:** `DisputesClient.RequestOptions`
client.disputes.accept({ ...params }) -> Whop.Dispute
-
#### 📝 Description
-
-
Accepts a chargeback, conceding it to the customer instead of contesting it. The payment processor closes the dispute as `lost`. This is final — the dispute cannot be contested afterwards. Only a dispute whose `acceptable` is true can be accepted.
#### 🔌 Usage
-
-
```typescript
await client.disputes.accept({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.AcceptDisputesRequest`
-
**requestOptions:** `DisputesClient.RequestOptions`
client.disputes.submit({ ...params }) -> Whop.Dispute
-
#### 📝 Description
-
-
Sends a dispute's evidence to the payment processor. This is final — it cannot be edited or sent again.
#### 🔌 Usage
-
-
```typescript
await client.disputes.submit({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.SubmitDisputesRequest`
-
**requestOptions:** `DisputesClient.RequestOptions`
client.disputes.uploadEvidence({ ...params }) -> Whop.Dispute
-
#### 📝 Description
-
-
Replaces the full set of uploaded evidence documents on a dispute, beyond the four fixed evidence slots. Prefer `PATCH /disputes/:id` with `evidence.documents`, which does the same replace alongside every other evidence field in one call.
#### 🔌 Usage
-
-
```typescript
await client.disputes.uploadEvidence({
id: "id",
documents: [{
document_type: "return_policy"
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UploadEvidenceDisputesRequest`
-
**requestOptions:** `DisputesClient.RequestOptions`
client.dmChannels.list({ ...params }) -> core.Page<Whop.DmChannelListItem, Whop.ListDmChannelsResponse>
-
#### 📝 Description
-
-
Lists the authenticated user's DM channels, most recently active first.
Required permissions:
- `dms:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.dmChannels.list({
first: 42,
last: 42,
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.dmChannels.list({
first: 42,
last: 42,
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListDmChannelsRequest`
-
**requestOptions:** `DmChannelsClient.RequestOptions`
client.dmChannels.create({ ...params }) -> Whop.DmChannel
-
#### 📝 Description
-
-
Creates a DM channel between two or more users, optionally scoped to an account. Returns the existing channel if one already exists.
Required permissions:
- `dms:channel:manage`
#### 🔌 Usage
-
-
```typescript
await client.dmChannels.create({
with_user_ids: ["with_user_ids"]
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateDmChannelsRequest`
-
**requestOptions:** `DmChannelsClient.RequestOptions`
client.dmChannels.retrieve({ ...params }) -> Whop.DmChannel
-
#### 📝 Description
-
-
Retrieves the details of an existing DM channel.
Required permissions (one of):
- `dms:read`
- `support_chat:read`
#### 🔌 Usage
-
-
```typescript
await client.dmChannels.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveDmChannelsRequest`
-
**requestOptions:** `DmChannelsClient.RequestOptions`
client.dmChannels.delete({ ...params }) -> boolean
-
#### 📝 Description
-
-
Permanently deletes a DM channel and all of its messages. Only a channel admin can delete it.
Required permissions (one of):
- `dms:channel:manage`
- `support_chat:create`
#### 🔌 Usage
-
-
```typescript
await client.dmChannels.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteDmChannelsRequest`
-
**requestOptions:** `DmChannelsClient.RequestOptions`
client.dmChannels.update({ ...params }) -> Whop.DmChannel
-
#### 📝 Description
-
-
Updates a DM channel's settings, such as its display name. Only a channel admin can update it.
Required permissions (one of):
- `dms:channel:manage`
- `support_chat:create`
#### 🔌 Usage
-
-
```typescript
await client.dmChannels.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateDmChannelsRequest`
-
**requestOptions:** `DmChannelsClient.RequestOptions`
client.dmMembers.list({ ...params }) -> core.Page<Whop.DmMemberListItem, Whop.ListDmMembersResponse>
-
#### 📝 Description
-
-
Returns a paginated list of members in a specific DM channel, sorted by the date they were added.
Required permissions (one of):
- `dms:read`
- `support_chat:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.dmMembers.list({
first: 42,
last: 42,
channel_id: "channel_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.dmMembers.list({
first: 42,
last: 42,
channel_id: "channel_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListDmMembersRequest`
-
**requestOptions:** `DmMembersClient.RequestOptions`
client.dmMembers.create({ ...params }) -> Whop.DmMember
-
#### 📝 Description
-
-
Add a new user to an existing DM channel. Only an admin of the channel can add members.
Required permissions (one of):
- `dms:message:manage`
- `support_chat:message:create`
#### 🔌 Usage
-
-
```typescript
await client.dmMembers.create({
channel_id: "channel_id",
user_id: "user_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateDmMembersRequest`
-
**requestOptions:** `DmMembersClient.RequestOptions`
client.dmMembers.retrieve({ ...params }) -> Whop.DmMember
-
#### 📝 Description
-
-
Retrieves the details of an existing DM member.
Required permissions (one of):
- `dms:read`
- `support_chat:read`
#### 🔌 Usage
-
-
```typescript
await client.dmMembers.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveDmMembersRequest`
-
**requestOptions:** `DmMembersClient.RequestOptions`
client.dmMembers.delete({ ...params }) -> boolean
-
#### 📝 Description
-
-
Remove a user from a DM channel. An admin can remove any member, and a member can remove themselves.
Required permissions (one of):
- `dms:read`
- `support_chat:read`
#### 🔌 Usage
-
-
```typescript
await client.dmMembers.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteDmMembersRequest`
-
**requestOptions:** `DmMembersClient.RequestOptions`
client.dmMembers.update({ ...params }) -> Whop.DmMember
-
#### 📝 Description
-
-
Update a DM channel member's settings, such as their notification preferences or membership status.
Required permissions (one of):
- `dms:read`
- `support_chat:read`
#### 🔌 Usage
-
-
```typescript
await client.dmMembers.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateDmMembersRequest`
-
**requestOptions:** `DmMembersClient.RequestOptions`
client.domains.list({ ...params }) -> core.Page<Whop.DomainListItem, Whop.ListDomainsResponse>
-
#### 📝 Description
-
-
Lists your domains. Filter by account, app, status, hostname, or the state of a capability.
Pass `search` to find domains to buy instead: the exact domain first, even when taken, then your name on popular extensions, then suggestions. Pass `tlds` to check only the extensions you choose. Results aren't reserved.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.domains.list({
tlds: ["com"]
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.domains.list({
tlds: ["com"]
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListDomainsRequest`
-
**requestOptions:** `DomainsClient.RequestOptions`
client.domains.create({ ...params }) -> Whop.Domain
-
#### 📝 Description
-
-
Adds a domain to your account with the capabilities you want.
Pass `registration` to buy the domain through Whop; it's the default when you pass no capability. Pay its `amount_due` at `purchase_url`, or pass `registration.payment_method_id` to charge a saved card. Whop then registers it, runs its DNS, and renews it every year while `auto_renew` is on.
Pass `registration.auth_code` to transfer in a domain you own at another registrar. The transfer starts once its `amount_due` is paid, or at once when `amount_due` is `null`. While `registration.phase` is `transferring`, its `issues` say what the transfer needs from you.
Pass `verification` to connect a domain you registered elsewhere: its `issues` list the TXT and routing records to publish. Pass `website` with an `app_id` to serve that app on the domain.
To change a domain you already have, update it instead. Adding a domain this account deleted revives it under its original ID.
#### 🔌 Usage
-
-
```typescript
await client.domains.create({
domain: "store.example.com"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateDomainsRequest`
-
**requestOptions:** `DomainsClient.RequestOptions`
client.domains.retrieve({ ...params }) -> Whop.Domain
-
#### 📝 Description
-
-
Retrieves a domain by ID or hostname. Both return the same domain, shown as fully as you can see it: everything for your own accounts, and only who has it and what it serves for anyone else.
A hostname no domain on Whop has comes back with its `availability` instead.
#### 🔌 Usage
-
-
```typescript
await client.domains.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveDomainsRequest`
-
**requestOptions:** `DomainsClient.RequestOptions`
client.domains.delete({ ...params }) -> Whop.Domain
-
#### 📝 Description
-
-
Removes the domain from your account and releases its capabilities in the background. Deleting an unpaid purchase cancels it, and deleting a transfer cancels it and refunds it while the current registrar can still stop it. A registered domain can't be deleted; turn off `auto_renew` and it's released after it expires. Adding the domain to this account again revives it under the same ID.
#### 🔌 Usage
-
-
```typescript
await client.domains.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteDomainsRequest`
-
**requestOptions:** `DomainsClient.RequestOptions`
client.domains.update({ ...params }) -> Whop.Domain
-
#### 📝 Description
-
-
Changes a domain's capabilities or metadata. Pass a capability to add it or change its settings, or `null` to release it; capabilities you leave out don't change. Passing a capability that needs action again retries it. Releasing every capability keeps the domain, `idle`; delete it to remove it.
#### 🔌 Usage
-
-
```typescript
await client.domains.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateDomainsRequest`
-
**requestOptions:** `DomainsClient.RequestOptions`
client.domains.check({ ...params }) -> Whop.Domain
-
#### 📝 Description
-
-
Checks the domain's DNS, payment, and provider state again now instead of at its next scheduled check. Returns the domain as saved; retrieve it again to see the result.
#### 🔌 Usage
-
-
```typescript
await client.domains.check({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CheckDomainsRequest`
-
**requestOptions:** `DomainsClient.RequestOptions`
client.economicIntelligence.list({ ...params }) -> core.Page<Whop.EconomicIntelligence, Whop.ListEconomicIntelligenceResponse>
-
#### 📝 Description
-
-
Lists an account's recommendations and generation requests, newest first by default. When no recommendations are ready or in progress and you have `company:update` permission, listing queues generation, with a ten-minute cooldown after an unsuccessful request; unsuccessful requests are not listed. An account's executed recommendations and runs stay listed after Economic Intelligence turns off, but new recommendations are offered only while it is on. For visitor countries, page views, ad impressions and clicks, or payment volume over a time range, use `GET /stats/time_series/:metric`.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.economicIntelligence.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.economicIntelligence.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListEconomicIntelligenceRequest`
-
**requestOptions:** `EconomicIntelligenceClient.RequestOptions`
client.economicIntelligence.update({ ...params }) -> Whop.EconomicIntelligence
-
#### 📝 Description
-
-
Updates a recommendation status, records feedback, or both. Send `sentiment` to rate it. Include `status: superseded` to retire a ready recommendation and request replacements; a rating alone leaves its status unchanged. To run a recommendation yourself, send `status: running` to start, then `status: executed` when it is carried out (with `result_id` naming what it changed, or `result_page` naming where it worked, so the result links there) or `status: incomplete` if the run ended without carrying it out. Whop AI reports its own runs the same way. Send `status: acknowledged` once an executed run's result has been seen.
#### 🔌 Usage
-
-
```typescript
await client.economicIntelligence.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateEconomicIntelligenceRequest`
-
**requestOptions:** `EconomicIntelligenceClient.RequestOptions`
client.emailAddresses.list({ ...params }) -> core.Page<Whop.EmailAddress, Whop.ListEmailAddressesResponse>
-
#### 📝 Description
-
-
Lists the email addresses of the accounts you can read, and the mailboxes you own. A password is included only for mailboxes you can use.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.emailAddresses.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.emailAddresses.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListEmailAddressesRequest`
-
**requestOptions:** `EmailAddressesClient.RequestOptions`
client.emailAddresses.create({ ...params }) -> Whop.EmailAddress
-
#### 📝 Description
-
-
Creates a mailbox on one of the account's domains. The domain needs the `email` capability turned on. The address can be created and signed in to while email is still setting up, and it can send once email is `ready`. Give it to a team member with `user_id`, or leave it out to share the mailbox with the account. Creating an address this account deleted brings the mailbox back, with its mail and a new password.
#### 🔌 Usage
-
-
```typescript
await client.emailAddresses.create({
address: "marcus@shinetime.example"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateEmailAddressesRequest`
-
**requestOptions:** `EmailAddressesClient.RequestOptions`
client.emailAddresses.retrieve({ ...params }) -> Whop.EmailAddress
-
#### 📝 Description
-
-
Retrieves an email address. Its owner can always retrieve it; anyone else needs `email:read`. The password is included only if you can use the mailbox.
#### 🔌 Usage
-
-
```typescript
await client.emailAddresses.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveEmailAddressesRequest`
-
**requestOptions:** `EmailAddressesClient.RequestOptions`
client.emailAddresses.delete({ ...params }) -> Whop.EmailAddress
-
#### 📝 Description
-
-
Deletes the address. Mail apps signed in to it lose access, and mail sent to it is no longer received. Its mail is kept, and creating the address again in this account brings the mailbox back.
#### 🔌 Usage
-
-
```typescript
await client.emailAddresses.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteEmailAddressesRequest`
-
**requestOptions:** `EmailAddressesClient.RequestOptions`
client.emailAddresses.update({ ...params }) -> Whop.EmailAddress
-
#### 📝 Description
-
-
Gives the mailbox to a team member, or shares it with the account, under a new password. A mailbox that had an owner starts empty, because its earlier mail is private to that owner; mail apps sync it again from the start.
#### 🔌 Usage
-
-
```typescript
await client.emailAddresses.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateEmailAddressesRequest`
-
**requestOptions:** `EmailAddressesClient.RequestOptions`
client.emailAddresses.mobileconfig({ ...params }) -> core.BinaryResponse
-
#### 📝 Description
-
-
Downloads an Apple configuration profile that adds the mailbox to Mail on a Mac, iPhone or iPad, signed in and ready to send. Only the owner can download it for an owned mailbox; a shared one needs `email:read` and `email:send`.
#### 🔌 Usage
-
-
```typescript
await client.emailAddresses.mobileconfig({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.MobileconfigEmailAddressesRequest`
-
**requestOptions:** `EmailAddressesClient.RequestOptions`
client.emailAddresses.resetPassword({ ...params }) -> Whop.EmailAddress
-
#### 📝 Description
-
-
Gives the mailbox a new password. Every mail app signed in with the old one loses access. Only the owner can reset an owned mailbox; a shared one needs `email:read` and `email:send`.
#### 🔌 Usage
-
-
```typescript
await client.emailAddresses.resetPassword({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ResetPasswordEmailAddressesRequest`
-
**requestOptions:** `EmailAddressesClient.RequestOptions`
client.events.list({ ...params }) -> core.Page<Whop.ListEventsResponse.Data.Item, Whop.ListEventsResponse>
-
#### 📝 Description
-
-
Lists identity-linked events, most recent first by default. Pass `identifier` for one person's journey, or omit it to list an account's events within a time range. Events have the same shape as the `POST /events` intake: attribution in `context`, identity in `user`.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.events.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.events.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListEventsRequest`
-
**requestOptions:** `EventsClient.RequestOptions`
client.events.create({ ...params }) -> Whop.CreateEventsResponse
-
#### 📝 Description
-
-
Tracks a conversion or engagement event for an account, such as a lead or a sign-up, so it can be attributed to the ads and links that drove it. Send server-side events with an API key that has `event:create`; the browser pixel calls this without authentication.
#### 🔌 Usage
-
-
```typescript
await client.events.create({
account_id: "biz_xxxxxxxxxxxxxx",
event_name: "coating_deposit_paid"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateEventsRequest`
-
**requestOptions:** `EventsClient.RequestOptions`
client.events.pulse({ ...params }) -> core.Page<Whop.PulseEventsResponse.Data.Item, Whop.PulseEventsResponse>
-
#### 📝 Description
-
-
Returns a fully anonymized feed of recent money movement across Whop, most recent first, such as purchases, card spend, and transfers between accounts. Each item carries only its `type`, a USD amount, a coarse location, and a timestamp coarsened to the minute. The payload is identical for every caller and requires no authentication.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.events.pulse();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.events.pulse();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.PulseEventsRequest`
-
**requestOptions:** `EventsClient.RequestOptions`
client.events.validatePixel({ ...params }) -> Whop.PixelValidation
-
#### 📝 Description
-
-
Checks whether the Whop pixel is installed for an account, or on one page when you pass a `url`. Use it before launching an ad to confirm its destination is tracked, or in a setup flow to tell a merchant whether their install is live.
#### 🔌 Usage
-
-
```typescript
await client.events.validatePixel();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ValidatePixelEventsRequest`
-
**requestOptions:** `EventsClient.RequestOptions`
client.experiences.list({ ...params }) -> core.Page<Whop.ExperienceListItem, Whop.ListExperiencesResponse>
-
#### 📝 Description
-
-
Lists the experiences in an account, optionally filtered to those attached to one product or powered by one app.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.experiences.list({
first: 42,
last: 42,
product_id: "prod_xxxxxxxxxxxxx",
app_id: "app_xxxxxxxxxxxxxx",
created_before: "2023-12-01T05:00:00Z",
created_after: "2023-12-01T05:00:00Z",
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.experiences.list({
first: 42,
last: 42,
product_id: "prod_xxxxxxxxxxxxx",
app_id: "app_xxxxxxxxxxxxxx",
created_before: "2023-12-01T05:00:00Z",
created_after: "2023-12-01T05:00:00Z",
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListExperiencesRequest`
-
**requestOptions:** `ExperiencesClient.RequestOptions`
client.experiences.create({ ...params }) -> Whop.Experience
-
#### 📝 Description
-
-
Creates an experience for an account, powered by an app such as courses, forums, or chat. Attach it to a product with `POST /experiences/:id/attach` to give that product's customers access.
Required permissions:
- `experience:create`
#### 🔌 Usage
-
-
```typescript
await client.experiences.create({
account_id: "biz_xxxxxxxxxxxxxx",
app_id: "app_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateExperiencesRequest`
-
**requestOptions:** `ExperiencesClient.RequestOptions`
client.experiences.retrieve({ ...params }) -> Whop.Experience
-
#### 📝 Description
-
-
Retrieves the details of an existing experience.
#### 🔌 Usage
-
-
```typescript
await client.experiences.retrieve({
id: "exp_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveExperiencesRequest`
-
**requestOptions:** `ExperiencesClient.RequestOptions`
client.experiences.delete({ ...params }) -> boolean
-
#### 📝 Description
-
-
Deletes an experience and detaches it from every product, removing customer access to it. Returns `true` on success.
Required permissions:
- `experience:delete`
#### 🔌 Usage
-
-
```typescript
await client.experiences.delete({
id: "exp_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteExperiencesRequest`
-
**requestOptions:** `ExperiencesClient.RequestOptions`
client.experiences.update({ ...params }) -> Whop.Experience
-
#### 📝 Description
-
-
Updates an experience's name, logo, visibility, or notification setting, or moves it to another section or position.
Required permissions:
- `experience:update`
#### 🔌 Usage
-
-
```typescript
await client.experiences.update({
id: "exp_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateExperiencesRequest`
-
**requestOptions:** `ExperiencesClient.RequestOptions`
client.experiences.attach({ ...params }) -> Whop.Experience
-
#### 📝 Description
-
-
Attaches an experience to a product, giving the product's customers access to it.
Required permissions:
- `experience:attach`
#### 🔌 Usage
-
-
```typescript
await client.experiences.attach({
id: "exp_xxxxxxxxxxxxxx",
product_id: "prod_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.AttachExperiencesRequest`
-
**requestOptions:** `ExperiencesClient.RequestOptions`
client.experiences.detach({ ...params }) -> Whop.Experience
-
#### 📝 Description
-
-
Detaches an experience from a product, removing customer access to it through that product.
Required permissions:
- `experience:detach`
#### 🔌 Usage
-
-
```typescript
await client.experiences.detach({
id: "exp_xxxxxxxxxxxxxx",
product_id: "prod_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DetachExperiencesRequest`
-
**requestOptions:** `ExperiencesClient.RequestOptions`
client.experiences.duplicate({ ...params }) -> Whop.Experience
-
#### 📝 Description
-
-
Duplicates an experience and attaches the copy to the same products as the original. Forum and chat copies keep the original's settings, such as who can post or comment. No content, such as posts, messages, or lessons, is copied.
Required permissions:
- `experience:create`
#### 🔌 Usage
-
-
```typescript
await client.experiences.duplicate({
id: "exp_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DuplicateExperiencesRequest`
-
**requestOptions:** `ExperiencesClient.RequestOptions`
client.experiments.list({ ...params }) -> core.Page<Whop.Experiment, Whop.ListExperimentsResponse>
-
#### 📝 Description
-
-
Lists the experiments and feature flags owned by an account. Requires `experiment:read` on the account.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.experiments.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.experiments.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListExperimentsRequest`
-
**requestOptions:** `ExperimentsClient.RequestOptions`
client.experiments.create({ ...params }) -> Whop.Experiment
-
#### 📝 Description
-
-
Creates an experiment or feature flag in `draft` status for an account. Nothing is served until you activate it with `POST /experiments/:id/activate`. Requires `experiment:manage` on the account.
#### 🔌 Usage
-
-
```typescript
await client.experiments.create({
account_id: "biz_xxxxxxxxxxxxxx",
flag_key: "checkout_redesign_v2"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateExperimentsRequest`
-
**requestOptions:** `ExperimentsClient.RequestOptions`
client.experiments.exposures({ ...params }) -> Whop.ExposuresExperimentsResponse
-
#### 📝 Description
-
-
Evaluates experiments and feature flags for a subject and records an exposure. Pass `flag_key` to evaluate one flag, or omit it to evaluate every active flag in the account and related resource scope. Requires no authentication; when a credential resolves, its authentication method, API key ID, and signed-in user ID are recorded on the exposure event.
#### 🔌 Usage
-
-
```typescript
await client.experiments.exposures();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ExposuresExperimentsRequest`
-
**requestOptions:** `ExperimentsClient.RequestOptions`
client.experiments.retrieve({ ...params }) -> Whop.Experiment
-
#### 📝 Description
-
-
Retrieves an experiment or feature flag by its `expt_` ID or `flag_key` handle. Requires `experiment:read` on the owning account.
#### 🔌 Usage
-
-
```typescript
await client.experiments.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveExperimentsRequest`
-
**requestOptions:** `ExperimentsClient.RequestOptions`
client.experiments.update({ ...params }) -> Whop.Experiment
-
#### 📝 Description
-
-
Updates the targeting rules, treatment allocation, or hypothesis of an existing experiment or feature flag. To change its lifecycle, use the `activate`, `pause`, and `end` endpoints instead. Requires `experiment:manage` on the owning account.
#### 🔌 Usage
-
-
```typescript
await client.experiments.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateExperimentsRequest`
-
**requestOptions:** `ExperimentsClient.RequestOptions`
client.experiments.activate({ ...params }) -> Whop.Experiment
-
#### 📝 Description
-
-
Starts (or resumes) an experiment or feature flag so evaluation begins serving it. Activating a draft stamps `started_at`; resuming a paused experiment keeps the original start. Only drafts and paused experiments can be activated. Requires `experiment:manage` on the owning account.
#### 🔌 Usage
-
-
```typescript
await client.experiments.activate({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ActivateExperimentsRequest`
-
**requestOptions:** `ExperimentsClient.RequestOptions`
client.experiments.end({ ...params }) -> Whop.Experiment
-
#### 📝 Description
-
-
Concludes the experiment and records required `findings`. Pass `winning_arm` to serve the winning treatment to everyone; omit it when control won. Ended experiments cannot restart, but may be ended again to correct the winner. Requires `experiment:manage` on the owning account.
#### 🔌 Usage
-
-
```typescript
await client.experiments.end({
id: "id",
findings: "Treatment lifted signups 12%, shipping it to everyone."
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.EndExperimentsRequest`
-
**requestOptions:** `ExperimentsClient.RequestOptions`
client.experiments.pause({ ...params }) -> Whop.Experiment
-
#### 📝 Description
-
-
Pauses an active experiment or feature flag: evaluation stops serving it and exposures stop flowing. Assignments are keyed on stable identity, so users return to their original arm when the experiment resumes. Requires `experiment:manage` on the owning account.
#### 🔌 Usage
-
-
```typescript
await client.experiments.pause({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.PauseExperimentsRequest`
-
**requestOptions:** `ExperimentsClient.RequestOptions`
client.exports.list({ ...params }) -> Whop.ListExportsResponse
-
#### 📝 Description
-
-
Lists the exports requested for an account, newest first. Only exports of resources the credential is allowed to export are returned.
#### 🔌 Usage
-
-
```typescript
await client.exports.list();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListExportsRequest`
-
**requestOptions:** `ExportsClient.RequestOptions`
client.exports.create({ ...params }) -> Whop.Export
-
#### 📝 Description
-
-
Starts an asynchronous export of a resource for an account. Returns the export in `pending`; poll `GET /exports/:id` until `download_url` is set.
#### 🔌 Usage
-
-
```typescript
await client.exports.create({
resource: "ad_campaigns"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateExportsRequest`
-
**requestOptions:** `ExportsClient.RequestOptions`
client.exports.retrieve({ ...params }) -> Whop.Export
-
#### 📝 Description
-
-
Fetches an export's status and, once complete, its download link.
#### 🔌 Usage
-
-
```typescript
await client.exports.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveExportsRequest`
-
**requestOptions:** `ExportsClient.RequestOptions`
client.externalAccounts.list({ ...params }) -> core.Page<Whop.ExternalAccount, Whop.ListExternalAccountsResponse>
-
#### 📝 Description
-
-
Lists the external accounts linked to an account or user.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.externalAccounts.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.externalAccounts.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListExternalAccountsRequest`
-
**requestOptions:** `ExternalAccountsClient.RequestOptions`
client.externalAccounts.create({ ...params }) -> Whop.ExternalAccount
-
#### 📝 Description
-
-
Creates or returns a Whop-managed Facebook page or TikTok account for an account, or connects the account's existing Klaviyo account with a private API key.
#### 🔌 Usage
-
-
```typescript
await client.externalAccounts.create({
platform: "facebook"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateExternalAccountsRequest`
-
**requestOptions:** `ExternalAccountsClient.RequestOptions`
client.externalAccounts.connect({ ...params }) -> Whop.ConnectExternalAccountsResponse
-
#### 📝 Description
-
-
Starts an OAuth connection flow and returns an `authorize_url` to send the user to, where they connect an external account. Personal profile connections must be completed in a browser signed in as the Whop user who started the flow.
#### 🔌 Usage
-
-
```typescript
await client.externalAccounts.connect({
platform: "meta_business",
redirect_url: "https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/ads/settings"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ConnectExternalAccountsRequest`
-
**requestOptions:** `ExternalAccountsClient.RequestOptions`
client.externalAccounts.delete({ ...params }) -> Whop.DeleteExternalAccountsResponse
-
#### 📝 Description
-
-
Disconnects an external account from an account or user without deleting the underlying platform account.
#### 🔌 Usage
-
-
```typescript
await client.externalAccounts.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteExternalAccountsRequest`
-
**requestOptions:** `ExternalAccountsClient.RequestOptions`
client.externalAccounts.refresh({ ...params }) -> Whop.ExternalAccount
-
#### 📝 Description
-
-
Refreshes the state of an external account. Use it to clear an `error` that has been resolved.
#### 🔌 Usage
-
-
```typescript
await client.externalAccounts.refresh({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RefreshExternalAccountsRequest`
-
**requestOptions:** `ExternalAccountsClient.RequestOptions`
client.feeMarkups.list({ ...params }) -> core.Page<Whop.FeeMarkupListItem, Whop.ListFeeMarkupsResponse>
-
#### 📝 Description
-
-
Lists the fee markups configured for an account. For a platform account, returns the platform's default markups.
Required permissions:
- `company:update_child_fees`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.feeMarkups.list({
first: 42,
last: 42,
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.feeMarkups.list({
first: 42,
last: 42,
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListFeeMarkupsRequest`
-
**requestOptions:** `FeeMarkupsClient.RequestOptions`
client.feeMarkups.create({ ...params }) -> Whop.FeeMarkup
-
#### 📝 Description
-
-
Creates or updates an account's markup for one fee type. If the account already has a markup for that `fee_type`, it is updated with the new values.
Required permissions:
- `company:update_child_fees`
#### 🔌 Usage
-
-
```typescript
await client.feeMarkups.create({
account_id: "biz_xxxxxxxxxxxxxx",
fee_type: "crypto_withdrawal_markup"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateFeeMarkupsRequest`
-
**requestOptions:** `FeeMarkupsClient.RequestOptions`
client.feeMarkups.delete({ ...params }) -> boolean
-
#### 📝 Description
-
-
Deletes a fee markup, removing the custom fee override so the account reverts to its parent account's default fees.
Required permissions:
- `company:update_child_fees`
#### 🔌 Usage
-
-
```typescript
await client.feeMarkups.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteFeeMarkupsRequest`
-
**requestOptions:** `FeeMarkupsClient.RequestOptions`
client.feedbackSubmissions.create({ ...params }) -> Whop.CreateFeedbackSubmissionsResponse
-
#### 📝 Description
-
-
Submits an issue or an unanswered question to Whop for review, recorded under the authenticated user, account, or app. Returns a receipt once the submission is accepted; processing is asynchronous and no reply is sent.
#### 🔌 Usage
-
-
```typescript
await client.feedbackSubmissions.create({
content: "The docs omit the required permission",
source: "mcp_report_feedback"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateFeedbackSubmissionsRequest`
-
**requestOptions:** `FeedbackSubmissionsClient.RequestOptions`
client.files.list({ ...params }) -> core.Page<Whop.File_, Whop.ListFilesResponse>
-
#### 📝 Description
-
-
Returns the files with the given IDs, newest first — fetch a batch in one request instead of retrieving each file individually. Only files you created are returned; IDs that do not exist, or that another credential created, are omitted. For a batch larger than one page, follow `page_info` with the same `file_ids` to walk the rest.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.files.list({
file_ids: ["file_xxxxxxxxxxxxx"]
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.files.list({
file_ids: ["file_xxxxxxxxxxxxx"]
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListFilesRequest`
-
**requestOptions:** `FilesClient.RequestOptions`
client.files.create({ ...params }) -> Whop.File_
-
#### 📝 Description
-
-
Creates a file and returns a presigned destination to upload its bytes to. PUT the bytes to `upload_url` (single-part), or to each of `multipart_upload_urls` and then call Complete File Multipart Upload. Once the bytes land the file becomes `ready`, and its ID can be attached wherever a file is accepted — account legal documents, dispute evidence documents. For a step-by-step walkthrough of single-part and multipart uploads, see the [direct file uploads guide](/developer/guides/direct-file-uploads).
#### 🔌 Usage
-
-
```typescript
await client.files.create({
filename: "terms.pdf"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateFilesRequest`
-
**requestOptions:** `FilesClient.RequestOptions`
client.files.retrieve({ ...params }) -> Whop.File_
-
#### 📝 Description
-
-
Retrieves a file you uploaded — poll it after uploading the bytes to see `upload_status` become `ready`. Only the creator can retrieve a file this way; a file attached to another resource is read through that resource.
#### 🔌 Usage
-
-
```typescript
await client.files.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveFilesRequest`
-
**requestOptions:** `FilesClient.RequestOptions`
client.files.complete({ ...params }) -> Whop.File_
-
#### 📝 Description
-
-
Assembles the parts of a multipart upload after every part has been PUT to its presigned URL. Pass the `multipart_upload_id` from Create File and each part's `ETag` response header. For a step-by-step walkthrough of multipart uploads, see the [direct file uploads guide](/developer/guides/direct-file-uploads).
#### 🔌 Usage
-
-
```typescript
await client.files.complete({
id: "id",
multipart_parts: [{
etag: "etag-1",
part_number: 1
}],
multipart_upload_id: "upload-id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CompleteFilesRequest`
-
**requestOptions:** `FilesClient.RequestOptions`
client.financialActivity.list({ ...params }) -> Whop.ListFinancialActivityResponse
-
#### 📝 Description
-
-
Returns an account's or user's activity feed: every movement of money in or out.
#### 🔌 Usage
-
-
```typescript
await client.financialActivity.list();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListFinancialActivityRequest`
-
**requestOptions:** `FinancialActivityClient.RequestOptions`
client.financialReports.retrieve({ ...params }) -> Whop.RetrieveFinancialReportsResponse
-
#### 📝 Description
-
-
Returns a financial report — balance activity, income statement, or balance summary — for an account over a date range.
#### 🔌 Usage
-
-
```typescript
await client.financialReports.retrieve({
account_id: "account_id",
report_type: "balance_summary"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveFinancialReportsRequest`
-
**requestOptions:** `FinancialReportsClient.RequestOptions`
client.financingApplications.list({ ...params }) -> core.Page<Whop.FinancingApplication, Whop.ListFinancingApplicationsResponse>
-
#### 📝 Description
-
-
Lists payment-financing applications. Without `account_id`, an account credential lists its own account and its direct connected accounts, but not deeper descendants, and a user credential lists every account it can read applications for.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.financingApplications.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.financingApplications.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListFinancingApplicationsRequest`
-
**requestOptions:** `FinancingApplicationsClient.RequestOptions`
client.financingApplications.create({ ...params }) -> Whop.FinancingApplication
-
#### 📝 Description
-
-
Starts an application for payment-financing approval, or returns the account's open one: an application in `awaiting_review` takes precedence over one in `requires_collection`, and the open application is reused across different `Idempotency-Key` values. Creating an application does not submit it for review. The account must have a Whop balance set up, and accounts in restricted industries cannot apply. Once an application closes, the account can apply again.
#### 🔌 Usage
-
-
```typescript
await client.financingApplications.create();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateFinancingApplicationsRequest`
-
**requestOptions:** `FinancingApplicationsClient.RequestOptions`
client.financingApplications.retrieve({ ...params }) -> Whop.FinancingApplication
-
#### 📝 Description
-
-
Retrieves a payment-financing application with its review state, requirements, saved answers, documents, current terms, and review feedback. Requires read access to the account that owns it.
#### 🔌 Usage
-
-
```typescript
await client.financingApplications.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveFinancingApplicationsRequest`
-
**requestOptions:** `FinancingApplicationsClient.RequestOptions`
client.financingApplications.update({ ...params }) -> Whop.FinancingApplication
-
#### 📝 Description
-
-
Saves merchant answers to an application in `requires_collection`. The batch is atomic: if any answer is rejected, none are saved. Omitted requirements and answer fields are left unchanged. Saving answers does not submit the application; call Submit Financing Application when it is complete.
#### 🔌 Usage
-
-
```typescript
await client.financingApplications.update({
id: "id",
answers: [{
requirement_id: "inrqi_xxxxxxxxxxxxxx"
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateFinancingApplicationsRequest`
-
**requestOptions:** `FinancingApplicationsClient.RequestOptions`
client.financingApplications.submit({ ...params }) -> Whop.FinancingApplication
-
#### 📝 Description
-
-
Submits a complete application for financing review, recording the merchant's acceptance, who submitted, and when, then moving it to `awaiting_review`. Before calling, present the application's `terms.content`, policies, and disclosure to the merchant and collect affirmative acceptance; every resubmission needs acceptance again. Only an application in `requires_collection` can be submitted, including after a reviewer requests more information. Retry with the same `Idempotency-Key`: submitting an application already in review without a replay returns an error. Approval does not by itself enable financing payment methods.
#### 🔌 Usage
-
-
```typescript
await client.financingApplications.submit({
id: "id",
merchant_acceptance: {
accepted: true,
terms_version: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.SubmitFinancingApplicationsRequest`
-
**requestOptions:** `FinancingApplicationsClient.RequestOptions`
client.forumPosts.list({ ...params }) -> core.Page<Whop.ForumPostListItem, Whop.ListForumPostsResponse>
-
#### 📝 Description
-
-
Returns a paginated list of forum posts within a specific experience, with optional filtering by parent post or pinned status.
Required permissions:
- `forum:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.forumPosts.list({
first: 42,
last: 42,
experience_id: "exp_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.forumPosts.list({
first: 42,
last: 42,
experience_id: "exp_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListForumPostsRequest`
-
**requestOptions:** `ForumPostsClient.RequestOptions`
client.forumPosts.create({ ...params }) -> Whop.ForumPost
-
#### 📝 Description
-
-
Create a new forum post or comment within an experience. Supports text content, attachments, polls, paywalling, and pinning.
Required permissions:
- `forum:post:create`
#### 🔌 Usage
-
-
```typescript
await client.forumPosts.create({
experience_id: "exp_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateForumPostsRequest`
-
**requestOptions:** `ForumPostsClient.RequestOptions`
client.forumPosts.retrieve({ ...params }) -> Whop.ForumPost
-
#### 📝 Description
-
-
Retrieves the details of an existing forum post.
Required permissions:
- `forum:read`
#### 🔌 Usage
-
-
```typescript
await client.forumPosts.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveForumPostsRequest`
-
**requestOptions:** `ForumPostsClient.RequestOptions`
client.forumPosts.update({ ...params }) -> Whop.ForumPost
-
#### 📝 Description
-
-
Edit the content, attachments, pinned status, or visibility of an existing forum post or comment.
#### 🔌 Usage
-
-
```typescript
await client.forumPosts.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateForumPostsRequest`
-
**requestOptions:** `ForumPostsClient.RequestOptions`
client.forums.list({ ...params }) -> core.Page<Whop.ForumListItem, Whop.ListForumsResponse>
-
#### 📝 Description
-
-
Returns a paginated list of forums for an account, with optional filtering by product.
Required permissions:
- `forum:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.forums.list({
first: 42,
last: 42,
product_id: "prod_xxxxxxxxxxxxx",
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.forums.list({
first: 42,
last: 42,
product_id: "prod_xxxxxxxxxxxxx",
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListForumsRequest`
-
**requestOptions:** `ForumsClient.RequestOptions`
client.forums.retrieve({ ...params }) -> Whop.Forum
-
#### 📝 Description
-
-
Retrieves the details of an existing forum.
Required permissions:
- `forum:read`
#### 🔌 Usage
-
-
```typescript
await client.forums.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveForumsRequest`
-
**requestOptions:** `ForumsClient.RequestOptions`
client.forums.update({ ...params }) -> Whop.Forum
-
#### 📝 Description
-
-
Update moderation and notification settings for a forum, such as who can post, who can comment, and email notification preferences.
Required permissions:
- `forum:moderate`
#### 🔌 Usage
-
-
```typescript
await client.forums.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateForumsRequest`
-
**requestOptions:** `ForumsClient.RequestOptions`
client.identityProfiles.listIdentityProfile({ ...params }) -> core.Page<Whop.IdentityProfileListItem, Whop.ListIdentityProfileResponse>
-
#### 📝 Description
-
-
Lists the identity profiles currently linked to an account, or to every account you can read when `account_id` is omitted.
Required permissions:
- `identity:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.identityProfiles.listIdentityProfile({
first: 42,
last: 42,
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.identityProfiles.listIdentityProfile({
first: 42,
last: 42,
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListIdentityProfileRequest`
-
**requestOptions:** `IdentityProfilesClient.RequestOptions`
client.identityProfiles.retrieveIdentityProfile({ ...params }) -> Whop.IdentityProfile
-
#### 📝 Description
-
-
Retrieves the details of an existing identity profile.
Required permissions:
- `identity:read`
#### 🔌 Usage
-
-
```typescript
await client.identityProfiles.retrieveIdentityProfile({
id: "idpf_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveIdentityProfileRequest`
-
**requestOptions:** `IdentityProfilesClient.RequestOptions`
client.identityProfiles.unlinkIdentityProfile({ ...params }) -> Whop.IdentityProfile
-
#### 📝 Description
-
-
Unlinks an identity profile from the account or user that owns `ledger_account_id`. Requires `identity:write` on that account or user.
Required permissions:
- `identity:write`
#### 🔌 Usage
-
-
```typescript
await client.identityProfiles.unlinkIdentityProfile({
id: "idpf_xxxxxxxxxxxxx",
ledger_account_id: "ldgr_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UnlinkIdentityProfileRequest`
-
**requestOptions:** `IdentityProfilesClient.RequestOptions`
client.identityProfiles.listVerificationsIdentityProfile({ ...params }) -> core.Page<Whop.ListVerificationsIdentityProfileResponse.Data.Item, Whop.ListVerificationsIdentityProfileResponse>
-
#### 📝 Description
-
-
Returns a list of verifications attached to an identity profile, ordered by most recent first.
Required permissions:
- `identity:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.identityProfiles.listVerificationsIdentityProfile({
id: "idpf_xxxxxxxxxxxxx",
first: 42,
last: 42
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.identityProfiles.listVerificationsIdentityProfile({
id: "idpf_xxxxxxxxxxxxx",
first: 42,
last: 42
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListVerificationsIdentityProfileRequest`
-
**requestOptions:** `IdentityProfilesClient.RequestOptions`
client.invoices.list({ ...params }) -> core.Page<Whop.Invoice, Whop.ListInvoicesResponse>
-
#### 📝 Description
-
-
Lists receipt-backed invoices for accounts the caller can read. Legacy invoices are excluded.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.invoices.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.invoices.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListInvoicesRequest`
-
**requestOptions:** `InvoicesClient.RequestOptions`
client.invoices.create({ ...params }) -> Whop.Invoice
-
#### 📝 Description
-
-
Creates a draft invoice backed by a receipt, with saved items, quantities, prices, and recipients. Issue the draft to resolve final tax and open the invoice. The pay_ ID stays the same when paid.
#### 🔌 Usage
-
-
```typescript
await client.invoices.create({
account_id: "biz_xxxxxxxxxxxxxx",
items: []
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateInvoicesRequest`
-
**requestOptions:** `InvoicesClient.RequestOptions`
client.invoices.retrieve({ ...params }) -> Whop.Invoice
-
#### 📝 Description
-
-
Retrieves a receipt-backed invoice by its pay_ ID.
#### 🔌 Usage
-
-
```typescript
await client.invoices.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveInvoicesRequest`
-
**requestOptions:** `InvoicesClient.RequestOptions`
client.invoices.update({ ...params }) -> Whop.Invoice
-
#### 📝 Description
-
-
Updates draft invoice items and billing fields. Recipient-only updates are also allowed on unpaid invoices. Edit customer contact details through the member API.
#### 🔌 Usage
-
-
```typescript
await client.invoices.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateInvoicesRequest`
-
**requestOptions:** `InvoicesClient.RequestOptions`
client.invoices.generatePdf({ ...params }) -> Whop.InvoicePdf
-
#### 📝 Description
-
-
Generates the invoice as a PDF and returns a short-lived link to download it. A draft shows its estimated totals. The buyer's name and email need `member:basic:read` and `member:email:read`, and the Pay now link on an open invoice needs `payment:charge`. Each call generates a new file and link, so this endpoint does not replay `Idempotency-Key` responses.
#### 🔌 Usage
-
-
```typescript
await client.invoices.generatePdf({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.GeneratePdfInvoicesRequest`
-
**requestOptions:** `InvoicesClient.RequestOptions`
client.invoices.issue({ ...params }) -> Whop.Invoice
-
#### 📝 Description
-
-
Resolves final tax and opens a draft invoice without emailing it. An invoice with a `payment_method_id` is charged to it off-session, as `POST /payments` charges a saved payment method: at `charge_at` if given, otherwise on `due_at` while it is still ahead, otherwise right away (see `scheduled_charge_at`). With a future `due_at` and no `charge_at`, the customer is charged on the due date without being emailed first. Issuing an open invoice again retains its totals and charges nothing.
#### 🔌 Usage
-
-
```typescript
await client.invoices.issue({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.IssueInvoicesRequest`
-
**requestOptions:** `InvoicesClient.RequestOptions`
client.invoices.markUncollectible({ ...params }) -> Whop.Invoice
-
#### 📝 Description
-
-
Marks an open invoice as uncollectible. Its checkout link stops working.
#### 🔌 Usage
-
-
```typescript
await client.invoices.markUncollectible({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.MarkUncollectibleInvoicesRequest`
-
**requestOptions:** `InvoicesClient.RequestOptions`
client.invoices.send({ ...params }) -> Whop.Invoice
-
#### 📝 Description
-
-
Issues a draft and emails it to its recipients, with reminders after the due date. A draft with a `payment_method_id` needs `payment:charge`: with a `charge_at`, or when its `due_at` is still ahead, it is emailed now and charged to that method at that time (see `scheduled_charge_at`); otherwise it is charged right away instead of emailed. Voiding the invoice, marking it uncollectible, or paying it first cancels the scheduled charge, and its recipients get the payment link if a charge fails. Sending an open invoice emails it again, up to three emails a day including the first send. With `send_at`, the draft is sent at that time instead, and cannot be edited, except its recipients, until it is sent or unscheduled. Each email, reminders included, is sent separately to the customer email shown on the invoice and to each address in `recipient_emails`, so recipients never see each other's addresses.
#### 🔌 Usage
-
-
```typescript
await client.invoices.send({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.SendInvoicesRequest`
-
**requestOptions:** `InvoicesClient.RequestOptions`
client.invoices.unschedule({ ...params }) -> Whop.Invoice
-
#### 📝 Description
-
-
Cancels a draft's scheduled send, so it can be edited again. An invoice with no scheduled send is returned unchanged.
#### 🔌 Usage
-
-
```typescript
await client.invoices.unschedule({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UnscheduleInvoicesRequest`
-
**requestOptions:** `InvoicesClient.RequestOptions`
client.invoices.void({ ...params }) -> Whop.Invoice
-
#### 📝 Description
-
-
Voids a draft or unpaid invoice.
#### 🔌 Usage
-
-
```typescript
await client.invoices.void({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.VoidInvoicesRequest`
-
**requestOptions:** `InvoicesClient.RequestOptions`
client.leads.list({ ...params }) -> core.Page<Whop.LeadListItem, Whop.ListLeadsResponse>
-
#### 📝 Description
-
-
Lists an account's leads, newest first.
Required permissions:
- `lead:basic:read`
- `member:email:read`
- `access_pass:basic:read`
- `member:basic:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.leads.list({
first: 42,
last: 42,
created_after: "2023-12-01T05:00:00Z",
created_before: "2023-12-01T05:00:00Z",
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.leads.list({
first: 42,
last: 42,
created_after: "2023-12-01T05:00:00Z",
created_before: "2023-12-01T05:00:00Z",
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListLeadsRequest`
-
**requestOptions:** `LeadsClient.RequestOptions`
client.leads.create({ ...params }) -> Whop.Lead
-
#### 📝 Description
-
-
Records a lead: a potential customer's interest in an account or one of its products.
Required permissions:
- `lead:manage`
- `member:email:read`
- `access_pass:basic:read`
- `member:basic:read`
#### 🔌 Usage
-
-
```typescript
await client.leads.create({
account_id: "biz_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateLeadsRequest`
-
**requestOptions:** `LeadsClient.RequestOptions`
client.leads.retrieve({ ...params }) -> Whop.Lead
-
#### 📝 Description
-
-
Retrieves the details of an existing lead.
Required permissions:
- `lead:basic:read`
- `member:email:read`
- `access_pass:basic:read`
- `member:basic:read`
#### 🔌 Usage
-
-
```typescript
await client.leads.retrieve({
id: "lead_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveLeadsRequest`
-
**requestOptions:** `LeadsClient.RequestOptions`
client.leads.update({ ...params }) -> Whop.Lead
-
#### 📝 Description
-
-
Updates a lead's `metadata` or `referrer`.
Required permissions:
- `lead:manage`
- `member:email:read`
- `access_pass:basic:read`
- `member:basic:read`
#### 🔌 Usage
-
-
```typescript
await client.leads.update({
id: "lead_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateLeadsRequest`
-
**requestOptions:** `LeadsClient.RequestOptions`
client.ledgerAccounts.retrieve({ ...params }) -> Whop.LedgerAccount
-
#### 📝 Description
-
-
Retrieves the details of an existing ledger account.
Required permissions:
- `company:balance:read`
- `payout:account:read`
#### 🔌 Usage
-
-
```typescript
await client.ledgerAccounts.retrieve({
id: "ldgr_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveLedgerAccountsRequest`
-
**requestOptions:** `LedgerAccountsClient.RequestOptions`
client.livestreams.list({ ...params }) -> core.Page<Whop.Livestream, Whop.ListLivestreamsResponse>
-
#### 📝 Description
-
-
Lists the livestreams in an experience, live and ended, newest first.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.livestreams.list({
experience_id: "experience_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.livestreams.list({
experience_id: "experience_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListLivestreamsRequest`
-
**requestOptions:** `LivestreamsClient.RequestOptions`
client.livestreams.retrieve({ ...params }) -> Whop.Livestream
-
#### 📝 Description
-
-
Retrieves a livestream by ID.
#### 🔌 Usage
-
-
```typescript
await client.livestreams.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveLivestreamsRequest`
-
**requestOptions:** `LivestreamsClient.RequestOptions`
client.livestreams.pin({ ...params }) -> Whop.Livestream
-
#### 📝 Description
-
-
Pins an ended livestream's recording so everyone in the experience sees it featured. Pinning it again keeps the original `pinned_at`.
#### 🔌 Usage
-
-
```typescript
await client.livestreams.pin({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.PinLivestreamsRequest`
-
**requestOptions:** `LivestreamsClient.RequestOptions`
client.livestreams.unpin({ ...params }) -> Whop.Livestream
-
#### 📝 Description
-
-
Unpins a livestream's recording so it is no longer featured in the experience.
#### 🔌 Usage
-
-
```typescript
await client.livestreams.unpin({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UnpinLivestreamsRequest`
-
**requestOptions:** `LivestreamsClient.RequestOptions`
client.media.generate({ ...params }) -> Whop.MediaAsset
-
#### 📝 Description
-
-
Starts an AI media generation job billed from the account's balance. Generation is asynchronous — poll `GET /media/{id}` until the asset is `ready`, then use `file.id` anywhere attachments are accepted.
#### 🔌 Usage
-
-
```typescript
await client.media.generate({
prompt: "A 9:16 product showcase of a cordless power scrubber",
type: "video"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.GenerateMediaRequest`
-
**requestOptions:** `MediaClient.RequestOptions`
client.media.retrieve({ ...params }) -> Whop.MediaAsset
-
#### 📝 Description
-
-
Retrieves a media asset by ID. Poll this while the asset is `processing`.
#### 🔌 Usage
-
-
```typescript
await client.media.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveMediaRequest`
-
**requestOptions:** `MediaClient.RequestOptions`
client.members.list({ ...params }) -> core.Page<Whop.Member, Whop.ListMembersResponse>
-
#### 📝 Description
-
-
Lists the members of an account. A member is one buyer's relationship with the account, regardless of how many memberships they hold.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.members.list({
user_ids: ["user_xxxxxxxxxxxxxx"],
product_ids: ["prod_xxxxxxxxxxxxx"],
variant_ids: ["plan_xxxxxxxxxxxxx"],
promo_code_ids: ["promo_xxxxxxxxxxxx"]
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.members.list({
user_ids: ["user_xxxxxxxxxxxxxx"],
product_ids: ["prod_xxxxxxxxxxxxx"],
variant_ids: ["plan_xxxxxxxxxxxxx"],
promo_code_ids: ["promo_xxxxxxxxxxxx"]
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListMembersRequest`
-
**requestOptions:** `MembersClient.RequestOptions`
client.members.retrieve({ ...params }) -> Whop.Member
-
#### 📝 Description
-
-
Retrieves a member by ID. Accessible to the account and to the member's own user.
#### 🔌 Usage
-
-
```typescript
await client.members.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveMembersRequest`
-
**requestOptions:** `MembersClient.RequestOptions`
client.memberships.list({ ...params }) -> core.Page<Whop.Membership, Whop.ListMembershipsResponse>
-
#### 📝 Description
-
-
Lists every membership the caller can read: an account API key its account's; a user credential their own plus those of every account they manage. `account_id` and `user_id` only narrow that list — values outside the caller's reach return fewer results, not an error.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.memberships.list({
external_account: "discord_123456789012345678",
product_ids: ["prod_xxxxxxxxxxxxx"],
variant_ids: ["plan_xxxxxxxxxxxxx"],
promo_code_ids: ["promo_xxxxxxxxxxxxxx"]
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.memberships.list({
external_account: "discord_123456789012345678",
product_ids: ["prod_xxxxxxxxxxxxx"],
variant_ids: ["plan_xxxxxxxxxxxxx"],
promo_code_ids: ["promo_xxxxxxxxxxxxxx"]
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListMembershipsRequest`
-
**requestOptions:** `MembershipsClient.RequestOptions`
client.memberships.invite({ ...params }) -> Whop.InviteMembershipsResponse
-
#### 📝 Description
-
-
Emails one recipient an invitation to a free variant's membership. The invitation is bound to that recipient; after signing in, accepting it immediately grants the membership without checkout. This Experimental endpoint is available only to accounts enabled for membership invitations.
#### 🔌 Usage
-
-
```typescript
await client.memberships.invite({
user_id: "user_xxxxxxxxxxxxxx",
variant_id: "plan_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.InviteMembershipsRequestBody`
-
**requestOptions:** `MembershipsClient.RequestOptions`
client.memberships.retrieve({ ...params }) -> Whop.Membership
-
#### 📝 Description
-
-
Retrieves a membership by ID or license key. Accessible to the account and to the membership's own user.
#### 🔌 Usage
-
-
```typescript
await client.memberships.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveMembershipsRequest`
-
**requestOptions:** `MembershipsClient.RequestOptions`
client.memberships.update({ ...params }) -> Whop.Membership
-
#### 📝 Description
-
-
Updates a membership's metadata, scheduled cancellation, renewal payment method, or renewal cadence.
#### 🔌 Usage
-
-
```typescript
await client.memberships.update({
id: "id",
billing_period_days: 45
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateMembershipsRequest`
-
**requestOptions:** `MembershipsClient.RequestOptions`
client.memberships.applyPromoCode({ ...params }) -> Whop.Membership
-
#### 📝 Description
-
-
Applies a promo code to an `active` or `trialing` membership that does not already have one and has exactly one recurring item, for Stripe-billed memberships and memberships billed by Whop's billing engine. The discount lands on the next invoice and follows the code's duration (`once`, `repeating`, or `forever`).
#### 🔌 Usage
-
-
```typescript
await client.memberships.applyPromoCode({
id: "id",
promo_code: "SAVE20"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ApplyPromoCodeMembershipsRequest`
-
**requestOptions:** `MembershipsClient.RequestOptions`
client.memberships.assignAffiliate({ ...params }) -> Whop.Membership
-
#### 📝 Description
-
-
Assigns an affiliate to a membership and pays them the commission you set on its future payments; past payments are not recalculated. A user who is not yet an affiliate of your account becomes one, which also requires `affiliate:create`. Send a new `commission_type` or `commission_value` for the membership's current affiliate to change their commission; a membership that already has a different affiliate returns a conflict. Works for active or trialing memberships with one recurring variant that bill through Stripe or Whop's billing engine, and not for marketplace memberships, paused payments, or a scheduled cancellation. You cannot assign yourself.
#### 🔌 Usage
-
-
```typescript
await client.memberships.assignAffiliate({
id: "id",
commission_type: "flat_fee",
commission_value: 5,
email: "affiliate@example.com"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.AssignAffiliateMembershipsRequest`
-
**requestOptions:** `MembershipsClient.RequestOptions`
client.memberships.cancel({ ...params }) -> Whop.Membership
-
#### 📝 Description
-
-
Cancels a membership, either immediately or at the end of the current billing period. Buyers cannot cancel buy-now-pay-later (`splitit`, `sezzle`) or non-trial split-pay memberships.
#### 🔌 Usage
-
-
```typescript
await client.memberships.cancel({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CancelMembershipsRequest`
-
**requestOptions:** `MembershipsClient.RequestOptions`
client.memberships.extend({ ...params }) -> Whop.Membership
-
#### 📝 Description
-
-
Adds free days to a membership, extending its current billing period, expiration date, or trial depending on the plan type.
#### 🔌 Usage
-
-
```typescript
await client.memberships.extend({
id: "id",
days: 7
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ExtendMembershipsRequest`
-
**requestOptions:** `MembershipsClient.RequestOptions`
client.memberships.pause({ ...params }) -> Whop.Membership
-
#### 📝 Description
-
-
Pauses a membership's recurring payment collection. The customer keeps access but is not charged until the membership is resumed.
#### 🔌 Usage
-
-
```typescript
await client.memberships.pause({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.PauseMembershipsRequest`
-
**requestOptions:** `MembershipsClient.RequestOptions`
client.memberships.reactivate({ ...params }) -> Whop.Membership
-
#### 📝 Description
-
-
Restores access to a `canceled` or `expired` membership that contains only one-time purchases and sets its `status` to `completed`. Lifetime memberships regain lifetime access; for memberships with an expiration, `days` sets the new `current_period_end`. Active and recurring memberships cannot be reactivated.
#### 🔌 Usage
-
-
```typescript
await client.memberships.reactivate({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ReactivateMembershipsRequest`
-
**requestOptions:** `MembershipsClient.RequestOptions`
client.memberships.resume({ ...params }) -> Whop.Membership
-
#### 📝 Description
-
-
Resumes a previously paused membership's recurring payment collection. Billing resumes on the next cycle.
#### 🔌 Usage
-
-
```typescript
await client.memberships.resume({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ResumeMembershipsRequest`
-
**requestOptions:** `MembershipsClient.RequestOptions`
client.memberships.resyncAccess({ ...params }) -> Whop.Membership
-
#### 📝 Description
-
-
Re-runs access fulfillment for a membership: recomputes the member's content access on Whop, re-validates their Discord link (re-adding them to the server and re-assigning roles if needed), and re-fulfills TradingView indicator access. Telegram access is invite-based and is not resynced. The work runs in the background and the outcome is written to the membership's logs.
#### 🔌 Usage
-
-
```typescript
await client.memberships.resyncAccess({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ResyncAccessMembershipsRequest`
-
**requestOptions:** `MembershipsClient.RequestOptions`
client.memberships.transfer({ ...params }) -> Whop.TransferMembershipsResponse
-
#### 📝 Description
-
-
Creates a one-use transfer URL for a membership. Opening the URL while logged into a different Whop account claims the membership onto that account. The membership's buyer can generate a link for their own membership with `membership:transfer` when the product allows transfers and the membership is `trialing`, `active`, or `completed`. An account credential with `membership:update` bypasses both restrictions.
#### 🔌 Usage
-
-
```typescript
await client.memberships.transfer({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.TransferMembershipsRequest`
-
**requestOptions:** `MembershipsClient.RequestOptions`
client.messages.list({ ...params }) -> core.Page<Whop.MessageListItem, Whop.ListMessagesResponse>
-
#### 📝 Description
-
-
Lists messages in an experience chat, DM, or group chat channel, sorted by creation time.
Required permissions (one of):
- `chat:read`
- `dms:read`
- `support_chat:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.messages.list({
first: 42,
last: 42,
channel_id: "channel_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.messages.list({
first: 42,
last: 42,
channel_id: "channel_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListMessagesRequest`
-
**requestOptions:** `MessagesClient.RequestOptions`
client.messages.create({ ...params }) -> Whop.Message
-
#### 📝 Description
-
-
Sends a message in an experience chat, DM, or group chat channel. Supports text content, attachments, polls, and replies.
Required permissions (one of):
- `chat:message:create`
- `dms:message:manage`
- `livestream:chat:write`
- `support_chat:message:create`
#### 🔌 Usage
-
-
```typescript
await client.messages.create({
channel_id: "channel_id",
content: "content"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateMessagesRequest`
-
**requestOptions:** `MessagesClient.RequestOptions`
client.messages.retrieve({ ...params }) -> Whop.Message
-
#### 📝 Description
-
-
Retrieves the details of an existing message.
Required permissions (one of):
- `chat:read`
- `dms:read`
- `livestream:chat:read`
- `support_chat:read`
#### 🔌 Usage
-
-
```typescript
await client.messages.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveMessagesRequest`
-
**requestOptions:** `MessagesClient.RequestOptions`
client.messages.delete({ ...params }) -> boolean
-
#### 📝 Description
-
-
Permanently deletes a message from an experience chat, DM, or group chat channel. Only the message author or a channel admin can delete a message.
Required permissions (one of):
- `chat:message:create` and `chat:read`
- `dms:message:manage` and `dms:read`
- `livestream:chat:write` and `livestream:chat:read`
- `support_chat:message:create` and `support_chat:read`
#### 🔌 Usage
-
-
```typescript
await client.messages.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteMessagesRequest`
-
**requestOptions:** `MessagesClient.RequestOptions`
client.messages.update({ ...params }) -> Whop.Message
-
#### 📝 Description
-
-
Edits the content, attachments, or pinned status of a message in an experience chat, DM, or group chat channel.
Required permissions (one of):
- `chat:message:create`
- `dms:message:manage`
- `livestream:chat:write`
- `support_chat:message:create`
#### 🔌 Usage
-
-
```typescript
await client.messages.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateMessagesRequest`
-
**requestOptions:** `MessagesClient.RequestOptions`
client.notifications.list({ ...params }) -> core.Page<Whop.Notification, Whop.ListNotificationsResponse>
-
#### 📝 Description
-
-
Lists the authenticated user's notifications, newest first. Without filters the feed spans every experience the user belongs to plus the teams they are a member of. Requires a user credential — an account API key has no notification feed.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.notifications.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.notifications.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListNotificationsRequest`
-
**requestOptions:** `NotificationsClient.RequestOptions`
client.notifications.create({ ...params }) -> Whop.CreateNotificationsResponse
-
#### 📝 Description
-
-
Queues a notification to every user of an experience or to an account's team, processed asynchronously. Every send is attributed to an app: use an app API key, or a credential acting on behalf of an app. Narrow the audience with `user_ids` to send a mention.
#### 🔌 Usage
-
-
```typescript
await client.notifications.create({
content: "Drop off at 4180 Burnet Rd. Plan on two days for the full coating.",
title: "Your ceramic coating is booked"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateNotificationsRequest`
-
**requestOptions:** `NotificationsClient.RequestOptions`
client.notifications.badges({ ...params }) -> Whop.BadgesNotificationsResponse
-
#### 📝 Description
-
-
Lists the authenticated user's per-experience unread badge state. Requires a user credential. Returns one row per experience the user belongs to (or per requested experience).
#### 🔌 Usage
-
-
```typescript
await client.notifications.badges({
experience_ids: ["exp_xxxxxxxxxxxxxx"]
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.BadgesNotificationsRequest`
-
**requestOptions:** `NotificationsClient.RequestOptions`
client.notifications.markRead({ ...params }) -> Whop.MarkReadNotificationsResponse
-
#### 📝 Description
-
-
Marks the authenticated user's notifications as read, for one experience or all of them, and returns the refreshed badge rows for that scope. Requires a user credential.
#### 🔌 Usage
-
-
```typescript
await client.notifications.markRead();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.MarkReadNotificationsRequest`
-
**requestOptions:** `NotificationsClient.RequestOptions`
client.notifications.retrieve({ ...params }) -> Whop.Notification
-
#### 📝 Description
-
-
Retrieves a single notification, from the feed or from a push or websocket event. Requires a user credential.
#### 🔌 Usage
-
-
```typescript
await client.notifications.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveNotificationsRequest`
-
**requestOptions:** `NotificationsClient.RequestOptions`
client.partnerReferralRequests.list({ ...params }) -> core.Page<Whop.PartnerReferralRequest, Whop.ListPartnerReferralRequestsResponse>
-
#### 📝 Description
-
-
Lists your referral links and attribution requests, including incoming requests for you or businesses you own, with filters for recipient, partner, type, and status.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.partnerReferralRequests.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.partnerReferralRequests.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListPartnerReferralRequestsRequest`
-
**requestOptions:** `PartnerReferralRequestsClient.RequestOptions`
client.partnerReferralRequests.create({ ...params }) -> Whop.PartnerReferralRequest
-
#### 📝 Description
-
-
Creates a referral link, or sends an attribution request to an existing business or user for approval. Links require an enrolled partner who is not suspended; attribution requests require an enrolled, verified partner. Recipients do not need to join the partner program.
#### 🔌 Usage
-
-
```typescript
await client.partnerReferralRequests.create({
account_id: "biz_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreatePartnerReferralRequestsRequestBody`
-
**requestOptions:** `PartnerReferralRequestsClient.RequestOptions`
client.partnerReferralRequests.retrieve({ ...params }) -> Whop.PartnerReferralRequest
-
#### 📝 Description
-
-
Retrieves a referral link or attribution request by ID, including its partner, recipient, approval status, and referral code when present.
#### 🔌 Usage
-
-
```typescript
await client.partnerReferralRequests.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrievePartnerReferralRequestsRequest`
-
**requestOptions:** `PartnerReferralRequestsClient.RequestOptions`
client.partnerReferralRequests.accept({ ...params }) -> Whop.PartnerReferralRequest
-
#### 📝 Description
-
-
Accepts a pending attribution request as the receiving user or business owner, assigning the requesting partner as that user's or business's referrer.
#### 🔌 Usage
-
-
```typescript
await client.partnerReferralRequests.accept({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.AcceptPartnerReferralRequestsRequest`
-
**requestOptions:** `PartnerReferralRequestsClient.RequestOptions`
client.partnerReferralRequests.cancel({ ...params }) -> Whop.PartnerReferralRequest
-
#### 📝 Description
-
-
Cancels a pending attribution request you sent so the recipient can no longer accept it, and returns the cancelled request.
#### 🔌 Usage
-
-
```typescript
await client.partnerReferralRequests.cancel({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CancelPartnerReferralRequestsRequest`
-
**requestOptions:** `PartnerReferralRequestsClient.RequestOptions`
client.partnerReferralRequests.decline({ ...params }) -> Whop.PartnerReferralRequest
-
#### 📝 Description
-
-
Declines a pending attribution request for you or a business you own, marking it as denied without assigning the requesting partner as a referrer.
#### 🔌 Usage
-
-
```typescript
await client.partnerReferralRequests.decline({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeclinePartnerReferralRequestsRequest`
-
**requestOptions:** `PartnerReferralRequestsClient.RequestOptions`
client.partners.create() -> Whop.CreatePartnersResponse
-
#### 📝 Description
-
-
Enrolls the calling user in the Whop partner program, making their partner businesses eligible for earnings. Idempotent — enrolling again keeps the original enrollment time.
#### 🔌 Usage
-
-
```typescript
await client.partners.create();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `PartnersClient.RequestOptions`
client.partners.feeOptions() -> Whop.FeeOptionsPartnersResponse
-
#### 📝 Description
-
-
Lists, per income stream, the fee a business the caller refers would be charged, how low the caller may price it, and the commission the caller earns on that stream. Answers for a referral that does not exist yet, so a referral flow can price the deal before the business is created. Requires `partner:fees:update`, since the floors a partner may price down to are only for a credential that can set them.
#### 🔌 Usage
-
-
```typescript
await client.partners.feeOptions();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `PartnersClient.RequestOptions`
client.partners.leaderboard({ ...params }) -> Whop.LeaderboardPartnersResponse
-
#### 📝 Description
-
-
Ranks referrers by partner business earnings over the chosen `period`, all-time by default. Authentication is optional: authenticated callers also get their own standing, anonymous callers get the rankings alone.
#### 🔌 Usage
-
-
```typescript
await client.partners.leaderboard();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.LeaderboardPartnersRequest`
-
**requestOptions:** `PartnersClient.RequestOptions`
client.partners.referredUsers({ ...params }) -> core.Page<Whop.ReferredUsersPartnersResponse.Data.Item, Whop.ReferredUsersPartnersResponse>
-
#### 📝 Description
-
-
Lists the users the caller referred onto Whop, newest first by default, each with the caller's total affiliate earnings from that user across all tiers.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.partners.referredUsers();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.partners.referredUsers();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ReferredUsersPartnersRequest`
-
**requestOptions:** `PartnersClient.RequestOptions`
client.partners.retrieve({ ...params }) -> Whop.Partner
-
#### 📝 Description
-
-
Retrieves the authenticated user's partner profile: enrollment and verification status, certification completion, active direct business referral count, and default payout rates. Other users' profiles are not accessible. To create and manage referral links, use `/partner_referral_requests`.
#### 🔌 Usage
-
-
```typescript
await client.partners.retrieve({
id: "me"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrievePartnersRequest`
-
**requestOptions:** `PartnersClient.RequestOptions`
client.paymentMethodDomains.list({ ...params }) -> core.Page<Whop.PaymentMethodDomain, Whop.ListPaymentMethodDomainsResponse>
-
#### 📝 Description
-
-
Lists the payment method domains registered for your account and its connected accounts. Deprecated: list domains with `GET /domains` and the `apple_pay` filter instead.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.paymentMethodDomains.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.paymentMethodDomains.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListPaymentMethodDomainsRequest`
-
**requestOptions:** `PaymentMethodDomainsClient.RequestOptions`
client.paymentMethodDomains.create({ ...params }) -> Whop.PaymentMethodDomain
-
#### 📝 Description
-
-
Registers a hostname with the wallet provider and attempts verification inline. Returns `verified` when the provider fetched the domain-association file (for Apple Pay, `/.well-known/apple-developer-merchantid-domain-association`), or `pending` when it could not: host the file, then retry with `POST /payment_method_domains/:id/verify`. Deprecated: add Apple Pay with `POST /domains` and `apple_pay: {}` instead.
#### 🔌 Usage
-
-
```typescript
await client.paymentMethodDomains.create({
hostname: "pending.shinetime.com"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreatePaymentMethodDomainsRequest`
-
**requestOptions:** `PaymentMethodDomainsClient.RequestOptions`
client.paymentMethodDomains.retrieve({ ...params }) -> Whop.PaymentMethodDomain
-
#### 📝 Description
-
-
Retrieves a payment method domain to check its verification status. Deprecated: retrieve the domain with `GET /domains/{id}` instead, using the same ID.
#### 🔌 Usage
-
-
```typescript
await client.paymentMethodDomains.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrievePaymentMethodDomainsRequest`
-
**requestOptions:** `PaymentMethodDomainsClient.RequestOptions`
client.paymentMethodDomains.delete({ ...params }) -> Whop.DeletePaymentMethodDomainsResponse
-
#### 📝 Description
-
-
Unregisters a payment method domain so its wallet payment methods stop rendering there. Deprecated: remove Apple Pay with `PATCH /domains/{id}` and `apple_pay: null` instead. `DELETE /domains/{id}` removes the whole domain, including any website on it.
#### 🔌 Usage
-
-
```typescript
await client.paymentMethodDomains.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeletePaymentMethodDomainsRequest`
-
**requestOptions:** `PaymentMethodDomainsClient.RequestOptions`
client.paymentMethodDomains.verify({ ...params }) -> Whop.PaymentMethodDomain
-
#### 📝 Description
-
-
Re-attempts provider verification of a pending domain once the association file is hosted. Fails with a `bad_request` explaining what to fix; verifying an already `verified` domain is a no-op. Deprecated: check the domain with `POST /domains/{id}/check` instead.
#### 🔌 Usage
-
-
```typescript
await client.paymentMethodDomains.verify({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.VerifyPaymentMethodDomainsRequest`
-
**requestOptions:** `PaymentMethodDomainsClient.RequestOptions`
client.paymentMethods.list({ ...params }) -> core.Page<Whop.PaymentMethodListItem, Whop.ListPaymentMethodsResponse>
-
#### 📝 Description
-
-
Returns a paginated list of saved payment methods for a member or account, or for the authenticated user when you pass neither.
Required permissions:
- `member:payment_methods:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.paymentMethods.list({
first: 42,
last: 42,
member_id: "mber_xxxxxxxxxxxxx",
created_before: "2023-12-01T05:00:00Z",
created_after: "2023-12-01T05:00:00Z",
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.paymentMethods.list({
first: 42,
last: 42,
member_id: "mber_xxxxxxxxxxxxx",
created_before: "2023-12-01T05:00:00Z",
created_after: "2023-12-01T05:00:00Z",
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListPaymentMethodsRequest`
-
**requestOptions:** `PaymentMethodsClient.RequestOptions`
client.paymentMethods.retrieve({ ...params }) -> Whop.PaymentMethod
-
#### 📝 Description
-
-
Retrieves a saved payment method from a member's wallet when you pass `member_id` or `account_id`, or from your own otherwise.
Required permissions:
- `member:payment_methods:read`
#### 🔌 Usage
-
-
```typescript
await client.paymentMethods.retrieve({
id: "payt_xxxxxxxxxxxxx",
member_id: "mber_xxxxxxxxxxxxx",
account_id: "biz_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrievePaymentMethodsRequest`
-
**requestOptions:** `PaymentMethodsClient.RequestOptions`
client.paymentMethods.deletePaymentMethod({ ...params }) -> boolean
-
#### 📝 Description
-
-
Delete a saved payment method. Cannot delete a payment method attached to an active subscription.
Required permissions:
- `member:payment_methods:manage`
#### 🔌 Usage
-
-
```typescript
await client.paymentMethods.deletePaymentMethod({
id: "payt_xxxxxxxxxxxxx",
member_id: "mber_xxxxxxxxxxxxx",
account_id: "biz_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeletePaymentMethodRequest`
-
**requestOptions:** `PaymentMethodsClient.RequestOptions`
client.paymentQuotes.create({ ...params }) -> Whop.PaymentQuote
-
#### 📝 Description
-
-
Prices a purchase the way a payment for it will be charged. The body is the `PaymentInput` a payment takes plus where the buyer is, which a seller that collects no tax on the purchase can leave out. The purchase is priced from exactly what you send: no buyer is looked up, so no stored registration or purchase history applies. Pass the quote's `id` as `quote_id` when you create the payment to charge exactly the purchase, promo code, and tax shown here. A quote is priced once and may be consumed by one payment before `expires_at`. Cart entries must name existing variants with `variant_id`.
#### 🔌 Usage
-
-
```typescript
await client.paymentQuotes.create({
account_id: "biz_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreatePaymentQuotesRequest`
-
**requestOptions:** `PaymentQuotesClient.RequestOptions`
client.paymentQuotes.retrieve({ ...params }) -> Whop.PaymentQuote
-
#### 📝 Description
-
-
Retrieves a payment quote. Use it to check which payment holds the quote, through `payment_id`, and when it expires.
#### 🔌 Usage
-
-
```typescript
await client.paymentQuotes.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrievePaymentQuotesRequest`
-
**requestOptions:** `PaymentQuotesClient.RequestOptions`
client.paymentRules.list({ ...params }) -> core.Page<Whop.PaymentRule, Whop.ListPaymentRulesResponse>
-
#### 📝 Description
-
-
Lists the payment rules on an account.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.paymentRules.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.paymentRules.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListPaymentRulesRequest`
-
**requestOptions:** `PaymentRulesClient.RequestOptions`
client.paymentRules.create({ ...params }) -> Whop.PaymentRule
-
#### 📝 Description
-
-
Creates a payment rule. It is created `active` and applies its `action` to new payments that match all of its `conditions`.
#### 🔌 Usage
-
-
```typescript
await client.paymentRules.create({
action: "allow",
conditions: {
all: [{
field: "risk_score",
operator: "gte",
value: 70
}]
},
name: "Review risky cards"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreatePaymentRulesRequest`
-
**requestOptions:** `PaymentRulesClient.RequestOptions`
client.paymentRules.listFields() -> Whop.ListFieldsPaymentRulesResponse
-
#### 📝 Description
-
-
Lists the payment attributes a rule condition can read, with the operators and values each one accepts. Small and returned in full on one page.
#### 🔌 Usage
-
-
```typescript
await client.paymentRules.listFields();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `PaymentRulesClient.RequestOptions`
client.paymentRules.retrieve({ ...params }) -> Whop.PaymentRule
-
#### 📝 Description
-
-
Retrieves a payment rule.
#### 🔌 Usage
-
-
```typescript
await client.paymentRules.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrievePaymentRulesRequest`
-
**requestOptions:** `PaymentRulesClient.RequestOptions`
client.paymentRules.delete({ ...params }) -> void
-
#### 📝 Description
-
-
Deletes a payment rule. It stops applying to new payments but is kept, so the payments it already decided still name it.
#### 🔌 Usage
-
-
```typescript
await client.paymentRules.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeletePaymentRulesRequest`
-
**requestOptions:** `PaymentRulesClient.RequestOptions`
client.paymentRules.update({ ...params }) -> Whop.PaymentRule
-
#### 📝 Description
-
-
Updates a payment rule's name or metadata, keeping its ID and everything recorded against it. A rule's `action` and `conditions` are fixed once created, so the payments it decided keep naming the rule that decided them; use `POST /payment_rules/:id/replace` to change them.
#### 🔌 Usage
-
-
```typescript
await client.paymentRules.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdatePaymentRulesRequest`
-
**requestOptions:** `PaymentRulesClient.RequestOptions`
client.paymentRules.activate({ ...params }) -> Whop.PaymentRule
-
#### 📝 Description
-
-
Activates an inactive payment rule so it applies to new payments again. A deleted rule cannot be activated.
#### 🔌 Usage
-
-
```typescript
await client.paymentRules.activate({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ActivatePaymentRulesRequest`
-
**requestOptions:** `PaymentRulesClient.RequestOptions`
client.paymentRules.deactivate({ ...params }) -> Whop.PaymentRule
-
#### 📝 Description
-
-
Deactivates a payment rule so it stops applying to new payments. It keeps its ID and can be activated again.
#### 🔌 Usage
-
-
```typescript
await client.paymentRules.deactivate({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeactivatePaymentRulesRequest`
-
**requestOptions:** `PaymentRulesClient.RequestOptions`
client.paymentRules.replace({ ...params }) -> Whop.PaymentRule
-
#### 📝 Description
-
-
Changes a payment rule's `action` and `conditions` by deleting it and creating its successor in one step. The successor has a new ID and keeps the replaced rule's name, metadata, and `active` or `inactive` status.
#### 🔌 Usage
-
-
```typescript
await client.paymentRules.replace({
id: "id",
action: "allow",
conditions: {
all: [{
field: "risk_score",
operator: "gte",
value: 70
}]
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ReplacePaymentRulesRequest`
-
**requestOptions:** `PaymentRulesClient.RequestOptions`
client.payments.list({ ...params }) -> core.Page<Whop.Payment, Whop.ListPaymentsResponse>
-
#### 📝 Description
-
-
Lists payments, newest first. By default, returns sales for the accounts your credential can read: an account credential's own account, or every account a user can read payments for. Set `mode` to `user_sales` to list the sales the signed-in user received personally, outside any account.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.payments.list({
currencies: ["eur"],
variant_ids: ["plan_xxxxxxxxxxxxx"],
product_ids: ["prod_xxxxxxxxxxxxx"]
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.payments.list({
currencies: ["eur"],
variant_ids: ["plan_xxxxxxxxxxxxx"],
product_ids: ["prod_xxxxxxxxxxxxx"]
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListPaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payments.create({ ...params }) -> Whop.Payment
-
#### 📝 Description
-
-
Charges a buyer for one or more variants with a payment method already on file (`member_id` and `payment_method_id`), or with a `confirmation_token` for a method the buyer just supplied. Collection runs in the background, so the response is the payment as created, not its outcome: poll Retrieve payment status for how far it has got and what the buyer must still do.
#### 🔌 Usage
-
-
```typescript
await client.payments.create({
account_id: "biz_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreatePaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payments.summary({ ...params }) -> Whop.SummaryPaymentsResponse
-
#### 📝 Description
-
-
Totals up the same payments the list returns, so you can build status tabs and filter options without paging through them. Takes the same filters as List Payments.
#### 🔌 Usage
-
-
```typescript
await client.payments.summary({
currencies: ["usd"],
variant_ids: ["plan_xxxxxxxxxxxxx"],
product_ids: ["prod_xxxxxxxxxxxxx"]
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.SummaryPaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payments.retrieve({ ...params }) -> Whop.Payment
-
#### 📝 Description
-
-
Returns one payment, including every purchased line item with its quantity and subtotal. Related records are ids — resolve a variant, membership, member or shipment on its own endpoint, and list this payment's refunds, disputes or Resolution Center cases with `?payment_id=`.
#### 🔌 Usage
-
-
```typescript
await client.payments.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrievePaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payments.update({ ...params }) -> Whop.Payment
-
#### 📝 Description
-
-
Updates a payment's `shipping_address` or `return_url`.
#### 🔌 Usage
-
-
```typescript
await client.payments.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdatePaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payments.capture({ ...params }) -> Whop.PaymentStatus
-
#### 📝 Description
-
-
Captures the full amount of a card payment created with `capture: false`. The payment must still be in `requires_capture` before `capture_expires_at`. Partial capture, multiple captures, capturing more than the authorized amount, and tips are not supported.
#### 🔌 Usage
-
-
```typescript
await client.payments.capture({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CapturePaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payments.listFees({ ...params }) -> Whop.ListFeesPaymentsResponse
-
#### 📝 Description
-
-
Returns the fee breakdown of one payment — Whop's fee, processing, affiliate and other lines — each in the currency it was collected in and converted to the payment's settlement currency. The list is complete in one page.
#### 🔌 Usage
-
-
```typescript
await client.payments.listFees({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListFeesPaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payments.generatePdf({ ...params }) -> Whop.PaymentPdf
-
#### 📝 Description
-
-
Generates the payment's receipt (invoice) as a PDF and returns a short-lived link to download it. Each call generates a new file and link, so this endpoint does not replay `Idempotency-Key` responses.
#### 🔌 Usage
-
-
```typescript
await client.payments.generatePdf({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.GeneratePdfPaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payments.refund({ ...params }) -> Whop.Payment
-
#### 📝 Description
-
-
Refunds all or part of a payment through the processor that charged it, and updates its membership to match. The buyer is emailed, the affiliate commission on the payment is clawed back, and any open Resolution Center case on the payment is closed.
#### 🔌 Usage
-
-
```typescript
await client.payments.refund({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RefundPaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payments.retry({ ...params }) -> Whop.Payment
-
#### 📝 Description
-
-
Charges an unpaid payment again with its original payment method and variant. A payment can typically be retried once, and only while its membership is active, trialing or past due, or when it is a membership's failed first payment.
#### 🔌 Usage
-
-
```typescript
await client.payments.retry({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetryPaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payments.void({ ...params }) -> Whop.Payment
-
#### 📝 Description
-
-
Voids or cancels an eligible payment. The request is rejected if the payment is no longer eligible. Some processors confirm the release of a card authorization asynchronously: the payment is then returned still `authorized`, and a `payment.canceled` webhook follows once the hold is released.
#### 🔌 Usage
-
-
```typescript
await client.payments.void({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.VoidPaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payments.resume({ ...params }) -> Whop.PaymentStatus
-
#### 📝 Description
-
-
Charges the saved card again, with the buyer present, for a payment their bank declined until they authenticate (such as with 3DS). Retrieve the payment afterward to get the bank's challenge from `next_action`; once the buyer completes it, they land on `return_url`, or on Whop's hosted verification page if none was given. Only the buyer can call this, with the payment's `client_secret` in the body, an OAuth token for their own account with the `member:payment_methods:use` scope, or the token from a verified `payment` session intent. An API key gets a `403`. Has no effect on a payment that is not waiting on authentication.
#### 🔌 Usage
-
-
```typescript
await client.payments.resume({
payment_id: "payment_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ResumePaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payments.updateReturnUrl({ ...params }) -> Whop.PaymentStatus
-
#### 📝 Description
-
-
Changes where the buyer lands after completing an off-site step, up until they return. Accepts either a secret key or the payment's own `client_secret` in the body, so the surface that knows the final destination can set it.
#### 🔌 Usage
-
-
```typescript
await client.payments.updateReturnUrl({
payment_id: "payment_id",
return_url: "https://shinetime.example/checkout/thanks"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateReturnUrlPaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payments.retrieveStatus({ ...params }) -> Whop.PaymentStatus
-
#### 📝 Description
-
-
Retrieves how far a payment has got and what the buyer must do next, if anything. A payment is collected in the background, so poll this rather than reading the create response. Accepts either a secret key or the payment's own `client_secret` as a query parameter, so the surface collecting the payment can poll it directly.
#### 🔌 Usage
-
-
```typescript
await client.payments.retrieveStatus({
payment_id: "payment_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveStatusPaymentsRequest`
-
**requestOptions:** `PaymentsClient.RequestOptions`
client.payoutAccounts.retrieve({ ...params }) -> Whop.PayoutAccount
-
#### 📝 Description
-
-
Retrieves the details of an existing payout account.
Required permissions:
- `payout:account:read`
#### 🔌 Usage
-
-
```typescript
await client.payoutAccounts.retrieve({
id: "poact_xxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrievePayoutAccountsRequest`
-
**requestOptions:** `PayoutAccountsClient.RequestOptions`
client.payoutMethods.listPayoutMethod({ ...params }) -> core.Page<Whop.PayoutMethodListItem, Whop.ListPayoutMethodResponse>
-
#### 📝 Description
-
-
Lists the active payout methods configured for an account, newest first.
Required permissions:
- `payout:destination:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.payoutMethods.listPayoutMethod({
first: 42,
last: 42,
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.payoutMethods.listPayoutMethod({
first: 42,
last: 42,
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListPayoutMethodRequest`
-
**requestOptions:** `PayoutMethodsClient.RequestOptions`
client.payoutMethods.retrievePayoutMethod({ ...params }) -> Whop.PayoutMethod
-
#### 📝 Description
-
-
Retrieves the details of an existing payout method.
Required permissions:
- `payout:destination:read`
#### 🔌 Usage
-
-
```typescript
await client.payoutMethods.retrievePayoutMethod({
id: "potk_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrievePayoutMethodRequest`
-
**requestOptions:** `PayoutMethodsClient.RequestOptions`
client.payouts.list({ ...params }) -> core.Page<Whop.ListPayoutsResponse.Data.Item, Whop.ListPayoutsResponse>
-
#### 📝 Description
-
-
Lists an account's or user's payouts, newest first.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.payouts.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.payouts.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListPayoutsRequest`
-
**requestOptions:** `PayoutsClient.RequestOptions`
client.payouts.create({ ...params }) -> Whop.CreatePayoutsResponse
-
#### 📝 Description
-
-
Sends money from an account or user balance to a saved payout method for that owner.
#### 🔌 Usage
-
-
```typescript
await client.payouts.create({
amount: 50,
payout_method_id: "potk_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreatePayoutsRequest`
-
**requestOptions:** `PayoutsClient.RequestOptions`
client.payouts.createQuote({ ...params }) -> Whop.CreateQuotePayoutsResponse
-
#### 📝 Description
-
-
Creates a short-lived, provider-backed quote of a payout's fee, exchange rate, and destination amount. No funds move until you submit the returned `quote_token` to `POST /payouts`.
#### 🔌 Usage
-
-
```typescript
await client.payouts.createQuote({
payout_method_id: "potk_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateQuotePayoutsRequest`
-
**requestOptions:** `PayoutsClient.RequestOptions`
client.payouts.retrieve({ ...params }) -> Whop.RetrievePayoutsResponse
-
#### 📝 Description
-
-
Retrieves a payout by its `wdrl_` ID, or by the `cofr_` conversion request ID a payout carries as `payout_request_id`. Authentication is optional: anyone with the ID can view tracking details, including notes, trace code, exchange rate, and payout request ID, while accounting fields require `payout:withdrawal:read` on the account or user that owns the payout. A supplied invalid credential returns 401.
#### 🔌 Usage
-
-
```typescript
await client.payouts.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrievePayoutsRequest`
-
**requestOptions:** `PayoutsClient.RequestOptions`
client.payouts.cancel({ ...params }) -> Whop.CancelPayoutsResponse
-
#### 📝 Description
-
-
Cancels a payout before it is sent to the payout provider, or asks the provider to stop one already sent. While the payout is `in_review`, or `processing` with nothing sent yet (see `cancelable`), it is canceled and the funds, fees included, return to the balance. Once sent, the response is 202 with a `cancellation` object, and the payout reads `canceled` only if the provider confirms it stopped. A `requested` payout returns 409 until it reaches review, a payout the provider can no longer stop returns 409 with error type `not_cancelable`, and canceling an already-canceled payout returns it unchanged.
#### 🔌 Usage
-
-
```typescript
await client.payouts.cancel({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CancelPayoutsRequest`
-
**requestOptions:** `PayoutsClient.RequestOptions`
client.people.list({ ...params }) -> core.Page<Whop.ListPeopleResponse.Data.Item, Whop.ListPeopleResponse>
-
#### 📝 Description
-
-
Lists the people (visitors and customers) of an account: identity-linked profiles assembled from every pixel, payment, and platform event. Filter and sort them to segment an account's audience.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.people.list({
source: ["direct"],
event_name: ["payment.completed"]
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.people.list({
source: ["direct"],
event_name: ["payment.completed"]
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListPeopleRequest`
-
**requestOptions:** `PeopleClient.RequestOptions`
client.people.retrieve({ ...params }) -> Whop.RetrievePeopleResponse
-
#### 📝 Description
-
-
Retrieves one person for an account, looked up by person ID, user ID, email address, or phone number.
#### 🔌 Usage
-
-
```typescript
await client.people.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrievePeopleRequest`
-
**requestOptions:** `PeopleClient.RequestOptions`
client.permissions.list({ ...params }) -> Whop.ListPermissionsResponse
-
#### 📝 Description
-
-
Lists permission actions and whether the calling credential is granted each one for a resource. Answers for whichever identity authenticated the request — a user session, an OAuth token, or an account or app API key — so it never describes who else can reach the resource.
#### 🔌 Usage
-
-
```typescript
await client.permissions.list({
resource_id: "resource_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListPermissionsRequest`
-
**requestOptions:** `PermissionsClient.RequestOptions`
client.plans.list({ ...params }) -> core.Page<Whop.PlanListItem, Whop.ListPlansResponse>
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. List variants with `GET /variants` instead.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.plans.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.plans.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListPlansRequest`
-
**requestOptions:** `PlansClient.RequestOptions`
client.plans.create({ ...params }) -> Whop.Plan
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. Create variants with `POST /variants` instead.
#### 🔌 Usage
-
-
```typescript
await client.plans.create();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreatePlansRequest`
-
**requestOptions:** `PlansClient.RequestOptions`
client.plans.retrieve({ ...params }) -> Whop.Plan
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. Retrieve variants with `GET /variants/{id}` instead.
#### 🔌 Usage
-
-
```typescript
await client.plans.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrievePlansRequest`
-
**requestOptions:** `PlansClient.RequestOptions`
client.plans.delete({ ...params }) -> Whop.DeletePlansResponse
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. Delete variants with `DELETE /variants/{id}` instead.
#### 🔌 Usage
-
-
```typescript
await client.plans.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeletePlansRequest`
-
**requestOptions:** `PlansClient.RequestOptions`
client.plans.update({ ...params }) -> Whop.Plan
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. Update variants with `PATCH /variants/{id}` instead.
#### 🔌 Usage
-
-
```typescript
await client.plans.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdatePlansRequest`
-
**requestOptions:** `PlansClient.RequestOptions`
client.plans.calculateTax({ ...params }) -> Whop.CalculateTaxPlansResponse
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. Quote tax with `POST /payment_quotes` instead.
#### 🔌 Usage
-
-
```typescript
await client.plans.calculateTax({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CalculateTaxPlansRequest`
-
**requestOptions:** `PlansClient.RequestOptions`
client.productAffiliates.list({ ...params }) -> core.Page<Whop.ProductAffiliate, Whop.ListProductAffiliatesResponse>
-
#### 📝 Description
-
-
Lists affiliate enrollments for an account's products, newest first, including affiliates who have not made a referral. Requires `affiliate:basic:read` on the account. Email addresses and email search also require `member:email:read`.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.productAffiliates.list({
account_id: "account_id",
product_ids: ["prod_xxxxxxxxxxxxxx"]
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.productAffiliates.list({
account_id: "account_id",
product_ids: ["prod_xxxxxxxxxxxxxx"]
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListProductAffiliatesRequest`
-
**requestOptions:** `ProductAffiliatesClient.RequestOptions`
client.products.list({ ...params }) -> core.Page<Whop.ProductListItem, Whop.ListProductsResponse>
-
#### 📝 Description
-
-
Lists an account's products, or searches the public marketplace when you omit `account_id`.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.products.list({
visibilities: ["visible"],
access_pass_types: ["regular"]
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.products.list({
visibilities: ["visible"],
access_pass_types: ["regular"]
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListProductsRequest`
-
**requestOptions:** `ProductsClient.RequestOptions`
client.products.create({ ...params }) -> Whop.Product
-
#### 📝 Description
-
-
Creates a new product for an account.
#### 🔌 Usage
-
-
```typescript
await client.products.create({
title: "Interior Deep Clean"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateProductsRequest`
-
**requestOptions:** `ProductsClient.RequestOptions`
client.products.retrieve({ ...params }) -> Whop.Product
-
#### 📝 Description
-
-
Retrieves a product. Requires no authentication.
#### 🔌 Usage
-
-
```typescript
await client.products.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveProductsRequest`
-
**requestOptions:** `ProductsClient.RequestOptions`
client.products.delete({ ...params }) -> Whop.DeleteProductsResponse
-
#### 📝 Description
-
-
Deletes a product. Only products with no memberships, entries, reviews, or invoices can be deleted.
#### 🔌 Usage
-
-
```typescript
await client.products.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteProductsRequest`
-
**requestOptions:** `ProductsClient.RequestOptions`
client.products.update({ ...params }) -> Whop.Product
-
#### 📝 Description
-
-
Updates an existing product.
#### 🔌 Usage
-
-
```typescript
await client.products.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateProductsRequest`
-
**requestOptions:** `ProductsClient.RequestOptions`
client.products.publish({ ...params }) -> Whop.Product
-
#### 📝 Description
-
-
Submits an App Store app's product for review. The product moves to `pending_review`; a Whop reviewer approves it before it goes live. Other products can no longer be listed on the whop.com marketplace, so the request fails with `discover_listing_discontinued`.
#### 🔌 Usage
-
-
```typescript
await client.products.publish({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.PublishProductsRequest`
-
**requestOptions:** `ProductsClient.RequestOptions`
client.products.unpublish({ ...params }) -> Whop.Product
-
#### 📝 Description
-
-
Removes a product from the whop.com marketplace. The product moves to `not_available`.
#### 🔌 Usage
-
-
```typescript
await client.products.unpublish({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UnpublishProductsRequest`
-
**requestOptions:** `ProductsClient.RequestOptions`
client.promoCodes.list({ ...params }) -> core.Page<Whop.PromoCodeListItem, Whop.ListPromoCodesResponse>
-
#### 📝 Description
-
-
Lists an account's promo codes.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.promoCodes.list({
account_id: "account_id",
product_ids: ["prod_xxxxxxxxxxxxxx"],
variant_ids: ["plan_xxxxxxxxxxxxxx"]
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.promoCodes.list({
account_id: "account_id",
product_ids: ["prod_xxxxxxxxxxxxxx"],
variant_ids: ["plan_xxxxxxxxxxxxxx"]
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListPromoCodesRequest`
-
**requestOptions:** `PromoCodesClient.RequestOptions`
client.promoCodes.create({ ...params }) -> Whop.PromoCode
-
#### 📝 Description
-
-
Creates a promo code for an account.
#### 🔌 Usage
-
-
```typescript
await client.promoCodes.create({
account_id: "biz_xxxxxxxxxxxxxx",
amount_off: 25,
base_currency: "usd",
code: "AFFILIATE25",
new_users_only: true,
promo_duration_months: 3,
promo_type: "percentage"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreatePromoCodesRequest`
-
**requestOptions:** `PromoCodesClient.RequestOptions`
client.promoCodes.retrieve({ ...params }) -> Whop.PromoCode
-
#### 📝 Description
-
-
Retrieves a promo code by ID.
#### 🔌 Usage
-
-
```typescript
await client.promoCodes.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrievePromoCodesRequest`
-
**requestOptions:** `PromoCodesClient.RequestOptions`
client.promoCodes.delete({ ...params }) -> Whop.DeletePromoCodesResponse
-
#### 📝 Description
-
-
Archives a promo code so it cannot be used in future checkouts.
#### 🔌 Usage
-
-
```typescript
await client.promoCodes.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeletePromoCodesRequest`
-
**requestOptions:** `PromoCodesClient.RequestOptions`
client.promoCodes.activate({ ...params }) -> Whop.PromoCode
-
#### 📝 Description
-
-
Turns an inactive promo code back on so it can be redeemed at checkout.
#### 🔌 Usage
-
-
```typescript
await client.promoCodes.activate({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ActivatePromoCodesRequest`
-
**requestOptions:** `PromoCodesClient.RequestOptions`
client.promoCodes.deactivate({ ...params }) -> Whop.PromoCode
-
#### 📝 Description
-
-
Turns off an active promo code so it can no longer be redeemed at checkout.
#### 🔌 Usage
-
-
```typescript
await client.promoCodes.deactivate({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeactivatePromoCodesRequest`
-
**requestOptions:** `PromoCodesClient.RequestOptions`
client.reactions.list({ ...params }) -> core.Page<Whop.ReactionListItem, Whop.ListReactionsResponse>
-
#### 📝 Description
-
-
Returns a paginated list of emoji reactions on a specific message or forum post, sorted by most recent.
Required permissions (one of):
- `chat:read`
- `dms:read`
- `forum:read`
- `livestream:chat:read`
- `support_chat:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.reactions.list({
first: 42,
last: 42,
resource_id: "resource_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.reactions.list({
first: 42,
last: 42,
resource_id: "resource_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListReactionsRequest`
-
**requestOptions:** `ReactionsClient.RequestOptions`
client.reactions.create({ ...params }) -> Whop.Reaction
-
#### 📝 Description
-
-
Add an emoji reaction or poll vote to a message or forum post. In forums, the reaction is always a like.
Required permissions (one of):
- `chat:read`
- `dms:read`
- `forum:read`
- `livestream:chat:read`
- `support_chat:read`
#### 🔌 Usage
-
-
```typescript
await client.reactions.create({
resource_id: "resource_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateReactionsRequest`
-
**requestOptions:** `ReactionsClient.RequestOptions`
client.reactions.retrieve({ ...params }) -> Whop.Reaction
-
#### 📝 Description
-
-
Retrieves the details of an existing reaction.
Required permissions (one of):
- `chat:read`
- `dms:read`
- `forum:read`
- `livestream:chat:read`
- `support_chat:read`
#### 🔌 Usage
-
-
```typescript
await client.reactions.retrieve({
id: "reac_xxxxxxxxxxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveReactionsRequest`
-
**requestOptions:** `ReactionsClient.RequestOptions`
client.reactions.delete({ ...params }) -> boolean
-
#### 📝 Description
-
-
Remove an emoji reaction from a message or forum post. Only the reaction author or a channel admin can remove a reaction.
Required permissions (one of):
- `chat:read`
- `dms:read`
- `forum:read`
- `livestream:chat:read`
- `support_chat:read`
#### 🔌 Usage
-
-
```typescript
await client.reactions.delete({
id: "reac_xxxxxxxxxxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteReactionsRequest`
-
**requestOptions:** `ReactionsClient.RequestOptions`
client.refunds.list({ ...params }) -> core.Page<Whop.Refund, Whop.ListRefundsResponse>
-
#### 📝 Description
-
-
Lists refunds the caller can read, newest first. Filter by payment, account, or buyer to narrow the results.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.refunds.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.refunds.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListRefundsRequest`
-
**requestOptions:** `RefundsClient.RequestOptions`
client.refunds.retrieve({ ...params }) -> Whop.Refund
-
#### 📝 Description
-
-
Returns one refund.
#### 🔌 Usage
-
-
```typescript
await client.refunds.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveRefundsRequest`
-
**requestOptions:** `RefundsClient.RequestOptions`
client.resolutionCenterCases.list({ ...params }) -> core.Page<Whop.ResolutionCenterCase, Whop.ListResolutionCenterCasesResponse>
-
#### 📝 Description
-
-
Lists resolution center cases. Without `account_id` you get every case you can read — the ones you opened as a buyer and every account you are a team member of; the filters narrow that list.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.resolutionCenterCases.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.resolutionCenterCases.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListResolutionCenterCasesRequest`
-
**requestOptions:** `ResolutionCenterCasesClient.RequestOptions`
client.resolutionCenterCases.create({ ...params }) -> Whop.ResolutionCenterCase
-
#### 📝 Description
-
-
Opens a case, as the customer, against one of your own payments. Provide the payment (`receipt_id`), the `reason`, and a `message`.
#### 🔌 Usage
-
-
```typescript
await client.resolutionCenterCases.create({
message: "The mobile detailer never showed up for the Ceramic Coating appointment.",
reason: "fraudulent",
receipt_id: "pay_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateResolutionCenterCasesRequest`
-
**requestOptions:** `ResolutionCenterCasesClient.RequestOptions`
client.resolutionCenterCases.summary({ ...params }) -> Whop.SummaryResolutionCenterCasesResponse
-
#### 📝 Description
-
-
Aggregates the same cases `GET /resolution_center_cases` lists, using the same filters. Use it to build status tabs and issue filters without paging the whole list.
#### 🔌 Usage
-
-
```typescript
await client.resolutionCenterCases.summary();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.SummaryResolutionCenterCasesRequest`
-
**requestOptions:** `ResolutionCenterCasesClient.RequestOptions`
client.resolutionCenterCases.retrieve({ ...params }) -> Whop.ResolutionCenterCase
-
#### 📝 Description
-
-
Retrieves a single resolution center case with its full event timeline.
#### 🔌 Usage
-
-
```typescript
await client.resolutionCenterCases.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveResolutionCenterCasesRequest`
-
**requestOptions:** `ResolutionCenterCasesClient.RequestOptions`
client.resolutionCenterCases.accept({ ...params }) -> Whop.ResolutionCenterCase
-
#### 📝 Description
-
-
Accepts the case in the customer's favor, as the merchant: refunds the payment in full and closes the case.
#### 🔌 Usage
-
-
```typescript
await client.resolutionCenterCases.accept({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.AcceptResolutionCenterCasesRequest`
-
**requestOptions:** `ResolutionCenterCasesClient.RequestOptions`
client.resolutionCenterCases.appeal({ ...params }) -> Whop.ResolutionCenterCase
-
#### 📝 Description
-
-
Appeals a decision, as the customer, on a case that closed in the merchant's favor. Escalates the case to Whop for platform review. A case can be appealed once, within 7 days of the decision.
#### 🔌 Usage
-
-
```typescript
await client.resolutionCenterCases.appeal({
id: "id",
message: "The coating is already flaking on the hood two weeks later."
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.AppealResolutionCenterCasesRequest`
-
**requestOptions:** `ResolutionCenterCasesClient.RequestOptions`
client.resolutionCenterCases.deny({ ...params }) -> Whop.ResolutionCenterCase
-
#### 📝 Description
-
-
Denies the case, as the merchant: rejects the claim and closes the case with no refund.
#### 🔌 Usage
-
-
```typescript
await client.resolutionCenterCases.deny({
id: "id",
message: "The ceramic coating was applied and the vehicle was collected on 2026-01-05."
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DenyResolutionCenterCasesRequest`
-
**requestOptions:** `ResolutionCenterCasesClient.RequestOptions`
client.resolutionCenterCases.events({ ...params }) -> core.Page<Whop.ResolutionEvent, Whop.EventsResolutionCenterCasesResponse>
-
#### 📝 Description
-
-
Lists the case timeline, newest first. Events the viewer is not allowed to see are omitted — a customer reads the customer-visible timeline, the merchant reads the full one.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.resolutionCenterCases.events({
id: "id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.resolutionCenterCases.events({
id: "id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.EventsResolutionCenterCasesRequest`
-
**requestOptions:** `ResolutionCenterCasesClient.RequestOptions`
client.resolutionCenterCases.reply({ ...params }) -> Whop.ResolutionCenterCase
-
#### 📝 Description
-
-
Replies to an open request for information on the case. As the merchant this answers Whop's request (valid while the case awaits your information); as the customer it provides the information requested from you. The actor is resolved from the credential.
#### 🔌 Usage
-
-
```typescript
await client.resolutionCenterCases.reply({
id: "id",
message: "Here are the before and after photos from the Burnet Rd bay."
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ReplyResolutionCenterCasesRequest`
-
**requestOptions:** `ResolutionCenterCasesClient.RequestOptions`
client.resolutionCenterCases.requestInfo({ ...params }) -> Whop.ResolutionCenterCase
-
#### 📝 Description
-
-
Asks the customer for more information, as the merchant. Allowed up to 3 times per case before you must accept or deny it.
#### 🔌 Usage
-
-
```typescript
await client.resolutionCenterCases.requestInfo({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RequestInfoResolutionCenterCasesRequest`
-
**requestOptions:** `ResolutionCenterCasesClient.RequestOptions`
client.resolutionCenterCases.withdraw({ ...params }) -> Whop.ResolutionCenterCase
-
#### 📝 Description
-
-
Withdraws (cancels) a case you opened, as the customer. Only possible while the case is still open.
#### 🔌 Usage
-
-
```typescript
await client.resolutionCenterCases.withdraw({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.WithdrawResolutionCenterCasesRequest`
-
**requestOptions:** `ResolutionCenterCasesClient.RequestOptions`
client.reviews.list({ ...params }) -> core.Page<Whop.ReviewListItem, Whop.ListReviewsResponse>
-
#### 📝 Description
-
-
Lists the published reviews for a product or account. Without `account_id` or `product_id`, a user lists the reviews they wrote, an account or app API key lists its account's reviews, and a request without credentials returns 400.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.reviews.list({
account_id: "biz_xxxxxxxxxxxxxx",
product_id: "prod_xxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.reviews.list({
account_id: "biz_xxxxxxxxxxxxxx",
product_id: "prod_xxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListReviewsRequest`
-
**requestOptions:** `ReviewsClient.RequestOptions`
client.reviews.retrieve({ ...params }) -> Whop.Review
-
#### 📝 Description
-
-
Retrieves a published review. Reviews that are not published return 404.
#### 🔌 Usage
-
-
```typescript
await client.reviews.retrieve({
id: "rev_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveReviewsRequest`
-
**requestOptions:** `ReviewsClient.RequestOptions`
client.reviews.delete({ ...params }) -> Whop.DeleteReviewsResponse
-
#### 📝 Description
-
-
Deletes a review the signed-in user wrote. Requires the `review:delete` scope, and returns 404 for a review another user wrote.
#### 🔌 Usage
-
-
```typescript
await client.reviews.delete({
id: "rev_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteReviewsRequest`
-
**requestOptions:** `ReviewsClient.RequestOptions`
client.setupIntents.list({ ...params }) -> core.Page<Whop.SetupIntent, Whop.ListSetupIntentsResponse>
-
#### 📝 Description
-
-
Lists setup intents newest first. An account API key lists its own account; a user token lists every account it can read, or one account with `account_id`.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.setupIntents.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.setupIntents.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListSetupIntentsRequest`
-
**requestOptions:** `SetupIntentsClient.RequestOptions`
client.setupIntents.create({ ...params }) -> Whop.SetupIntent
-
#### 📝 Description
-
-
Saves a buyer's payment method for later without charging it — one the buyer just supplied through the payment elements in setup mode, or one already on file to re-verify. The setup completes in the background, so the response is the setup intent as created, not its outcome: hand `client_secret` to the elements' `handleNextAction`, or poll Retrieve setup status. A buyer's own token holding `member:payment_methods:use` may create a setup intent for itself from a confirmation token.
#### 🔌 Usage
-
-
```typescript
await client.setupIntents.create({
account_id: "biz_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateSetupIntentsRequest`
-
**requestOptions:** `SetupIntentsClient.RequestOptions`
client.setupIntents.retrieve({ ...params }) -> Whop.SetupIntent
-
#### 📝 Description
-
-
Retrieves a setup intent. Once its `status` is `succeeded`, charge the saved method by its `payment_method_id`. The buyer's own token may retrieve a setup intent that belongs to it.
#### 🔌 Usage
-
-
```typescript
await client.setupIntents.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveSetupIntentsRequest`
-
**requestOptions:** `SetupIntentsClient.RequestOptions`
client.setupIntents.updateReturnUrl({ ...params }) -> Whop.SetupStatus
-
#### 📝 Description
-
-
Changes where the buyer lands after completing an off-site step, up until they return. Accepts either a secret key or the setup's own `client_secret` in the body, so the surface that knows the final destination can set it.
#### 🔌 Usage
-
-
```typescript
await client.setupIntents.updateReturnUrl({
setup_intent_id: "setup_intent_id",
return_url: "https://shinetime.example/checkout/thanks"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateReturnUrlSetupIntentsRequest`
-
**requestOptions:** `SetupIntentsClient.RequestOptions`
client.setupIntents.retrieveStatus({ ...params }) -> Whop.SetupStatus
-
#### 📝 Description
-
-
Retrieves how far a setup has got and what the buyer must do next, if anything. Collection runs in the background, so poll this rather than reading the create response. Accepts either a secret key or the setup's own `client_secret` as a query parameter, so the surface collecting the payment method can poll it directly.
#### 🔌 Usage
-
-
```typescript
await client.setupIntents.retrieveStatus({
setup_intent_id: "setup_intent_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveStatusSetupIntentsRequest`
-
**requestOptions:** `SetupIntentsClient.RequestOptions`
client.shipments.list({ ...params }) -> core.Page<Whop.Shipment, Whop.ListShipmentsResponse>
-
#### 📝 Description
-
-
Lists an account's shipments.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.shipments.list({
payment_id: ["pay_xxxxxxxxxxxxxx"]
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.shipments.list({
payment_id: ["pay_xxxxxxxxxxxxxx"]
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListShipmentsRequest`
-
**requestOptions:** `ShipmentsClient.RequestOptions`
client.shipments.create({ ...params }) -> Whop.Shipment
-
#### 📝 Description
-
-
Attaches a carrier tracking number to a payment and begins tracking it.
#### 🔌 Usage
-
-
```typescript
await client.shipments.create({
payment_id: "pay_xxxxxxxxxxxxxx",
tracking_number: "1Z999AA10123456784"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateShipmentsRequest`
-
**requestOptions:** `ShipmentsClient.RequestOptions`
client.shipments.lookup({ ...params }) -> Whop.ShipmentLookup
-
#### 📝 Description
-
-
Finds the delivery for a purchase from an account with customer tracking turned on, using exactly one order or tracking number plus the buyer's current receipt email. No authentication is required and no sign-in or session is created. Email matching ignores case and surrounding whitespace, but dots and +tags must match. Every miss returns the same 404: an unknown account, tracking turned off, a wrong number or email, an unpaid order or a purchase with nothing to ship. `shipment` is `null` while a paid physical purchase has no tracking yet. Limited to 30 attempts per five minutes per client IP. Responses are never cached or replayed with Idempotency-Key.
#### 🔌 Usage
-
-
```typescript
await client.shipments.lookup({
account_id: "biz_xxxxxxxxxxxxxx",
email: "marcus@shinetime.example"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.LookupShipmentsRequest`
-
**requestOptions:** `ShipmentsClient.RequestOptions`
client.shipments.retrieve({ ...params }) -> Whop.Shipment
-
#### 📝 Description
-
-
Retrieves a shipment by its ID, or by the ID of the payment it fulfills.
#### 🔌 Usage
-
-
```typescript
await client.shipments.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveShipmentsRequest`
-
**requestOptions:** `ShipmentsClient.RequestOptions`
client.shipments.update({ ...params }) -> Whop.Shipment
-
#### 📝 Description
-
-
Updates a shipment's tracking number and re-tracks it with the carrier.
#### 🔌 Usage
-
-
```typescript
await client.shipments.update({
id: "id",
tracking_number: "9400111899223456789012"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateShipmentsRequest`
-
**requestOptions:** `ShipmentsClient.RequestOptions`
client.socialAccounts.list({ ...params }) -> core.Page<Whop.SocialAccount, Whop.ListSocialAccountsResponse>
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. List external accounts with `GET /external_accounts` instead.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.socialAccounts.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.socialAccounts.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListSocialAccountsRequest`
-
**requestOptions:** `SocialAccountsClient.RequestOptions`
client.socialAccounts.create({ ...params }) -> Whop.SocialAccount
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. Create external accounts with `POST /external_accounts` instead.
#### 🔌 Usage
-
-
```typescript
await client.socialAccounts.create({
platform: "facebook"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateSocialAccountsRequest`
-
**requestOptions:** `SocialAccountsClient.RequestOptions`
client.socialAccounts.connect({ ...params }) -> Whop.ConnectSocialAccountsResponse
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. Connect external accounts with `POST /external_accounts/connect` instead.
#### 🔌 Usage
-
-
```typescript
await client.socialAccounts.connect({
platform: "meta_business",
redirect_url: "https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/ads/settings"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ConnectSocialAccountsRequest`
-
**requestOptions:** `SocialAccountsClient.RequestOptions`
client.socialAccounts.delete({ ...params }) -> Whop.DeleteSocialAccountsResponse
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. Disconnect external accounts with `DELETE /external_accounts/{id}` instead.
#### 🔌 Usage
-
-
```typescript
await client.socialAccounts.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteSocialAccountsRequest`
-
**requestOptions:** `SocialAccountsClient.RequestOptions`
client.socialAccounts.leadForms({ ...params }) -> Whop.LeadFormsSocialAccountsResponse
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. List lead forms with `GET /external_accounts/{id}/lead_forms` instead.
#### 🔌 Usage
-
-
```typescript
await client.socialAccounts.leadForms({
id: "id",
account_id: "account_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.LeadFormsSocialAccountsRequest`
-
**requestOptions:** `SocialAccountsClient.RequestOptions`
client.socialAccounts.partners({ ...params }) -> core.Page<Whop.SocialAccount, Whop.PartnersSocialAccountsResponse>
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. List partners with `GET /external_accounts/{external_account_id}/partners` instead.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.socialAccounts.partners({
id: "id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.socialAccounts.partners({
id: "id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.PartnersSocialAccountsRequest`
-
**requestOptions:** `SocialAccountsClient.RequestOptions`
client.socialAccounts.addPartner({ ...params }) -> Whop.SocialAccount
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. Add partners with `POST /external_accounts/{external_account_id}/partners` instead.
#### 🔌 Usage
-
-
```typescript
await client.socialAccounts.addPartner({
id: "id",
username: "@luverahealth"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.AddPartnerSocialAccountsRequest`
-
**requestOptions:** `SocialAccountsClient.RequestOptions`
client.socialAccounts.removePartner({ ...params }) -> Whop.RemovePartnerSocialAccountsResponse
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. Remove partners with `DELETE /external_accounts/{external_account_id}/partners/{id}` instead.
#### 🔌 Usage
-
-
```typescript
await client.socialAccounts.removePartner({
id: "id",
partner_id: "partner_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RemovePartnerSocialAccountsRequest`
-
**requestOptions:** `SocialAccountsClient.RequestOptions`
client.socialAccounts.posts({ ...params }) -> core.Page<Whop.SocialAccountPost, Whop.PostsSocialAccountsResponse>
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. List posts with `GET /external_accounts/{id}/posts` instead.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.socialAccounts.posts({
id: "id",
account_id: "account_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.socialAccounts.posts({
id: "id",
account_id: "account_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.PostsSocialAccountsRequest`
-
**requestOptions:** `SocialAccountsClient.RequestOptions`
client.socialAccounts.refresh({ ...params }) -> Whop.SocialAccount
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. Refresh external accounts with `POST /external_accounts/{id}/refresh` instead.
#### 🔌 Usage
-
-
```typescript
await client.socialAccounts.refresh({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RefreshSocialAccountsRequest`
-
**requestOptions:** `SocialAccountsClient.RequestOptions`
client.stats.list() -> Whop.ListStatsResponse
-
#### 📝 Description
-
-
Deprecated. Lists every metric without saying which ones you can chart. List chartable metrics with `GET /stats/time_series`, and aggregates that are not bucketed over time with `GET /stats/reports`.
#### 🔌 Usage
-
-
```typescript
await client.stats.list();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `StatsClient.RequestOptions`
client.stats.retrieve({ ...params }) -> Whop.RetrieveStatsResponse
-
#### 📝 Description
-
-
Deprecated compatibility endpoint. Retrieve a metric's time series with `GET /stats/time_series/{metric}` instead.
#### 🔌 Usage
-
-
```typescript
await client.stats.retrieve({
metric: "metric",
from: "from",
to: "to",
ad_campaign_ids: ["adcamp_xxxxxxxxxxxxxx"],
ad_group_ids: ["adgrp_xxxxxxxxxxxxxx"],
ad_ids: ["ad_xxxxxxxxxxxxxx"]
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveStatsRequest`
-
**requestOptions:** `StatsClient.RequestOptions`
client.supportChannels.list({ ...params }) -> core.Page<Whop.SupportChannelListItem, Whop.ListSupportChannelsResponse>
-
#### 📝 Description
-
-
Lists support channels between an account's team and its customers, most recently active first by default. Pass `open=true` to find channels awaiting a support response.
Required permissions:
- `support_chat:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.supportChannels.list({
first: 42,
last: 42,
account_id: "biz_xxxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.supportChannels.list({
first: 42,
last: 42,
account_id: "biz_xxxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListSupportChannelsRequest`
-
**requestOptions:** `SupportChannelsClient.RequestOptions`
client.supportChannels.create({ ...params }) -> Whop.SupportChannel
-
#### 📝 Description
-
-
Opens a support channel between an account's team and a customer. Returns the existing channel if that customer already has one.
Required permissions:
- `support_chat:create`
#### 🔌 Usage
-
-
```typescript
await client.supportChannels.create({
account_id: "biz_xxxxxxxxxxxxxx",
user_id: "user_xxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateSupportChannelsRequest`
-
**requestOptions:** `SupportChannelsClient.RequestOptions`
client.supportChannels.retrieve({ ...params }) -> Whop.SupportChannel
-
#### 📝 Description
-
-
Retrieves the details of an existing support channel.
Required permissions:
- `support_chat:read`
#### 🔌 Usage
-
-
```typescript
await client.supportChannels.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveSupportChannelsRequest`
-
**requestOptions:** `SupportChannelsClient.RequestOptions`
client.swaps.list({ ...params }) -> Whop.ListSwapsResponse
-
#### 📝 Description
-
-
Lists the completed or pending swaps for an account or user — currently only the most recent one.
#### 🔌 Usage
-
-
```typescript
await client.swaps.list();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListSwapsRequest`
-
**requestOptions:** `SwapsClient.RequestOptions`
client.swaps.create({ ...params }) -> Whop.CreateSwapsResponse
-
#### 📝 Description
-
-
Swaps one token for another in an account or user's wallet, or converts between their fiat balances at the mid-market rate. Crypto swaps finish in the background — retrieve the swap to follow its status.
#### 🔌 Usage
-
-
```typescript
await client.swaps.create({
from_token: "usd",
to_token: "cad"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateSwapsRequest`
-
**requestOptions:** `SwapsClient.RequestOptions`
client.swaps.createQuote({ ...params }) -> Whop.CreateQuoteSwapsResponse
-
#### 📝 Description
-
-
Previews the price of a swap before you create it. Fiat pairs quote the mid-market rate — the same rate creating the swap fills at. No funds move, nothing is saved, and no authentication is required.
#### 🔌 Usage
-
-
```typescript
await client.swaps.createQuote({
amount: "100",
from_token: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
to_token: "0x1b64b9025eebb9a6239575df9ea4b9ac46d4d193"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateQuoteSwapsRequest`
-
**requestOptions:** `SwapsClient.RequestOptions`
client.swaps.retrieve({ ...params }) -> Whop.RetrieveSwapsResponse
-
#### 📝 Description
-
-
Retrieves a swap and its status. Poll it after creating a crypto swap, which finishes in the background.
#### 🔌 Usage
-
-
```typescript
await client.swaps.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveSwapsRequest`
-
**requestOptions:** `SwapsClient.RequestOptions`
client.teamMembers.list({ ...params }) -> core.Page<Whop.TeamMember, Whop.ListTeamMembersResponse>
-
#### 📝 Description
-
-
Lists an account's team members, including pending invites. A user credential with `company:basic:read` may list only its own joined membership by passing its own `user_id` and `status=joined`. Listing `role=workforce` is also allowed with the `bounty:create` scope. Members with the view-only Partner role are listed after all other members.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.teamMembers.list({
account_id: "account_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.teamMembers.list({
account_id: "account_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListTeamMembersRequest`
-
**requestOptions:** `TeamMembersClient.RequestOptions`
client.teamMembers.create({ ...params }) -> Whop.TeamMember
-
#### 📝 Description
-
-
Adds a member to an account's team with a system role. Identify them by exactly one of `user_id` or `email`. If the person has not yet accepted, or the email does not belong to a Whop account yet, an invitation is sent instead and the response is `202` with the pending team member, whose `status` is `pending` and whose id is prefixed `ausri_`. If they already have a pending invite, the request fails with a `400`. Granting the `workforce` role is also allowed with the `bounty:create` scope.
#### 🔌 Usage
-
-
```typescript
await client.teamMembers.create({
account_id: "biz_xxxxxxxxxxxxxx",
role: "sales_manager",
user_id: "user_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateTeamMembersRequest`
-
**requestOptions:** `TeamMembersClient.RequestOptions`
client.teamMembers.retrieve({ ...params }) -> Whop.TeamMember
-
#### 📝 Description
-
-
Retrieves a team member or pending invite by ID.
#### 🔌 Usage
-
-
```typescript
await client.teamMembers.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveTeamMembersRequest`
-
**requestOptions:** `TeamMembersClient.RequestOptions`
client.teamMembers.delete({ ...params }) -> Whop.DeleteTeamMembersResponse
-
#### 📝 Description
-
-
Removes a team member from the account, or revokes a pending invite when given an `ausri_` ID. A user session may delete its own membership to leave the team without the delete scope. Removing a member on the `workforce` role is also allowed with the `bounty:create` scope. The account owner cannot be removed.
#### 🔌 Usage
-
-
```typescript
await client.teamMembers.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteTeamMembersRequest`
-
**requestOptions:** `TeamMembersClient.RequestOptions`
client.teamMembers.update({ ...params }) -> Whop.TeamMember
-
#### 📝 Description
-
-
Changes a team member's system role. Requires a user session — account API keys cannot change member roles. The account owner's role cannot be changed, and you cannot change your own role.
#### 🔌 Usage
-
-
```typescript
await client.teamMembers.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateTeamMembersRequest`
-
**requestOptions:** `TeamMembersClient.RequestOptions`
client.trades.list({ ...params }) -> core.Page<Whop.Trade, Whop.ListTradesResponse>
-
#### 📝 Description
-
-
Lists trades you can access, newest first. User credentials see their own trades and those of accounts they belong to, including connected accounts; account credentials see their account and its connected accounts.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.trades.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.trades.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListTradesRequest`
-
**requestOptions:** `TradesClient.RequestOptions`
client.trades.create({ ...params }) -> Whop.Trade
-
#### 📝 Description
-
-
Places an order, closes a perpetual position, or deposits to or withdraws from the trading balance, from the Whop-managed wallet of an account or user. Answers `201` with the trade in `pending`; it runs in the background, so read it with `GET /trades/:id` until its `status` is `completed`, `failed` or `in_review`. Trades run alongside each other, except a second order on one market at a different leverage, which answers `409`. A retry with the same `Idempotency-Key` returns the same trade.
#### 🔌 Usage
-
-
```typescript
await client.trades.create({
account_id: "biz_xxxxxxxxxxxxxx",
type: "close"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateTradesRequest`
-
**requestOptions:** `TradesClient.RequestOptions`
client.trades.retrieve({ ...params }) -> Whop.Trade
-
#### 📝 Description
-
-
Retrieves a trade. Read it until its `status` is `completed`, `failed` or `in_review`.
#### 🔌 Usage
-
-
```typescript
await client.trades.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveTradesRequest`
-
**requestOptions:** `TradesClient.RequestOptions`
client.transfers.list({ ...params }) -> core.Page<Whop.ListTransfersResponse.Data.Item, Whop.ListTransfersResponse>
-
#### 📝 Description
-
-
Lists the transfers you can see, sent or received, newest first by default. Optional account filters narrow the results.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.transfers.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.transfers.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListTransfersRequest`
-
**requestOptions:** `TransfersClient.RequestOptions`
client.transfers.create({ ...params }) -> Whop.CreateTransfersResponse
-
#### 📝 Description
-
-
Moves money between Whop balances or funds a claim link anyone with the URL can redeem. The `type` you send decides which object comes back.
#### 🔌 Usage
-
-
```typescript
await client.transfers.create({
type: "balance",
amount: 25,
currency: "usd",
destination_id: "user_xxxxxxxxxxxxxx",
origin_id: "biz_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateTransfersRequestBody`
-
**requestOptions:** `TransfersClient.RequestOptions`
client.transfers.listRecipients({ ...params }) -> core.Page<Whop.ListRecipientsTransfersResponseDataItem, Whop.ListRecipientsTransfersResponse>
-
#### 📝 Description
-
-
Lists the people and accounts you can send money to from a balance. Pass a result's ID as `destination_id` when creating a transfer.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.transfers.listRecipients({
origin_id: "origin_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.transfers.listRecipients({
origin_id: "origin_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListRecipientsTransfersRequest`
-
**requestOptions:** `TransfersClient.RequestOptions`
client.transfers.retrieve({ ...params }) -> Whop.RetrieveTransfersResponse
-
#### 📝 Description
-
-
Retrieves a single transfer.
#### 🔌 Usage
-
-
```typescript
await client.transfers.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveTransfersRequest`
-
**requestOptions:** `TransfersClient.RequestOptions`
client.users.list({ ...params }) -> core.Page<Whop.User, Whop.ListUsersResponse>
-
#### 📝 Description
-
-
Searches for users by name or username, ranked by social proximity to the authenticated user. Without a `query`, returns the user's most recently followed users.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.users.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.users.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListUsersRequest`
-
**requestOptions:** `UsersClient.RequestOptions`
client.users.me({ ...params }) -> Whop.User
-
#### 📝 Description
-
-
Retrieves the authenticated user. Same as `GET /users/:id` with the reserved id `me`: the self view, where self-only fields such as `email`, `balance`, and `cards` can be populated.
#### 🔌 Usage
-
-
```typescript
await client.users.me();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.MeUsersRequest`
-
**requestOptions:** `UsersClient.RequestOptions`
client.users.updateMe({ ...params }) -> Whop.User
-
#### 📝 Description
-
-
Updates the authenticated user's global profile, or their profile override for an account when `account_id` is given. Not available to API keys.
#### 🔌 Usage
-
-
```typescript
await client.users.updateMe();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateMeUsersRequest`
-
**requestOptions:** `UsersClient.RequestOptions`
client.users.retrieve({ ...params }) -> Whop.User
-
#### 📝 Description
-
-
Retrieves a user by `user_` tag or username, or the authenticated user with the reserved id `me`. Self-only fields such as `email`, `balance`, and `earnings_usd` are populated only when the id is `me`, and are always `null` when addressing a user by tag or username.
#### 🔌 Usage
-
-
```typescript
await client.users.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveUsersRequest`
-
**requestOptions:** `UsersClient.RequestOptions`
client.users.update({ ...params }) -> Whop.User
-
#### 📝 Description
-
-
Updates a user, addressed by `user_` tag, username, or the reserved id `me` for the authenticated user. A user token updates their own global profile; an API key updates the user's profile override for the account in `account_id`.
#### 🔌 Usage
-
-
```typescript
await client.users.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateUsersRequest`
-
**requestOptions:** `UsersClient.RequestOptions`
client.users.checkAccess({ ...params }) -> Whop.CheckAccessUsersResponse
-
#### 📝 Description
-
-
Checks whether a user has access to an account, product, or experience the caller can reach.
#### 🔌 Usage
-
-
```typescript
await client.users.checkAccess({
id: "id",
resource_id: "resource_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CheckAccessUsersRequest`
-
**requestOptions:** `UsersClient.RequestOptions`
client.users.recommendActions({ ...params }) -> Whop.RecommendActionsUsersResponse
-
#### 📝 Description
-
-
Lists the recommended actions computed for the authenticated user: personal suggestions, such as starting a business or becoming an affiliate, pooled with the highest-impact actions across the accounts the user owns. You can only list your own recommended actions.
#### 🔌 Usage
-
-
```typescript
await client.users.recommendActions({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RecommendActionsUsersRequest`
-
**requestOptions:** `UsersClient.RequestOptions`
client.variants.list({ ...params }) -> core.Page<Whop.VariantListItem, Whop.ListVariantsResponse>
-
#### 📝 Description
-
-
Lists an account's variants, leaving out variants generated for a legacy invoice; retrieve one of those by ID. To list a product's public, buyable variants without authentication, omit `account_id` and pass `product_ids`.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.variants.list({
release_methods: ["buy_now"],
visibilities: ["visible"],
billing_types: ["renewal"],
product_ids: ["prod_xxxxxxxxxxxxxx"],
presentment_currency: "auto",
ip_address: "203.0.113.7",
presentment_country: "JP"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.variants.list({
release_methods: ["buy_now"],
visibilities: ["visible"],
billing_types: ["renewal"],
product_ids: ["prod_xxxxxxxxxxxxxx"],
presentment_currency: "auto",
ip_address: "203.0.113.7",
presentment_country: "JP"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListVariantsRequest`
-
**requestOptions:** `VariantsClient.RequestOptions`
client.variants.create({ ...params }) -> Whop.Variant
-
#### 📝 Description
-
-
Creates a pricing variant for a product, defining the billing interval, price, and availability customers buy it with.
#### 🔌 Usage
-
-
```typescript
await client.variants.create();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateVariantsRequest`
-
**requestOptions:** `VariantsClient.RequestOptions`
client.variants.retrieve({ ...params }) -> Whop.Variant
-
#### 📝 Description
-
-
Retrieves a variant. Requires no authentication; fields that need a permission are `null` for callers without it.
#### 🔌 Usage
-
-
```typescript
await client.variants.retrieve({
id: "id",
presentment_currency: "auto",
ip_address: "203.0.113.7",
presentment_country: "JP"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveVariantsRequest`
-
**requestOptions:** `VariantsClient.RequestOptions`
client.variants.delete({ ...params }) -> Whop.DeleteVariantsResponse
-
#### 📝 Description
-
-
Deletes a variant from a product. It stops selling immediately; existing memberships on it are unaffected.
#### 🔌 Usage
-
-
```typescript
await client.variants.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteVariantsRequest`
-
**requestOptions:** `VariantsClient.RequestOptions`
client.variants.update({ ...params }) -> Whop.Variant
-
#### 📝 Description
-
-
Updates a variant's pricing, billing interval, visibility, stock, and other settings.
#### 🔌 Usage
-
-
```typescript
await client.variants.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateVariantsRequest`
-
**requestOptions:** `VariantsClient.RequestOptions`
client.variants.calculateTax({ ...params }) -> Whop.CalculateTaxVariantsResponse
-
#### 📝 Description
-
-
Deprecated. Quote tax with `POST /payment_quotes` instead. Previews tax for a variant before checkout, based on the buyer's location.
#### 🔌 Usage
-
-
```typescript
await client.variants.calculateTax({
id: "id",
address: {
country: "DE",
postal_code: "10115"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CalculateTaxVariantsRequest`
-
**requestOptions:** `VariantsClient.RequestOptions`
client.verifications.list({ ...params }) -> core.Page<Whop.ListVerificationsResponse.Data.Item, Whop.ListVerificationsResponse>
-
#### 📝 Description
-
-
Lists the verifications for an account or user, including their status and any required actions. Platforms list their own and every subaccount's verifications at once with `include_subaccounts`; each one's `account_ids` names its account, and a verification shared by several accounts appears once for each.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.verifications.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.verifications.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListVerificationsRequest`
-
**requestOptions:** `VerificationsClient.RequestOptions`
client.verifications.create({ ...params }) -> Whop.CreateVerificationsResponse
-
#### 📝 Description
-
-
Starts a hosted verification session for an account or user, or returns the active session when one already exists; any fields you send prefill it. To skip the hosted session, send `documents` to verify the person from files in this request, `share_token` to reuse a verification another Sumsub account completed, or `verification_id` to reuse one the signed-in user completed on Whop. For a business, `documents` and `owners` add company formation documents and owners to the verification, and once everything is in this call sends the business for review — call it again after Update Verification to send it. Until then it stays `pending` and the hosted session collects anything left out. Once the account has an `approved` verification, every mode except `verification_id` is rejected — unlink it first to start a new one.
#### 🔌 Usage
-
-
```typescript
await client.verifications.create({
body: {
kind: "individual"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateVerificationsRequest`
-
**requestOptions:** `VerificationsClient.RequestOptions`
client.verifications.retrieve({ ...params }) -> Whop.RetrieveVerificationsResponse
-
#### 📝 Description
-
-
Retrieves a verification by ID, including its status and any information or documents still required.
#### 🔌 Usage
-
-
```typescript
await client.verifications.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveVerificationsRequest`
-
**requestOptions:** `VerificationsClient.RequestOptions`
client.verifications.update({ ...params }) -> Whop.UpdateVerificationsResponse
-
#### 📝 Description
-
-
Updates editable profile details or submits answers for items returned in `requested_information`. On a business verification still collecting details, company details, `documents`, and `owners` also go to the verification provider; call Create Verification again to send the business for review once everything is in. Under review, `registration_number`, `incorporation_date`, `place_of_incorporation`, and `documents` are refused. While the review waits on owners, owners can still be added, changed, or removed with `remove`; otherwise only an owner's missing documents can still be sent. Once a verification is `approved` its profile details are locked and can no longer be edited.
#### 🔌 Usage
-
-
```typescript
await client.verifications.update({
id: "id",
body: {}
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateVerificationsRequest`
-
**requestOptions:** `VerificationsClient.RequestOptions`
client.waitlistEntries.list({ ...params }) -> core.Page<Whop.WaitlistEntry, Whop.ListWaitlistEntriesResponse>
-
#### 📝 Description
-
-
Lists the waitlist signups you can see. `waitlist_entry:read` returns your own signups, and `plan:waitlist:read` returns signups to the seller accounts you are authorized on; with both, you get both sets. Signups submitted on behalf of an account are not in this list; pass `buyer_account_id` to list them instead, which needs `waitlist_entry:read` on that account. Account credentials see the signups submitted to their own account, and pass their own account as `buyer_account_id` to see the ones it submitted.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.waitlistEntries.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.waitlistEntries.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListWaitlistEntriesRequest`
-
**requestOptions:** `WaitlistEntriesClient.RequestOptions`
client.waitlistEntries.create({ ...params }) -> Whop.WaitlistEntry
-
#### 📝 Description
-
-
Joins a free waitlist variant as the authenticated user, or on behalf of an account with `buyer_account_id`. Requires `waitlist_entry:create`, on that account when one is given. Joining again returns the existing pending signup, or the approved one while its membership is valid. Paid variants are rejected; joining collects no payment method and grants no membership.
#### 🔌 Usage
-
-
```typescript
await client.waitlistEntries.create({
variant_id: "plan_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateWaitlistEntriesRequest`
-
**requestOptions:** `WaitlistEntriesClient.RequestOptions`
client.waitlistEntries.approveAll({ ...params }) -> Whop.ApproveAllWaitlistEntriesResponse
-
#### 📝 Description
-
-
Queues approval of every pending signup for an account, optionally narrowed to a variant. Requires `plan:waitlist:manage`. Paid signups may charge saved payment methods. Approval runs asynchronously: list signups with `status` set to `pending` to follow progress, and retrieve a signup to read its outcome. Signups created after this request are excluded.
#### 🔌 Usage
-
-
```typescript
await client.waitlistEntries.approveAll({
account_id: "biz_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ApproveAllWaitlistEntriesRequest`
-
**requestOptions:** `WaitlistEntriesClient.RequestOptions`
client.waitlistEntries.retrieve({ ...params }) -> Whop.WaitlistEntry
-
#### 📝 Description
-
-
Retrieves your own signup or one submitted on behalf of an account you hold `waitlist_entry:read` on, or one submitted to an account you can read, with `plan:waitlist:read`.
#### 🔌 Usage
-
-
```typescript
await client.waitlistEntries.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveWaitlistEntriesRequest`
-
**requestOptions:** `WaitlistEntriesClient.RequestOptions`
client.waitlistEntries.approve({ ...params }) -> Whop.WaitlistEntry
-
#### 📝 Description
-
-
Queues approval of a pending signup. Requires `plan:waitlist:manage` on its seller account. Paid signups may charge their saved payment method. Returns the signup's current state; retrieve it to read `status` and `approval_failure_reason` after processing.
#### 🔌 Usage
-
-
```typescript
await client.waitlistEntries.approve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ApproveWaitlistEntriesRequest`
-
**requestOptions:** `WaitlistEntriesClient.RequestOptions`
client.waitlistEntries.cancel({ ...params }) -> Whop.WaitlistEntry
-
#### 📝 Description
-
-
Withdraws a pending signup: your own, or one submitted on behalf of an account you hold `waitlist_entry:cancel` on. Requires `waitlist_entry:cancel`, on that account for an account's signup. Does not cancel an approved membership.
#### 🔌 Usage
-
-
```typescript
await client.waitlistEntries.cancel({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CancelWaitlistEntriesRequest`
-
**requestOptions:** `WaitlistEntriesClient.RequestOptions`
client.waitlistEntries.deny({ ...params }) -> Whop.WaitlistEntry
-
#### 📝 Description
-
-
Denies a pending signup. Requires `plan:waitlist:manage` on its seller account.
#### 🔌 Usage
-
-
```typescript
await client.waitlistEntries.deny({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DenyWaitlistEntriesRequest`
-
**requestOptions:** `WaitlistEntriesClient.RequestOptions`
client.webhooks.list({ ...params }) -> core.Page<Whop.WebhookListItem, Whop.ListWebhooksResponse>
-
#### 📝 Description
-
-
Returns a paginated list of webhook endpoints configured for an account, ordered by most recently created.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.webhooks.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.webhooks.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListWebhooksRequest`
-
**requestOptions:** `WebhooksClient.RequestOptions`
client.webhooks.create({ ...params }) -> Whop.Webhook
-
#### 📝 Description
-
-
Creates a webhook endpoint that receives event notifications via HTTP POST.
#### 🔌 Usage
-
-
```typescript
await client.webhooks.create({
url: "https://example.com/hooks"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.CreateWebhooksRequest`
-
**requestOptions:** `WebhooksClient.RequestOptions`
client.webhooks.retrieve({ ...params }) -> Whop.Webhook
-
#### 📝 Description
-
-
Retrieves the details of an existing webhook.
#### 🔌 Usage
-
-
```typescript
await client.webhooks.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.RetrieveWebhooksRequest`
-
**requestOptions:** `WebhooksClient.RequestOptions`
client.webhooks.delete({ ...params }) -> Whop.DeleteWebhooksResponse
-
#### 📝 Description
-
-
Permanently deletes a webhook endpoint. To stop deliveries without deleting it, set `enabled` to `false` with `PATCH /webhooks/:id`.
#### 🔌 Usage
-
-
```typescript
await client.webhooks.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.DeleteWebhooksRequest`
-
**requestOptions:** `WebhooksClient.RequestOptions`
client.webhooks.update({ ...params }) -> Whop.Webhook
-
#### 📝 Description
-
-
Updates a webhook endpoint's URL, subscribed events, pinned payload version, or enabled state.
#### 🔌 Usage
-
-
```typescript
await client.webhooks.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.UpdateWebhooksRequest`
-
**requestOptions:** `WebhooksClient.RequestOptions`
client.webhooks.listDeliveries({ ...params }) -> core.Page<Whop.WebhookDelivery, Whop.ListDeliveriesWebhooksResponse>
-
#### 📝 Description
-
-
Returns a paginated list of delivery attempts for a webhook, ordered by most recent first. Includes the request payload, response body, response code, and timing for each attempt. Filtered queries use a bounded read budget, so a page may be partial or empty. Continue with `page_info.end_cursor` while `page_info.has_next_page` is `true`.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.webhooks.listDeliveries({
id: "id",
resource_id: "pay_xxxxxxxxxxxxx"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.webhooks.listDeliveries({
id: "id",
resource_id: "pay_xxxxxxxxxxxxx"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ListDeliveriesWebhooksRequest`
-
**requestOptions:** `WebhooksClient.RequestOptions`
client.webhooks.replayDelivery({ ...params }) -> Whop.ReplayDeliveryWebhooksResponse
-
#### 📝 Description
-
-
Re-sends the exact payload of a past delivery to the webhook's current URL and returns the delivery result. The replay keeps the original `webhook-id` unless you pass `regenerate_id`, so consumers that deduplicate on it can drop events they already processed. Only available for enabled webhooks on API version `v1`; deliveries are retained for 30 days.
#### 🔌 Usage
-
-
```typescript
await client.webhooks.replayDelivery({
id: "id",
delivery_id: "delivery_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ReplayDeliveryWebhooksRequest`
-
**requestOptions:** `WebhooksClient.RequestOptions`
client.webhooks.replay({ ...params }) -> Whop.ReplayWebhooksResponse
-
#### 📝 Description
-
-
Re-sends the webhook's past deliveries within a time window, optionally limited to specific events or to failed deliveries. Use it to recover events your endpoint missed. The replay runs asynchronously and nothing about it is stored: each re-send appears as a new entry in the webhook's delivery log. Each matching message is re-sent once, with its original `webhook-id` unless you pass `regenerate_ids`. Only available for enabled webhooks on API version `v1`; deliveries are retained for 30 days.
#### 🔌 Usage
-
-
```typescript
await client.webhooks.replay({
id: "id",
sent_after: "2026-01-01T12:00:00.000Z"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.ReplayWebhooksRequest`
-
**requestOptions:** `WebhooksClient.RequestOptions`
client.webhooks.test({ ...params }) -> Whop.TestWebhooksResponse
-
#### 📝 Description
-
-
Sends a sample payload for the given event to the webhook's URL and returns the delivery result.
#### 🔌 Usage
-
-
```typescript
await client.webhooks.test({
id: "id",
event: "payment.succeeded"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.TestWebhooksRequest`
-
**requestOptions:** `WebhooksClient.RequestOptions`
client.accounts.customerTracking.retrieve({ ...params }) -> Whop.AccountCustomerTracking
-
#### 📝 Description
-
-
Retrieves the branding and support contacts the account's hosted customer tracking page and tracking Element display. Public by design, so no authentication is required. Returns 404 unless the account has turned customer tracking on in its preferences. Responses are never cached.
#### 🔌 Usage
-
-
```typescript
await client.accounts.customerTracking.retrieve({
account_id: "account_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.accounts.RetrieveCustomerTrackingRequest`
-
**requestOptions:** `CustomerTrackingClient.RequestOptions`
client.accounts.fees.retrieve({ ...params }) -> Whop.AccountFees
-
#### 📝 Description
-
-
Retrieves the account's fees as a single document keyed by fee, with any markups its platform adds. Connected accounts see the rates in effect for them. `adjustable` on each fee says what you may change with Update Account Fees.
#### 🔌 Usage
-
-
```typescript
await client.accounts.fees.retrieve({
account_id: "account_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.accounts.RetrieveFeesRequest`
-
**requestOptions:** `FeesClient.RequestOptions`
client.accounts.fees.update({ ...params }) -> Whop.AccountFees
-
#### 📝 Description
-
-
Updates the account's fees. Each key present in the body is replaced; omitted keys are left untouched. Only fees that Retrieve Account Fees reports as `adjustable` can be changed.
#### 🔌 Usage
-
-
```typescript
await client.accounts.fees.update({
account_id: "account_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.accounts.UpdateFeesRequest`
-
**requestOptions:** `FeesClient.RequestOptions`
client.accounts.financingProviders.list({ ...params }) -> core.Page<Whop.FinancingProvider, Whop.ListFinancingProvidersResponse>
-
#### 📝 Description
-
-
Lists every financing provider and where it stands for an account: whether checkout offers it, what the merchant can do to turn it on, and why it is off.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.accounts.financingProviders.list({
account_id: "account_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.accounts.financingProviders.list({
account_id: "account_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.accounts.ListFinancingProvidersRequest`
-
**requestOptions:** `FinancingProvidersClient.RequestOptions`
client.accounts.preferences.retrieve({ ...params }) -> Whop.RetrievePreferencesResponse
-
#### 📝 Description
-
-
Retrieves the account's preferences: a singleton settings document keyed by preference name.
#### 🔌 Usage
-
-
```typescript
await client.accounts.preferences.retrieve({
account_id: "account_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.accounts.RetrievePreferencesRequest`
-
**requestOptions:** `PreferencesClient.RequestOptions`
client.accounts.preferences.update({ ...params }) -> Whop.UpdatePreferencesResponse
-
#### 📝 Description
-
-
Updates the account's preferences. Each top-level key present in the body is replaced as a whole; omitted keys are left untouched.
Required scopes depend on the preferences being updated:
| Preferences | Required scope |
| --- | --- |
| `ads_payment_methods`, `ads_reporting_currency`, `ads_scheduling_timezone`, `ads_triple_whale_integration`, `ads_certifications` | `ad_campaign:create` |
| `cards_auto_top_up`, `cards_notifications`, `covers_connected_account_negative_balances` | `payout:account:update` |
| `dispute_fighter_enabled` | `payment:dispute` |
| `economic_intelligence_duration_key`, `economic_intelligence_auto_renew` | `company:update` |
| `feedback_options`, `customer_tracking` | `company:manage_checkout` |
When updating preferences from multiple rows, all corresponding scopes are required for the account.
#### 🔌 Usage
-
-
```typescript
await client.accounts.preferences.update({
account_id: "account_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.accounts.UpdatePreferencesRequest`
-
**requestOptions:** `PreferencesClient.RequestOptions`
client.accounts.reserves.list({ ...params }) -> Whop.ListReservesResponse
-
#### 📝 Description
-
-
Lists what the account's held balance is made of, one entry per currency: the total held, why each part is held, and the days it unlocks.
#### 🔌 Usage
-
-
```typescript
await client.accounts.reserves.list({
account_id: "account_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.accounts.ListReservesRequest`
-
**requestOptions:** `ReservesClient.RequestOptions`
client.affiliates.overrides.list({ ...params }) -> core.Page<Whop.ListOverridesResponse.Data.Item, Whop.ListOverridesResponse>
-
#### 📝 Description
-
-
Returns a paginated list of overrides for an affiliate.
Required permissions:
- `affiliate:basic:read`
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.affiliates.overrides.list({
id: "aff_xxxxxxxxxxxxxx",
first: 42,
last: 42
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.affiliates.overrides.list({
id: "aff_xxxxxxxxxxxxxx",
first: 42,
last: 42
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.affiliates.ListOverridesRequest`
-
**requestOptions:** `OverridesClient.RequestOptions`
client.affiliates.overrides.create({ ...params }) -> Whop.CreateOverridesResponse
-
#### 📝 Description
-
-
Creates a commission override for an affiliate.
Required permissions:
- `affiliate:create`
#### 🔌 Usage
-
-
```typescript
await client.affiliates.overrides.create({
id: "aff_xxxxxxxxxxxxxx",
body: {
override_type: "standard",
commission_value: 6.9,
id: "id",
plan_id: "plan_xxxxxxxxxxxxx"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.affiliates.CreateOverridesRequest`
-
**requestOptions:** `OverridesClient.RequestOptions`
client.affiliates.overrides.retrieve({ ...params }) -> Whop.RetrieveOverridesResponse
-
#### 📝 Description
-
-
Retrieves the details of a specific affiliate override.
Required permissions:
- `affiliate:basic:read`
#### 🔌 Usage
-
-
```typescript
await client.affiliates.overrides.retrieve({
id: "aff_xxxxxxxxxxxxxx",
override_id: "override_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.affiliates.RetrieveOverridesRequest`
-
**requestOptions:** `OverridesClient.RequestOptions`
client.affiliates.overrides.delete({ ...params }) -> boolean
-
#### 📝 Description
-
-
Deletes an affiliate override.
Required permissions:
- `affiliate:update`
#### 🔌 Usage
-
-
```typescript
await client.affiliates.overrides.delete({
id: "aff_xxxxxxxxxxxxxx",
override_id: "override_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.affiliates.DeleteOverridesRequest`
-
**requestOptions:** `OverridesClient.RequestOptions`
client.affiliates.overrides.update({ ...params }) -> Whop.UpdateOverridesResponse
-
#### 📝 Description
-
-
Updates an existing affiliate override.
Required permissions:
- `affiliate:update`
#### 🔌 Usage
-
-
```typescript
await client.affiliates.overrides.update({
id: "aff_xxxxxxxxxxxxxx",
override_id: "override_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.affiliates.UpdateOverridesRequest`
-
**requestOptions:** `OverridesClient.RequestOptions`
client.bounties.submissions.list({ ...params }) -> core.Page<Whop.PublicBountySubmission, Whop.ListSubmissionsResponse>
-
#### 📝 Description
-
-
Lists a bounty's publicly visible work — submitted, approved, and denied submissions in the reduced public shape. Authentication is optional; a bounty that is not publicly visible returns `404`.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.bounties.submissions.list({
bounty_id: "bounty_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.bounties.submissions.list({
bounty_id: "bounty_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.bounties.ListSubmissionsRequest`
-
**requestOptions:** `SubmissionsClient.RequestOptions`
client.bounties.submissions.retrieve({ ...params }) -> Whop.PublicBountySubmission
-
#### 📝 Description
-
-
Retrieves one of a bounty's publicly visible submissions in the reduced public shape — the read behind a shared proof link, whose submission is usually outside the bounty page's capped preview. Authentication is optional; a bounty that is not publicly visible, and a submission that is not publicly visible work on it, both return `404`.
#### 🔌 Usage
-
-
```typescript
await client.bounties.submissions.retrieve({
bounty_id: "bounty_id",
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.bounties.RetrieveSubmissionsRequest`
-
**requestOptions:** `SubmissionsClient.RequestOptions`
client.externalAccounts.partners.list({ ...params }) -> core.Page<Whop.ExternalAccount, Whop.ListPartnersResponse>
-
#### 📝 Description
-
-
Lists the creators an Instagram account runs partnership ads with, and where each creator's permission stands.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.externalAccounts.partners.list({
external_account_id: "external_account_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.externalAccounts.partners.list({
external_account_id: "external_account_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.externalAccounts.ListPartnersRequest`
-
**requestOptions:** `PartnersClient.RequestOptions`
client.externalAccounts.partners.create({ ...params }) -> Whop.ExternalAccount
-
#### 📝 Description
-
-
Invites an Instagram creator to run partnership ads with an Instagram account. The creator approves the invitation in the Instagram app, and `partnership_status` stays `pending` until they do; [refresh](/api-reference/beta/external-accounts/refresh) the partner to pick up their answer.
#### 🔌 Usage
-
-
```typescript
await client.externalAccounts.partners.create({
external_account_id: "external_account_id",
username: "@luverahealth"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.externalAccounts.CreatePartnersRequest`
-
**requestOptions:** `PartnersClient.RequestOptions`
client.externalAccounts.partners.delete({ ...params }) -> Whop.DeletePartnersResponse
-
#### 📝 Description
-
-
Revokes a creator's permission to run partnership ads with an Instagram account. Every account that advertises as the Instagram account loses the partner, since the permission belongs to the Instagram account.
#### 🔌 Usage
-
-
```typescript
await client.externalAccounts.partners.delete({
external_account_id: "external_account_id",
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.externalAccounts.DeletePartnersRequest`
-
**requestOptions:** `PartnersClient.RequestOptions`
client.externalAccounts.leadForms.list({ ...params }) -> Whop.ListLeadFormsResponse
-
#### 📝 Description
-
-
Lists the active lead (instant) forms that already exist on a connected Facebook page, so an ad can reuse one as its `lead_gen_form_id` instead of authoring a new form. Every active form comes back in a single response — the list is not paginated.
#### 🔌 Usage
-
-
```typescript
await client.externalAccounts.leadForms.list({
id: "id",
account_id: "account_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.externalAccounts.ListLeadFormsRequest`
-
**requestOptions:** `LeadFormsClient.RequestOptions`
client.externalAccounts.posts.list({ ...params }) -> core.Page<Whop.ExternalAccountPost, Whop.ListPostsResponse>
-
#### 📝 Description
-
-
Lists the existing posts of a connected Facebook page, Instagram account, or TikTok account.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.externalAccounts.posts.list({
id: "id",
account_id: "account_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.externalAccounts.posts.list({
id: "id",
account_id: "account_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.externalAccounts.ListPostsRequest`
-
**requestOptions:** `PostsClient.RequestOptions`
client.financialReports.breakdown.retrieve({ ...params }) -> Whop.RetrieveBreakdownResponse
-
#### 📝 Description
-
-
Breaks one bucket of a financial report, such as payments received or card spend, into the customers, accounts, merchants, or campaigns that contributed most, with the rest summed as a remainder. Use it to explain a total from `GET /financial_reports`.
#### 🔌 Usage
-
-
```typescript
await client.financialReports.breakdown.retrieve({
account_id: "account_id",
bucket: "transfers",
direction: "money_in",
currency: "currency",
from: "2024-01-15T09:30:00Z",
to: "2024-01-15T09:30:00Z"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.financialReports.RetrieveBreakdownRequest`
-
**requestOptions:** `BreakdownClient.RequestOptions`
client.members.logs.list({ ...params }) -> core.Page<Whop.ListLogsResponse.Data.Item, Whop.ListLogsResponse>
-
#### 📝 Description
-
-
Lists activity for a member and all of their memberships that are not `drafted`, most recent first.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.members.logs.list({
id: "id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.members.logs.list({
id: "id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.members.ListLogsRequest`
-
**requestOptions:** `LogsClient.RequestOptions`
client.members.notes.list({ ...params }) -> core.Page<Whop.MemberNote, Whop.ListNotesResponse>
-
#### 📝 Description
-
-
Lists a member's notes, newest first. Notes are visible to the account's team.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.members.notes.list({
member_id: "member_id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.members.notes.list({
member_id: "member_id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.members.ListNotesRequest`
-
**requestOptions:** `NotesClient.RequestOptions`
client.members.notes.create({ ...params }) -> Whop.MemberNote
-
#### 📝 Description
-
-
Adds a note to a member. Notes are visible to the account's team.
#### 🔌 Usage
-
-
```typescript
await client.members.notes.create({
member_id: "member_id",
content: "Wants a call next week."
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.members.CreateNotesRequest`
-
**requestOptions:** `NotesClient.RequestOptions`
client.notifications.topics.list({ ...params }) -> core.Page<Whop.NotificationTopic, Whop.ListTopicsResponse>
-
#### 📝 Description
-
-
Lists the platform's visible notification topics — the categories users can set notification preferences on. App-created topics are not returned.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.notifications.topics.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.notifications.topics.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.notifications.ListTopicsRequest`
-
**requestOptions:** `TopicsClient.RequestOptions`
client.partners.businesses.list({ ...params }) -> core.Page<Whop.ListBusinessesResponse.Data.Item, Whop.ListBusinessesResponse>
-
#### 📝 Description
-
-
Lists the businesses the authenticated user referred onto Whop, most recent first.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.partners.businesses.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.partners.businesses.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.partners.ListBusinessesRequest`
-
**requestOptions:** `BusinessesClient.RequestOptions`
client.partners.businesses.retrieve({ ...params }) -> Whop.RetrieveBusinessesResponse
-
#### 📝 Description
-
-
Retrieves a single referred business and its referral terms. The original referrer or a caller with company:basic:read on the business credited for the referral can read it.
#### 🔌 Usage
-
-
```typescript
await client.partners.businesses.retrieve({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.partners.RetrieveBusinessesRequest`
-
**requestOptions:** `BusinessesClient.RequestOptions`
client.partners.businesses.update({ ...params }) -> Whop.UpdateBusinessesResponse
-
#### 📝 Description
-
-
Save annual payment projections for a business referred by the authenticated partner. Unaccepted projections can be replaced with updated annual card and BNPL payment volume. To qualify, payment volume over the last 30 days must reach 5% of the annual payment projection. Ads are excluded from CPA; ordinary ad commissions continue. Pass withdraw_projections: true without projection amounts to remove unaccepted projections. Accepted projections are immutable. Public API access requires a partner OAuth token; business API keys are not supported.
#### 🔌 Usage
-
-
```typescript
await client.partners.businesses.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.partners.UpdateBusinessesRequest`
-
**requestOptions:** `BusinessesClient.RequestOptions`
client.partners.businesses.acceptCommissionAdvance({ ...params }) -> Whop.AcceptCommissionAdvanceBusinessesResponse
-
#### 📝 Description
-
-
Accept the authenticated partner's CPA offer with the reviewed terms and signed offer token. Public API access requires a partner OAuth token; business API keys are not supported.
#### 🔌 Usage
-
-
```typescript
await client.partners.businesses.acceptCommissionAdvance({
id: "id",
acknowledgments: ["commission_replacement", "clawback", "term"],
expected_amount_usd: "1079.99",
offer_token: "eyJfcmFpbHMiOnsiZGF0YSI6MSwicHVyIjoiYmxvYl9pZCJ9fQ==--xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
terms_version: "2026-01-01"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.partners.AcceptCommissionAdvanceBusinessesRequest`
-
**requestOptions:** `BusinessesClient.RequestOptions`
client.partners.businesses.resendInvite({ ...params }) -> Whop.ResendInviteBusinessesResponse
-
#### 📝 Description
-
-
Re-emails an outstanding invite to claim ownership of a referred business. Find the invite in the business's `pending_owner_invites`. Only the first-tier partner can resend, from a whop.com session or the Whop CLI or MCP with `partner:handoff`. Rate limited to one resend per invite every five minutes.
#### 🔌 Usage
-
-
```typescript
await client.partners.businesses.resendInvite({
id: "id",
invite_id: "ausri_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.partners.ResendInviteBusinessesRequest`
-
**requestOptions:** `BusinessesClient.RequestOptions`
client.partners.businesses.earnings.list({ ...params }) -> core.Page<Whop.ListEarningsResponse.Data.Item, Whop.ListEarningsResponse>
-
#### 📝 Description
-
-
Lists the earnings Whop pays out for one referred business's activity, most recent first. The original referrer or a caller with company:basic:read on the business credited for the referral can read them.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.partners.businesses.earnings.list({
id: "id"
});
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.partners.businesses.earnings.list({
id: "id"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.partners.businesses.ListEarningsRequest`
-
**requestOptions:** `EarningsClient.RequestOptions`
client.payments.direct.create({ ...params }) -> Whop.Payment
-
#### 📝 Description
-
-
Charges a buyer for a variant from card details you hold yourself, for integrators whose own systems are PCI compliant. Card details are accepted only on the vault host, which tokenizes the card before it reaches Whop; the official SDKs route this operation there, and raw card details sent to the regular host are refused. Collection runs in the background, so the response is the payment as created, not its outcome: poll Retrieve payment status for how far it has got and what the buyer must still do, such as 3D Secure.
#### 🔌 Usage
-
-
```typescript
await client.payments.direct.create({
account_id: "biz_xxxxxxxxxxxxxx",
billing_details: {
address: {
country: "US",
postal_code: "94105"
},
email: "dana@shinetime.example",
name: "Dana Shine"
},
payment_method: {
type: "card"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.payments.CreateDirectRequest`
-
**requestOptions:** `DirectClient.RequestOptions`
client.payouts.methods.list({ ...params }) -> core.Page<Whop.ListMethodsResponse.Data.Item, Whop.ListMethodsResponse>
-
#### 📝 Description
-
-
Lists the bank accounts, wallets, and crypto addresses an account or user can pay out to, newest first.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.payouts.methods.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.payouts.methods.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.payouts.ListMethodsRequest`
-
**requestOptions:** `MethodsClient.RequestOptions`
client.payouts.methods.create({ ...params }) -> Whop.CreateMethodsResponse
-
#### 📝 Description
-
-
Saves a bank account, wallet, or crypto address an account or user can pay out to, from a method listed by `GET /payouts/supported_methods`. Sensitive details are vaulted in transit and never stored raw.
#### 🔌 Usage
-
-
```typescript
await client.payouts.methods.create({
supported_payout_method_id: "podst_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.payouts.CreateMethodsRequest`
-
**requestOptions:** `MethodsClient.RequestOptions`
client.payouts.methods.delete({ ...params }) -> Whop.DeleteMethodsResponse
-
#### 📝 Description
-
-
Deletes a saved payout method so it can no longer receive payouts.
#### 🔌 Usage
-
-
```typescript
await client.payouts.methods.delete({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.payouts.DeleteMethodsRequest`
-
**requestOptions:** `MethodsClient.RequestOptions`
client.payouts.methods.update({ ...params }) -> Whop.UpdateMethodsResponse
-
#### 📝 Description
-
-
Changes the label used to identify a saved payout method, makes it the account's default payout method, or updates the payout address on file for it. Send `address` on its own: it cannot be combined with `nickname` or `is_default`. Address updates require the `payout:account:update` scope as well, on the same account, and are supported only for bank and wallet payout methods, not recipient payout methods.
#### 🔌 Usage
-
-
```typescript
await client.payouts.methods.update({
id: "id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.payouts.UpdateMethodsRequest`
-
**requestOptions:** `MethodsClient.RequestOptions`
client.payouts.paypalLinkSessions.create({ ...params }) -> Whop.CreatePaypalLinkSessionsResponse
-
#### 📝 Description
-
-
Starts a Log in with PayPal session so PayPal itself can confirm the account holder owns a verified PayPal account. Send the holder to `authorize_url`; after they log in, PayPal returns them to Whop, and Whop redirects the browser to your `return_url` with a `paypal_link_token` query parameter to pass to `POST /payouts/methods`. If the login fails or is canceled, `return_url` receives an `error` query parameter (`paypal_login_canceled` or `paypal_login_failed`) instead. The payout method saved this way pays the email on the PayPal account, and its holder name must match the name on the account's payout setup. PayPal login is rolling out per account: until it is enabled for the account this answers `403 forbidden`, and `supports_paypal_login` on `GET /payouts/supported_methods` is false.
#### 🔌 Usage
-
-
```typescript
await client.payouts.paypalLinkSessions.create({
return_url: "https://example.com/settings/payouts",
supported_payout_method_id: "podst_xxxxxxxxxxxxxx"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.payouts.CreatePaypalLinkSessionsRequest`
-
**requestOptions:** `PaypalLinkSessionsClient.RequestOptions`
client.payouts.supportedMethods.list({ ...params }) -> core.Page<Whop.ListSupportedMethodsResponse.Data.Item, Whop.ListSupportedMethodsResponse>
-
#### 📝 Description
-
-
Lists the payout methods an account or user is eligible to add. Pass a result's ID as `supported_payout_method_id` to `POST /payouts/methods` to save one.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.payouts.supportedMethods.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.payouts.supportedMethods.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.payouts.ListSupportedMethodsRequest`
-
**requestOptions:** `SupportedMethodsClient.RequestOptions`
client.setupIntents.direct.create({ ...params }) -> Whop.SetupIntent
-
#### 📝 Description
-
-
Saves a card for later charges from card details you hold yourself, for integrators whose own systems are PCI compliant. Send this operation to the vault host, which tokenizes the card before it reaches Whop; the official SDKs route it there, and raw card details sent to the regular host are refused. The setup runs in the background: poll Retrieve setup status for its outcome and for anything the buyer must still do, such as 3D Secure. Once it succeeds, the saved payment method arrives on the `setup_intent.succeeded` webhook and in List payment methods for the member.
#### 🔌 Usage
-
-
```typescript
await client.setupIntents.direct.create({
account_id: "biz_xxxxxxxxxxxxxx",
billing_details: {
address: {
country: "US",
postal_code: "94105"
},
email: "dana@shinetime.example",
name: "Dana Shine"
},
payment_method: {
type: "card"
}
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.setupIntents.CreateDirectRequest`
-
**requestOptions:** `DirectClient.RequestOptions`
client.stats.reports.list() -> Whop.ListReportsResponse
-
#### 📝 Description
-
-
Lists every report: the aggregates that are not bucketed over time, with the breakdowns and columns each one accepts. Use it to discover what a report can return before you retrieve it. For a bucketed series, use `GET /stats/time_series`.
#### 🔌 Usage
-
-
```typescript
await client.stats.reports.list();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `ReportsClient.RequestOptions`
client.stats.reports.platformTrends({ ...params }) -> Whop.PlatformTrendsReportsResponse
-
#### 📝 Description
-
-
Retrieves payments across all of Whop for up to four windows at once, optionally broken down by business type, industry type, product category, account country or customer country. The report covers the whole platform, so it takes no `account_id` and any authenticated caller can read it.
#### 🔌 Usage
-
-
```typescript
await client.stats.reports.platformTrends();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.stats.PlatformTrendsReportsRequest`
-
**requestOptions:** `ReportsClient.RequestOptions`
client.stats.timeSeries.list() -> Whop.ListTimeSeriesResponse
-
#### 📝 Description
-
-
Lists the metrics you can chart over time, with the unit each reports and the properties you can filter or break it down by. Aggregates that are not bucketed over time are reports, listed at `GET /stats/reports`.
#### 🔌 Usage
-
-
```typescript
await client.stats.timeSeries.list();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `TimeSeriesClient.RequestOptions`
client.stats.timeSeries.retrieve({ ...params }) -> Whop.RetrieveTimeSeriesResponse
-
#### 📝 Description
-
-
Retrieves a metric as a series of points over a time range for an account or user. For an aggregate that is not bucketed over time, use a report from `GET /stats/reports`. The `market_prices` metric is public and requires no authentication.
#### 🔌 Usage
-
-
```typescript
await client.stats.timeSeries.retrieve({
metric: "metric",
from: "from",
to: "to",
ad_campaign_ids: ["adcamp_xxxxxxxxxxxxxx"],
ad_group_ids: ["adgrp_xxxxxxxxxxxxxx"],
ad_ids: ["ad_xxxxxxxxxxxxxx"]
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.stats.RetrieveTimeSeriesRequest`
-
**requestOptions:** `TimeSeriesClient.RequestOptions`
client.trades.markets.list({ ...params }) -> core.Page<Whop.Market, Whop.ListMarketsResponse>
-
#### 📝 Description
-
-
Returns every market you can trade on Whop.
- **Spot:** listed by symbol: `BTC`, `ETH`, `SOL` and `XAUT` (gold).
- **Perpetuals:** such as `BTC`. Send the `id` as `market` when you create a trade.
The same symbol can appear twice, once as a perpetual and once as spot, so use `id` together with `instrument_type` to tell them apart. Results are sorted by `id`, then `instrument_type`.
This endpoint is public: no API key is needed, and each IP address can make up to 60 requests a minute.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.trades.markets.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.trades.markets.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.trades.ListMarketsRequest`
-
**requestOptions:** `MarketsClient.RequestOptions`
client.users.oauthGrants.list({ ...params }) -> core.Page<Whop.OauthGrant, Whop.ListOauthGrantsResponse>
-
#### 📝 Description
-
-
Lists the authenticated user's own OAuth grants: one per app they have authorized, per account they authorized it for. You cannot read another user's grants. Requires a user session: an API key or an OAuth token is refused, so an app can never enumerate the other apps a user has authorized.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.users.oauthGrants.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.users.oauthGrants.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.users.ListOauthGrantsRequest`
-
**requestOptions:** `OauthGrantsClient.RequestOptions`
client.users.oauthGrants.create({ ...params }) -> Whop.OauthGrant
-
#### 📝 Description
-
-
Completes the OAuth authorization step for the authenticated user: records their consent to the scopes an app asked for and mints an authorization code. Returns the grant plus a `redirect_url` carrying the code, which is returned only this once; the app exchanges it at `POST /oauth/token`. Requires a user session, because consent has to come from the account holder: an API key or an OAuth token is refused, so an app can never authorize itself. Send an `Idempotency-Key` so a retry returns the original `redirect_url` and code instead of issuing a second one.
#### 🔌 Usage
-
-
```typescript
await client.users.oauthGrants.create({
client_id: "app_xxxxxxxxxxxxxx",
redirect_uri: "https://Booking.Shinetime.example:8443/oauth/Callback/",
requested_scopes: ["profile"]
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.users.CreateOauthGrantsRequest`
-
**requestOptions:** `OauthGrantsClient.RequestOptions`
client.users.passkeys.list({ ...params }) -> core.Page<Whop.Passkey, Whop.ListPasskeysResponse>
-
#### 📝 Description
-
-
Lists the authenticated user's own passkeys, newest first. You cannot read another user's passkeys. Requires a user session: an API key or an OAuth token is refused, because a passkey confirms the account holder before a sensitive action and no app may enumerate one.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.users.passkeys.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.users.passkeys.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.users.ListPasskeysRequest`
-
**requestOptions:** `PasskeysClient.RequestOptions`
client.users.passkeys.create({ ...params }) -> Whop.Passkey
-
#### 📝 Description
-
-
Registers a passkey for the authenticated user from the attestation a browser produced for a `registration` challenge. Mint that challenge first with `POST /users/me/passkeys/challenge` and run the ceremony with its `creation_options`; it is single-use and expires 5 minutes after it is issued. Send back the `user_handle` the options carried: registering with it replaces the account's passkeys made before Whop issued options, which can only be deleted. Requires a user session that has completed step-up verification.
#### 🔌 Usage
-
-
```typescript
await client.users.passkeys.create({
attestation_object: "YXR0ZXN0YXRpb24",
client_data_json: "Y2xpZW50LWRhdGE",
credential_id: "bmV3LWNyZWRlbnRpYWw",
nickname: "Work laptop"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.users.CreatePasskeysRequest`
-
**requestOptions:** `PasskeysClient.RequestOptions`
client.users.passkeys.challenge({ ...params }) -> Whop.PasskeyChallenge
-
#### 📝 Description
-
-
Mints the challenge and WebAuthn options a browser needs to run a ceremony against the authenticated user's own passkeys. A `registration` challenge enrolls a new passkey; a `deletion` challenge is bound to the one passkey named by `passkey_id` and proves the user still holds it. The options are in wire snake_case: convert the keys to camelCase before passing them to the browser. Challenges are single-use and expire 5 minutes after they are issued, so send a fresh `Idempotency-Key` per ceremony — a replayed key returns the original challenge, which may already have expired. Requires a user session. A `registration` challenge also requires step-up verification, so the user completes it before the browser ceremony.
#### 🔌 Usage
-
-
```typescript
await client.users.passkeys.challenge({
challenge_type: "registration"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.users.ChallengePasskeysRequest`
-
**requestOptions:** `PasskeysClient.RequestOptions`
client.users.passkeys.delete({ ...params }) -> Whop.DeletePasskeysResponse
-
#### 📝 Description
-
-
Deletes one of the authenticated user's own passkeys. The request body carries a WebAuthn assertion from the passkey being deleted, so possession of the credential is proven before it is removed: mint a `deletion` challenge for it first, run the ceremony with that passkey, and send the result here. Deleting the user's last passkey is allowed — their other step-up factors remain. Requires a user session.
#### 🔌 Usage
-
-
```typescript
await client.users.passkeys.delete({
id: "id",
authenticator_data: "YXV0aGVudGljYXRvci1kYXRh",
client_data_json: "Y2xpZW50LWRhdGE",
signature: "c2lnbmF0dXJl"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.users.DeletePasskeysRequest`
-
**requestOptions:** `PasskeysClient.RequestOptions`
client.users.preferences.retrieve() -> Whop.UserPreferences
-
#### 📝 Description
-
-
Retrieves the authenticated user's settings document.
#### 🔌 Usage
-
-
```typescript
await client.users.preferences.retrieve();
```
#### ⚙️ Parameters
-
-
**requestOptions:** `PreferencesClient.RequestOptions`
client.users.preferences.update({ ...params }) -> Whop.UserPreferences
-
#### 📝 Description
-
-
Updates the authenticated user's settings document. Replaces the top-level keys it is given and leaves the rest untouched.
#### 🔌 Usage
-
-
```typescript
await client.users.preferences.update();
```
#### ⚙️ Parameters
-
-
**request:** `Whop.users.UpdatePreferencesRequest`
-
**requestOptions:** `PreferencesClient.RequestOptions`
client.users.fees.retrieve({ ...params }) -> Whop.UserFees
-
#### 📝 Description
-
-
Retrieves the fees charged when the user moves money with their personal balance: withdrawals, transfers, bank deposits, and funding cards from pending balance. Each fee has the same shape as in Retrieve Account Fees. You can only retrieve your own fees, and they are read-only.
#### 🔌 Usage
-
-
```typescript
await client.users.fees.retrieve({
user_id: "user_id"
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.users.RetrieveFeesRequest`
-
**requestOptions:** `FeesClient.RequestOptions`
client.users.preferences.notifications.set({ ...params }) -> Whop.SetNotificationsResponse
-
#### 📝 Description
-
-
Sets the authenticated user's notification preferences, each addressed by `scope` rather than by ID. The batch is applied in one transaction: if any entry is rejected, none are written. Experience levels are applied before topic overrides, because setting a level replaces every topic preference for that experience, so an override sent alongside a level wins. The response reports what each scope now resolves to, in the order the entries were sent.
#### 🔌 Usage
-
-
```typescript
await client.users.preferences.notifications.set({
preferences: [{
scope: {}
}]
});
```
#### ⚙️ Parameters
-
-
**request:** `Whop.users.preferences.SetNotificationsRequest`
-
**requestOptions:** `NotificationsClient.RequestOptions`
client.users.preferences.notifications.experiences.list({ ...params }) -> core.Page<Whop.ExperienceNotificationPreference, Whop.ListExperiencesResponse>
-
#### 📝 Description
-
-
Lists the authenticated user's per-experience notification levels. Experiences the user never set a level for are omitted — their effective level is `all`.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.users.preferences.notifications.experiences.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.users.preferences.notifications.experiences.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.users.preferences.notifications.ListExperiencesRequest`
-
**requestOptions:** `ExperiencesClient.RequestOptions`
client.users.preferences.notifications.topics.list({ ...params }) -> core.Page<Whop.UserNotificationPreference, Whop.ListTopicsResponse>
-
#### 📝 Description
-
-
Lists the authenticated user's topic-scoped notification preferences, plus user-agnostic platform defaults. Per-experience levels are listed separately, by `GET /users/me/preferences/notifications/experiences`.
#### 🔌 Usage
-
-
```typescript
const pageableResponse = await client.users.preferences.notifications.topics.list();
for await (const item of pageableResponse) {
console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.users.preferences.notifications.topics.list();
while (page.hasNextPage()) {
page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;
```
#### ⚙️ Parameters
-
-
**request:** `Whop.users.preferences.notifications.ListTopicsRequest`
-
**requestOptions:** `TopicsClient.RequestOptions`