# Whop Docs: For Developers API Reference Legacy API

> Whop is on a mission to deliver everyone a sustainable income. Accept payments, pay out users, build apps, and embed chat with SDKs in TypeScript, Python, and Ruby.

## Legacy API

### Ledger Stats

- [Schema](https://docs.whop.com/api-reference/beta/ledger-stats/schema.md): Returns the full structure of reporting categories, groupings, and line categories with human-readable descriptions. Use this to discover valid filter values for the time_series endpoint and understand what each value means.
- [Get Time Series](https://docs.whop.com/api-reference/beta/ledger-stats/time-series.md): Stats expose aggregated time series built from your account, the same data that powers the Whop dashboard charts. Each query rolls financial activity into periods (`group_by` day, week, or month) over the `from`–`to` window and returns the total `amount` and `line_count` for each, so you can chart r…

### Developer

#### Access Tokens

- [Access Token](https://docs.whop.com/api-reference/access-tokens/access-token.md): A short-lived access token used to authenticate API requests on behalf of a user.
- [Create access token](https://docs.whop.com/api-reference/access-tokens/create-access-token.md): Create a short-lived access token for authenticating API requests. When using API key authentication, provide account_id or user_id. When using OAuth, the user is derived from the token. Use this token with Whop's web and mobile embedded components.

#### Account Links

- [Account Link](https://docs.whop.com/api-reference/account-links/account-link.md): A temporary, time-limited URL that grants a user access to an external account management page.
- [Create account link](https://docs.whop.com/api-reference/account-links/create-account-link.md): Generate a URL that directs a sub-merchant to their account portal, such as the hosted payouts dashboard or the KYC onboarding flow.

#### App Builds

- [App Build](https://docs.whop.com/api-reference/app-builds/app-build.md): A versioned build artifact for a Whop React Native App, submitted for review and deployment to a specific platform.
- [List app builds](https://docs.whop.com/api-reference/app-builds/list-app-builds.md): Returns a paginated list of build artifacts for a given app, with optional filtering by platform, status, and creation date.
- [Create app build](https://docs.whop.com/api-reference/app-builds/create-app-build.md): Upload a new build artifact for an app. The build must include a compiled code bundle for the specified platform.
- [Retrieve app build](https://docs.whop.com/api-reference/app-builds/retrieve-app-build.md): Retrieves the details of an existing app build.
- [Promote app build](https://docs.whop.com/api-reference/app-builds/promote-app-build.md): Promote an approved or draft app build to production so it becomes the active version served to users.

#### Apps

- [App](https://docs.whop.com/api-reference/apps/app.md): An app is an integration built on Whop. Apps can serve consumers as experiences within products, or serve companies as business tools.
- [List apps](https://docs.whop.com/api-reference/apps/list-apps.md): Returns a paginated list of apps on the Whop platform, with optional filtering by company, type, view support, and search query.
- [Create app](https://docs.whop.com/api-reference/apps/create-app.md): Register a new app on the Whop developer platform. Apps provide custom experiences that can be added to products.
- [Update requested permissions](https://docs.whop.com/api-reference/apps/update-requested-permissions.md): Updates the permission requirements for an app
- [Retrieve app](https://docs.whop.com/api-reference/apps/retrieve-app.md): Retrieves the details of an existing app.
- [Update app](https://docs.whop.com/api-reference/apps/update-app.md): Update the settings, metadata, or status of an existing app on the Whop developer platform.

#### Files

- [File](https://docs.whop.com/api-reference/files/file.md): A file that has been uploaded or is pending upload.
- [Create file](https://docs.whop.com/api-reference/files/create-file.md): Create a new file record and receive a presigned URL for uploading content to S3.
- [Retrieve file](https://docs.whop.com/api-reference/files/retrieve-file.md): Retrieves the details of an existing file.

#### Webhooks

- [Webhook](https://docs.whop.com/api-reference/webhooks/webhook.md): A webhook endpoint that receives event notifications for a company via HTTP POST.
- [List webhooks](https://docs.whop.com/api-reference/webhooks/list-webhooks.md): Returns a paginated list of webhook endpoints configured for a company, ordered by most recently created.
- [Create webhook](https://docs.whop.com/api-reference/webhooks/create-webhook.md): Creates a new webhook
- [Delete webhook](https://docs.whop.com/api-reference/webhooks/delete-webhook.md): Deletes a webhook
- [Retrieve webhook](https://docs.whop.com/api-reference/webhooks/retrieve-webhook.md): Retrieves the details of an existing webhook.
- [Update webhook](https://docs.whop.com/api-reference/webhooks/update-webhook.md): Updates a webhook
- [Send test event](https://docs.whop.com/api-reference/webhooks/send-test-event.md): Tests a webhook
- [List deliveries](https://docs.whop.com/api-reference/webhooks/list-deliveries.md): 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.

### CRM

#### Affiliates

- [Affiliate](https://docs.whop.com/api-reference/affiliates/affiliate.md): An affiliate tracks a user's referral performance and commission earnings for a company, including retention rates, revenue metrics, and payout configurations.
- [List affiliates](https://docs.whop.com/api-reference/affiliates/list-affiliates.md): Returns a paginated list of affiliates for the actor in context, with optional filtering by status, search, and sorting.
- [Create affiliate](https://docs.whop.com/api-reference/affiliates/create-affiliate.md): Creates or finds an affiliate for a company and user.
- [Retrieve affiliate](https://docs.whop.com/api-reference/affiliates/retrieve-affiliate.md): Retrieves the details of an existing affiliate.
- [Archive affiliate](https://docs.whop.com/api-reference/affiliates/archive-affiliate.md): Archives an existing Affiliate
- [List overrides](https://docs.whop.com/api-reference/affiliates/list-overrides.md): Returns a paginated list of overrides for an affiliate.
- [Create override](https://docs.whop.com/api-reference/affiliates/create-override.md): Creates a commission override for an affiliate.
- [Delete override](https://docs.whop.com/api-reference/affiliates/delete-override.md): Deletes an affiliate override.
- [Retrieve override](https://docs.whop.com/api-reference/affiliates/retrieve-override.md): Retrieves the details of a specific affiliate override.
- [Update override](https://docs.whop.com/api-reference/affiliates/update-override.md): Updates an existing affiliate override.
- [Unarchive affiliate](https://docs.whop.com/api-reference/affiliates/unarchive-affiliate.md): Unarchives an existing Affiliate

#### Company Token Transactions

- [Company Token Transaction](https://docs.whop.com/api-reference/company-token-transactions/company-token-transaction.md): A token transaction records a credit or debit to a member's token balance within a company, including transfers between members.
- [List company token transactions](https://docs.whop.com/api-reference/company-token-transactions/list-company-token-transactions.md): Returns a paginated list of token transactions for a user or company, depending on the authenticated actor, with optional filtering by user and transaction type.
- [Create company token transaction](https://docs.whop.com/api-reference/company-token-transactions/create-company-token-transaction.md): Create a token transaction to add, subtract, or transfer tokens for a member within a company.
- [Retrieve company token transaction](https://docs.whop.com/api-reference/company-token-transactions/retrieve-company-token-transaction.md): Retrieves the details of an existing company token transaction.

#### Entries

- [Entry](https://docs.whop.com/api-reference/entries/entry.md): An entry represents a user's signup for a waitlisted plan.
- [Entry approved](https://docs.whop.com/api-reference/entries/entry-approved.md): Sent when a entry is approved
- [Entry created](https://docs.whop.com/api-reference/entries/entry-created.md): Sent when a entry is created
- [Entry deleted](https://docs.whop.com/api-reference/entries/entry-deleted.md): Sent when a entry is deleted
- [Entry denied](https://docs.whop.com/api-reference/entries/entry-denied.md): Sent when a entry is denied

#### Leads

- [Lead](https://docs.whop.com/api-reference/leads/lead.md): A prospective customer who has expressed interest in a company or product but has not yet purchased.
- [List leads](https://docs.whop.com/api-reference/leads/list-leads.md): Returns a paginated list of leads for a company, with optional filtering by product and creation date.
- [Create lead](https://docs.whop.com/api-reference/leads/create-lead.md): Record a new lead for a company, capturing a potential customer's interest in a specific product.
- [Retrieve lead](https://docs.whop.com/api-reference/leads/retrieve-lead.md): Retrieves the details of an existing lead.
- [Update lead](https://docs.whop.com/api-reference/leads/update-lead.md): Update the metadata or referrer information on an existing lead record.

#### Members

- [Member](https://docs.whop.com/api-reference/members/member.md): A member represents a user's relationship with a company on Whop, including their access level, status, and spending history.
- [List members](https://docs.whop.com/api-reference/members/list-members.md): Returns a paginated list of members for a company, with extensive filtering by product, plan, status, access level, and more.
- [Retrieve member](https://docs.whop.com/api-reference/members/retrieve-member.md): Retrieves the details of an existing member.
- [Member created](https://docs.whop.com/api-reference/members/member-created.md): Sent when a member is created
- [Member updated](https://docs.whop.com/api-reference/members/member-updated.md): Sent when a member is updated

#### Memberships

- [Membership](https://docs.whop.com/api-reference/memberships/membership.md): A membership represents an active relationship between a user and a product. It tracks the user's access, billing status, and renewal schedule.
- [List memberships](https://docs.whop.com/api-reference/memberships/list-memberships.md): Returns a paginated list of memberships, with optional filtering by product, plan, status, and user.
- [Retrieve membership](https://docs.whop.com/api-reference/memberships/retrieve-membership.md): Retrieves the details of an existing membership.
- [Update membership](https://docs.whop.com/api-reference/memberships/update-membership.md): Update a membership's metadata or other mutable properties.
- [Add free days membership](https://docs.whop.com/api-reference/memberships/add-free-days-membership.md): Add free days to extend a membership's current billing period, expiration date, or Stripe trial.
- [Cancel membership](https://docs.whop.com/api-reference/memberships/cancel-membership.md): Cancel a membership either immediately or at the end of the current billing period. Immediate cancellation revokes access right away.
- [Pause membership](https://docs.whop.com/api-reference/memberships/pause-membership.md): Pause a membership's recurring payments. The customer retains access but will not be charged until the membership is resumed.
- [Resume membership](https://docs.whop.com/api-reference/memberships/resume-membership.md): Resume a previously paused membership's recurring payments. Billing resumes on the next cycle.
- [Resync access membership](https://docs.whop.com/api-reference/memberships/resync-access-membership.md): Re-run 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 cannot be resynced here. The…
- [Uncancel membership](https://docs.whop.com/api-reference/memberships/uncancel-membership.md): Reverse a pending cancellation for a membership that was scheduled to cancel at period end.
- [Membership activated](https://docs.whop.com/api-reference/memberships/membership-activated.md): Sent when a membership is activated
- [Membership trial ending soon](https://docs.whop.com/api-reference/memberships/membership-trial-ending-soon.md): Sent when a membership is trial ending soon
- [Membership updated](https://docs.whop.com/api-reference/memberships/membership-updated.md): Sent whenever a membership changes: it activates or deactivates, cancel_at_period_end flips, or the seller edits its billing period, price or renewal date. previous_attributes carries the values that changed from. membership.activated is also delivered as a membership.updated, so you can subscribe t…

#### Reviews

- [Review](https://docs.whop.com/api-reference/reviews/review.md): A user-submitted review of a company, including a star rating and optional text feedback.
- [List reviews](https://docs.whop.com/api-reference/reviews/list-reviews.md): Returns a paginated list of customer reviews for a specific product, with optional filtering by star rating and creation date.
- [Retrieve review](https://docs.whop.com/api-reference/reviews/retrieve-review.md): Retrieves the details of an existing review.

#### Shipments

- [Shipment](https://docs.whop.com/api-reference/shipments/shipment.md): A physical shipment associated with a payment, including carrier details and tracking information.
- [List shipments](https://docs.whop.com/api-reference/shipments/list-shipments.md): Returns a paginated list of shipments, with optional filtering by payment, company, or user.
- [Create shipment](https://docs.whop.com/api-reference/shipments/create-shipment.md): Create a new shipment with a tracking code for a specific payment within a company.
- [Retrieve shipment](https://docs.whop.com/api-reference/shipments/retrieve-shipment.md): Retrieves the details of an existing shipment.
- [Shipment created](https://docs.whop.com/api-reference/shipments/shipment-created.md): Sent when a shipment is created
- [Shipment updated](https://docs.whop.com/api-reference/shipments/shipment-updated.md): Sent when a shipment is updated

### AI

#### AI Chats

- [AI Chat](https://docs.whop.com/api-reference/ai-chats/ai-chat.md): An AI-powered chat conversation belonging to a user, with optional scheduled automation.
- [List ai chats](https://docs.whop.com/api-reference/ai-chats/list-ai-chats.md): Returns a paginated list of AI chat threads for the current authenticated user.
- [Create ai chat](https://docs.whop.com/api-reference/ai-chats/create-ai-chat.md): Create a new AI chat thread and send the first message to the AI agent.
- [Delete ai chat](https://docs.whop.com/api-reference/ai-chats/delete-ai-chat.md): Delete an AI chat thread so it no longer appears in the user's chat list.
- [Retrieve ai chat](https://docs.whop.com/api-reference/ai-chats/retrieve-ai-chat.md): Retrieves the details of an existing AI chat.
- [Update ai chat](https://docs.whop.com/api-reference/ai-chats/update-ai-chat.md): Update an AI chat's title, notification preferences, or associated account context.

### Identity

- [Users](https://docs.whop.com/api-reference/users/user.md): The Users API is documented in the Whop API reference.

#### Authorized Users

- [Authorized User](https://docs.whop.com/api-reference/authorized-users/authorized-user.md): A user who belongs to a company's team with access determined by their assigned role.
- [List authorized users](https://docs.whop.com/api-reference/authorized-users/list-authorized-users.md): Returns a paginated list of authorized team members for a company, with optional filtering by user, role, and creation date.
- [Create authorized user](https://docs.whop.com/api-reference/authorized-users/create-authorized-user.md): Add a new authorized user to a company.
- [Delete authorized user](https://docs.whop.com/api-reference/authorized-users/delete-authorized-user.md): Remove an authorized user from a company.
- [Retrieve authorized user](https://docs.whop.com/api-reference/authorized-users/retrieve-authorized-user.md): Retrieves the details of an existing authorized user.

#### Fee Markups

- [Fee Markup](https://docs.whop.com/api-reference/fee-markups/fee-markup.md): A fee markup configuration that defines additional charges applied to transactions for a platform's connected accounts.
- [List fee markups](https://docs.whop.com/api-reference/fee-markups/list-fee-markups.md): Returns a paginated list of fee markups configured for a company. If the company is a platform account, returns the platform default markups.
- [Create fee markup](https://docs.whop.com/api-reference/fee-markups/create-fee-markup.md): Create or update a fee markup for a company. If a markup for the specified fee type already exists, it will be updated with the new values.
- [Delete fee markup](https://docs.whop.com/api-reference/fee-markups/delete-fee-markup.md): Delete a fee markup configuration for a company. This removes the custom fee override and reverts to the parent company's default fees.

### Bounties

#### Bounties

- [Workforce Bounty](https://docs.whop.com/api-reference/bounties/workforce-bounty.md): A privately accessible bounty.
- [List bounties](https://docs.whop.com/api-reference/bounties/list-bounties.md): Returns a paginated list of workforce bounties. When experienceId is provided, returns bounties scoped to that experience. When omitted, returns bounties with no experience.
- [Create bounty](https://docs.whop.com/api-reference/bounties/create-bounty.md): Create a new workforce bounty by funding a dedicated bounty pool.
- [Retrieve bounty](https://docs.whop.com/api-reference/bounties/retrieve-bounty.md): Retrieves a workforce bounty for the current authenticated user.

### Cards

#### Card Transactions

- [Card Transaction](https://docs.whop.com/api-reference/card-transactions/card-transaction.md): A card transaction record.
- [List card transactions](https://docs.whop.com/api-reference/card-transactions/list-card-transactions.md): Returns a paginated list of card transactions for a company.
- [Retrieve card transaction](https://docs.whop.com/api-reference/card-transactions/retrieve-card-transaction.md): Retrieves a single card transaction by ID.
- [Cardtransaction completed](https://docs.whop.com/api-reference/card-transactions/cardtransaction-completed.md): Sent when a card transaction is completed
- [Cardtransaction created](https://docs.whop.com/api-reference/card-transactions/cardtransaction-created.md): Sent when a card transaction is created
- [Cardtransaction declined](https://docs.whop.com/api-reference/card-transactions/cardtransaction-declined.md): Sent when a card transaction is declined
- [Cardtransaction reversed](https://docs.whop.com/api-reference/card-transactions/cardtransaction-reversed.md): Sent when a card transaction is reversed
- [Cardtransaction updated](https://docs.whop.com/api-reference/card-transactions/cardtransaction-updated.md): Sent when a card transaction is updated

### Engagement

#### Chat Channels

- [Chat Channel](https://docs.whop.com/api-reference/chat-channels/chat-channel.md): A real-time chat feed attached to an experience, with configurable moderation and posting permissions.
- [List chat channels](https://docs.whop.com/api-reference/chat-channels/list-chat-channels.md): Returns a paginated list of chat channels within a specific company, with optional filtering by product.
- [Retrieve chat channel](https://docs.whop.com/api-reference/chat-channels/retrieve-chat-channel.md): Retrieves the details of an existing chat channel.
- [Update chat channel](https://docs.whop.com/api-reference/chat-channels/update-chat-channel.md): Update moderation settings for a chat channel, such as who can post, banned words, and media restrictions.

#### DM Channels

- [DM Channel](https://docs.whop.com/api-reference/dm-channels/dm-channel.md): A messaging channel that can be a one-on-one DM, group chat, company support conversation, or platform-level direct message.
- [List dm channels](https://docs.whop.com/api-reference/dm-channels/list-dm-channels.md): Returns a paginated list of DM channels for the currently authenticated user, sorted by most recently active.
- [Create dm channel](https://docs.whop.com/api-reference/dm-channels/create-dm-channel.md): Create a new DM channel between two or more users, optionally scoped to a specific company. Returns the existing channel if one already exists.
- [Delete dm channel](https://docs.whop.com/api-reference/dm-channels/delete-dm-channel.md): Permanently delete a DM channel and all of its messages. Only an admin of the channel can perform this action.
- [Retrieve dm channel](https://docs.whop.com/api-reference/dm-channels/retrieve-dm-channel.md): Retrieves the details of an existing DM channel.
- [Update dm channel](https://docs.whop.com/api-reference/dm-channels/update-dm-channel.md): Update the settings of an existing DM channel, such as its display name. Only an admin of the channel can perform this action.

#### DM Members

- [DM Member](https://docs.whop.com/api-reference/dm-members/dm-member.md): A user's membership record in a messaging channel, including notification preferences and read state.
- [List dm members](https://docs.whop.com/api-reference/dm-members/list-dm-members.md): Returns a paginated list of members in a specific DM channel, sorted by the date they were added.
- [Create dm member](https://docs.whop.com/api-reference/dm-members/create-dm-member.md): Add a new user to an existing DM channel. Only an admin of the channel can add members.
- [Delete dm member](https://docs.whop.com/api-reference/dm-members/delete-dm-member.md): Remove a user from a DM channel. An admin can remove any member, and a member can remove themselves.
- [Retrieve dm member](https://docs.whop.com/api-reference/dm-members/retrieve-dm-member.md): Retrieves the details of an existing DM member.
- [Update dm member](https://docs.whop.com/api-reference/dm-members/update-dm-member.md): Update a DM channel member's settings, such as their notification preferences or membership status.

#### Experiences

- [Experience](https://docs.whop.com/api-reference/experiences/experience.md): An experience is a feature or content module within a product, such as a chat, course, or custom app.
- [List experiences](https://docs.whop.com/api-reference/experiences/list-experiences.md): Returns a paginated list of experiences belonging to a company, with optional filtering by product and app.
- [Create experience](https://docs.whop.com/api-reference/experiences/create-experience.md): Required permissions:  - `experience:create`
- [Delete experience](https://docs.whop.com/api-reference/experiences/delete-experience.md): Required permissions:  - `experience:delete`
- [Retrieve experience](https://docs.whop.com/api-reference/experiences/retrieve-experience.md): Retrieves the details of an existing experience.
- [Update experience](https://docs.whop.com/api-reference/experiences/update-experience.md): Required permissions:  - `experience:update`
- [Attach experience](https://docs.whop.com/api-reference/experiences/attach-experience.md): Attach an experience to a product, making it accessible to the product's customers.
- [Detach experience](https://docs.whop.com/api-reference/experiences/detach-experience.md): Detach an experience from a product, removing customer access to it through that product.
- [Duplicate experience](https://docs.whop.com/api-reference/experiences/duplicate-experience.md): Duplicates an existing experience. The name will be copied, unless provided. The new experience will be attached to the same products as the original experience. If duplicating a Forum or Chat experience, the new experience will have the same settings as the original experience, e.g. who can post, w…

#### Forum Posts

- [Forum Post](https://docs.whop.com/api-reference/forum-posts/forum-post.md): A post or comment in a forum feed, supporting rich text, attachments, polls, and reactions.
- [List forum posts](https://docs.whop.com/api-reference/forum-posts/list-forum-posts.md): Returns a paginated list of forum posts within a specific experience, with optional filtering by parent post or pinned status.
- [Create forum post](https://docs.whop.com/api-reference/forum-posts/create-forum-post.md): Create a new forum post or comment within an experience. Supports text content, attachments, polls, paywalling, and pinning. Pass experience_id 'public' with an account_id to post to an account's public forum.
- [Retrieve forum post](https://docs.whop.com/api-reference/forum-posts/retrieve-forum-post.md): Retrieves the details of an existing forum post.
- [Update forum post](https://docs.whop.com/api-reference/forum-posts/update-forum-post.md): Edit the content, attachments, pinned status, or visibility of an existing forum post or comment.

#### Forums

- [Forum](https://docs.whop.com/api-reference/forums/forum.md): A discussion forum where members can create posts, comment, and react, belonging to an experience.
- [List forums](https://docs.whop.com/api-reference/forums/list-forums.md): Returns a paginated list of forums within a specific company, with optional filtering by product.
- [Retrieve forum](https://docs.whop.com/api-reference/forums/retrieve-forum.md): Retrieves the details of an existing forum.
- [Update forum](https://docs.whop.com/api-reference/forums/update-forum.md): Update moderation and notification settings for a forum, such as who can post, who can comment, and email notification preferences.

#### Messages

- [Message](https://docs.whop.com/api-reference/messages/message.md): A message sent within an experience chat, direct message, or group chat.
- [List messages](https://docs.whop.com/api-reference/messages/list-messages.md): Returns a paginated list of messages within a specific experience chat, DM, or group chat channel, sorted by creation time.
- [Create message](https://docs.whop.com/api-reference/messages/create-message.md): Send a new message in an experience chat, DM, or group chat channel. Supports text content, attachments, polls, and replies.
- [Delete message](https://docs.whop.com/api-reference/messages/delete-message.md): Permanently delete a message from an experience chat, DM, or group chat channel. Only the message author or a channel admin can delete a message.
- [Retrieve message](https://docs.whop.com/api-reference/messages/retrieve-message.md): Retrieves the details of an existing message.
- [Update message](https://docs.whop.com/api-reference/messages/update-message.md): Edit the content, attachments, or pinned status of an existing message in an experience chat, DM, or group chat channel.
- [Chat message created](https://docs.whop.com/api-reference/messages/chat-message-created.md): Sent when a chat event is created

#### Notifications

- [Create notification](https://docs.whop.com/api-reference/notifications/create-notification.md): Send a push notification to users in an experience or company team. The notification is processed asynchronously and supports targeting specific users.

#### Reactions

- [Reaction](https://docs.whop.com/api-reference/reactions/reaction.md): A single reaction left by a user on a feed post, such as a like or emoji.
- [List reactions](https://docs.whop.com/api-reference/reactions/list-reactions.md): Returns a paginated list of emoji reactions on a specific message or forum post, sorted by most recent.
- [Create reaction](https://docs.whop.com/api-reference/reactions/create-reaction.md): Add an emoji reaction or poll vote to a message or forum post. In forums, the reaction is always a like.
- [Delete reaction](https://docs.whop.com/api-reference/reactions/delete-reaction.md): Remove an emoji reaction from a message or forum post. Only the reaction author or a channel admin can remove a reaction.
- [Retrieve reaction](https://docs.whop.com/api-reference/reactions/retrieve-reaction.md): Retrieves the details of an existing reaction.
- [Chat reaction created](https://docs.whop.com/api-reference/reactions/chat-reaction-created.md): Sent when a chat event is created

#### Support Channels

- [Support Channel](https://docs.whop.com/api-reference/support-channels/support-channel.md): A messaging channel that can be a one-on-one DM, group chat, company support conversation, or platform-level direct message.
- [List support channels](https://docs.whop.com/api-reference/support-channels/list-support-channels.md): Returns a paginated list of support channels for a specific company, with optional filtering by resolution status and custom sorting.
- [Create support channel](https://docs.whop.com/api-reference/support-channels/create-support-channel.md): Open a new support channel between a company team member and a customer. Returns the existing channel if one already exists for that user.
- [Retrieve support channel](https://docs.whop.com/api-reference/support-channels/retrieve-support-channel.md): Retrieves the details of an existing support channel.

### Payins

- [Plans (Deprecated)](https://docs.whop.com/api-reference/plans/plan.md): Plans is the deprecated compatibility name for Variants.
- [Variants](https://docs.whop.com/api-reference/variants/variant.md): The Variants API is documented in the Whop API reference.

#### Checkout Configurations

- [Checkout Configuration](https://docs.whop.com/api-reference/checkout-configurations/checkout-configuration.md): A checkout configuration is a reusable configuration for a checkout, including the plan, affiliate, and custom metadata. Payments and memberships created from a checkout session inherit its metadata.
- [List checkout configurations](https://docs.whop.com/api-reference/checkout-configurations/list-checkout-configurations.md): Returns a paginated list of checkout configurations for a company, with optional filtering by plan and creation date.
- [Create checkout configuration](https://docs.whop.com/api-reference/checkout-configurations/create-checkout-configuration.md): Creates a new checkout configuration
- [Retrieve checkout configuration](https://docs.whop.com/api-reference/checkout-configurations/retrieve-checkout-configuration.md): Retrieves the details of an existing checkout configuration.

#### Dispute Alerts

- [Dispute Alert](https://docs.whop.com/api-reference/dispute-alerts/dispute-alert.md): A dispute alert represents an early warning notification from a payment processor about a potential dispute or chargeback.
- [List dispute alerts](https://docs.whop.com/api-reference/dispute-alerts/list-dispute-alerts.md): Returns a paginated list of dispute alerts for a company, with optional filtering by creation date.
- [Retrieve dispute alert](https://docs.whop.com/api-reference/dispute-alerts/retrieve-dispute-alert.md): Retrieves the details of an existing dispute alert.
- [Dispute alert created](https://docs.whop.com/api-reference/dispute-alerts/dispute-alert-created.md): Sent when a dispute alert is created

#### Disputes

- [Dispute](https://docs.whop.com/api-reference/disputes/dispute.md): A dispute is a chargeback or payment challenge filed against a company, including evidence and response status.
- [List disputes](https://docs.whop.com/api-reference/disputes/list-disputes.md): Returns a paginated list of disputes for a company, with optional filtering by creation date. A dispute represents a chargeback or inquiry filed by a customer against a payment.
- [Retrieve dispute](https://docs.whop.com/api-reference/disputes/retrieve-dispute.md): Retrieves the details of an existing dispute.
- [Submit evidence](https://docs.whop.com/api-reference/disputes/submit-evidence.md): Submit a payment dispute to the payment processor for review. Once submitted, no further edits can be made.
- [Update evidence](https://docs.whop.com/api-reference/disputes/update-evidence.md): Update a dispute with evidence data to attempt to win the dispute.
- [Dispute created](https://docs.whop.com/api-reference/disputes/dispute-created.md): Sent when a dispute is created
- [Dispute updated](https://docs.whop.com/api-reference/disputes/dispute-updated.md): Sent when a dispute is updated

#### Invoices

- [Invoice](https://docs.whop.com/api-reference/invoices/invoice.md): An invoice represents an itemized bill sent by a company to a customer for a specific product and plan, tracking the amount owed, due date, and payment status.
- [List invoices](https://docs.whop.com/api-reference/invoices/list-invoices.md): Returns a paginated list of invoices for a company, with optional filtering by product, status, collection method, and creation date.
- [Create invoice](https://docs.whop.com/api-reference/invoices/create-invoice.md): Create an invoice for a customer. The invoice can be charged automatically using a stored payment method, or sent to the customer for manual payment.
- [Delete invoice](https://docs.whop.com/api-reference/invoices/delete-invoice.md): Delete a draft invoice.
- [Retrieve invoice](https://docs.whop.com/api-reference/invoices/retrieve-invoice.md): Retrieves the details of an existing invoice.
- [Update invoice](https://docs.whop.com/api-reference/invoices/update-invoice.md): Update a draft invoice's details.
- [Mark paid invoice](https://docs.whop.com/api-reference/invoices/mark-paid-invoice.md): Mark an open invoice as paid when payment was collected outside of Whop.
- [Mark uncollectible invoice](https://docs.whop.com/api-reference/invoices/mark-uncollectible-invoice.md): Mark an open invoice as uncollectible when payment is not expected.
- [Resend invoice](https://docs.whop.com/api-reference/invoices/resend-invoice.md): Resend the notification email for an existing invoice to the customer.
- [Void invoice](https://docs.whop.com/api-reference/invoices/void-invoice.md): Void an open invoice so it can no longer be paid. Voiding is permanent and cannot be undone.
- [Invoice created](https://docs.whop.com/api-reference/invoices/invoice-created.md): Sent when a invoice is created
- [Invoice marked uncollectible](https://docs.whop.com/api-reference/invoices/invoice-marked-uncollectible.md): Sent when a invoice is marked uncollectible
- [Invoice paid](https://docs.whop.com/api-reference/invoices/invoice-paid.md): Sent when a invoice is paid
- [Invoice past due](https://docs.whop.com/api-reference/invoices/invoice-past-due.md): Sent when a invoice is past due
- [Invoice voided](https://docs.whop.com/api-reference/invoices/invoice-voided.md): Sent when a invoice is voided

#### Payment Methods

- [Payment Method](https://docs.whop.com/api-reference/payment-methods/payment-method.md)
- [List payment methods](https://docs.whop.com/api-reference/payment-methods/list-payment-methods.md): Returns a paginated list of payment methods for a member or company, or for the authenticated user when neither is given, with optional filtering by creation date. A payment method is a stored representation of how a customer intends to pay, such as a card, bank account, or digital wallet.
- [Delete payment method](https://docs.whop.com/api-reference/payment-methods/delete-payment-method.md): Delete a saved payment method. Cannot delete a payment method attached to an active subscription.
- [Retrieve payment method](https://docs.whop.com/api-reference/payment-methods/retrieve-payment-method.md): Retrieves the details of an existing payment method. Addresses a member's wallet when member_id or account_id is given, otherwise your own.

#### Payments

- [Payment](https://docs.whop.com/api-reference/payments/payment.md): A payment represents a completed or attempted charge. Payments track the amount, status, currency, and payment method used.
- [List payments](https://docs.whop.com/api-reference/payments/list-payments.md): Returns a paginated list of payments for the actor in context, with optional filtering by product, plan, status, billing reason, currency, and creation date.
- [Create payment](https://docs.whop.com/api-reference/payments/create-payment.md): Charge a buyer on-session with a `confirmation_token` for the method they selected, or charge an existing member off-session using a stored payment method. You can provide an existing plan or create one inline. The endpoint returns a payment immediately, but processing continues asynchronously. Use…
- [Retrieve payment](https://docs.whop.com/api-reference/payments/retrieve-payment.md): Retrieves the details of an existing payment.
- [List fees](https://docs.whop.com/api-reference/payments/list-fees.md): Returns the list of fees associated with a specific payment, including platform fees and processing fees.
- [Refund payment](https://docs.whop.com/api-reference/payments/refund-payment.md): Issue a full or partial refund for a payment. The refund is processed through the original payment processor and the membership status is updated accordingly.
- [Retry payment](https://docs.whop.com/api-reference/payments/retry-payment.md): Retry a failed or pending payment. This re-attempts the charge using the original payment method and plan details.
- [Void payment](https://docs.whop.com/api-reference/payments/void-payment.md): Void or cancel an eligible payment. The request is rejected if the payment is no longer eligible.
- [Payment authorized](https://docs.whop.com/api-reference/payments/payment-authorized.md): Sent when a payment is authorized
- [Payment canceled](https://docs.whop.com/api-reference/payments/payment-canceled.md): Sent when a payment is canceled
- [Payment created](https://docs.whop.com/api-reference/payments/payment-created.md): Sent when a payment is created
- [Payment failed](https://docs.whop.com/api-reference/payments/payment-failed.md): Sent when a payment is failed
- [Payment pending](https://docs.whop.com/api-reference/payments/payment-pending.md): Sent when a payment is pending
- [Payment requires action](https://docs.whop.com/api-reference/payments/payment-requires-action.md): Sent when the bank asks the buyer to verify an off-session charge, such as a subscription renewal or a saved-card payment your server made. `data.recovery_url` is the Whop link where the buyer signs in and completes 3D Secure; the event is only sent while that link exists, so it is null only when yo…
- [Payment succeeded](https://docs.whop.com/api-reference/payments/payment-succeeded.md): Sent when a payment is succeeded

#### Products

- [Product](https://docs.whop.com/api-reference/products/product.md): A product is a digital good or service sold on Whop. Products contain plans for pricing and experiences for content delivery.
- [List products](https://docs.whop.com/api-reference/products/list-products.md): Returns a paginated list of products belonging to a company, with optional filtering by type, visibility, and creation date.
- [Create product](https://docs.whop.com/api-reference/products/create-product.md): Create a new product for a company. The product serves as the top-level container for plans and experiences.
- [Delete product](https://docs.whop.com/api-reference/products/delete-product.md): Permanently delete a product and remove it from the company's catalog.
- [Retrieve product](https://docs.whop.com/api-reference/products/retrieve-product.md): Retrieves the details of an existing product.
- [Update product](https://docs.whop.com/api-reference/products/update-product.md): Update a product's title, description, visibility, and other settings.
- [Product created](https://docs.whop.com/api-reference/products/product-created.md): Sent when a product is created
- [Product deleted](https://docs.whop.com/api-reference/products/product-deleted.md): Sent when a product is deleted
- [Product published](https://docs.whop.com/api-reference/products/product-published.md): Sent when a product is published
- [Product unpublished](https://docs.whop.com/api-reference/products/product-unpublished.md): Sent when a product is unpublished
- [Product updated](https://docs.whop.com/api-reference/products/product-updated.md): Sent when a product is updated

#### Promo Codes

- [Promo Code](https://docs.whop.com/api-reference/promo-codes/promo-code.md): A promo code applies a discount to a plan during checkout. Promo codes can be percentage-based or fixed-amount, and can have usage limits and expiration dates.
- [List promo codes](https://docs.whop.com/api-reference/promo-codes/list-promo-codes.md): Returns a paginated list of promo codes belonging to a company, with optional filtering by product, plan, and status.
- [Create promo code](https://docs.whop.com/api-reference/promo-codes/create-promo-code.md): Create a new promo code that applies a discount at checkout. Can be scoped to specific products or plans.
- [Delete promo code](https://docs.whop.com/api-reference/promo-codes/delete-promo-code.md): Archive a promo code, preventing it from being used in future checkouts. Existing memberships are not affected.
- [Retrieve promo code](https://docs.whop.com/api-reference/promo-codes/retrieve-promo-code.md): Retrieves the details of an existing promo code.
- [Update promo code](https://docs.whop.com/api-reference/promo-codes/update-promo-code.md): Update whether a promo code can be used at checkout.

#### Refunds

- [Refund](https://docs.whop.com/api-reference/refunds/refund.md): A refund represents a full or partial reversal of a payment, including the amount, status, and payment provider.
- [List refunds](https://docs.whop.com/api-reference/refunds/list-refunds.md): Returns a paginated list of refunds, with optional filtering by payment, company, user, and creation date.
- [Retrieve refund](https://docs.whop.com/api-reference/refunds/retrieve-refund.md): Retrieves the details of an existing refund.
- [Refund created](https://docs.whop.com/api-reference/refunds/refund-created.md): Sent when a refund is created
- [Refund updated](https://docs.whop.com/api-reference/refunds/refund-updated.md): Sent when a refund is updated

#### Resolution Center Cases

- [Resolution Center Case](https://docs.whop.com/api-reference/resolution-center-cases/resolution-center-case.md): A resolution center case is a dispute or support case between a user and a company, tracking the issue, status, and outcome.
- [List resolution center cases](https://docs.whop.com/api-reference/resolution-center-cases/list-resolution-center-cases.md): Returns a paginated list of resolution center cases, with optional filtering by company, status, and creation date.
- [Retrieve resolution center case](https://docs.whop.com/api-reference/resolution-center-cases/retrieve-resolution-center-case.md): Retrieves the details of an existing resolution center case.
- [Resolutioncentercase created](https://docs.whop.com/api-reference/resolution-center-cases/resolutioncentercase-created.md): Sent when a resolution center case is created
- [Resolutioncentercase decided](https://docs.whop.com/api-reference/resolution-center-cases/resolutioncentercase-decided.md): Sent when a resolution center case is decided
- [Resolutioncentercase updated](https://docs.whop.com/api-reference/resolution-center-cases/resolutioncentercase-updated.md): Sent when a resolution center case is updated

#### Setup Intents

- [Setup Intent](https://docs.whop.com/api-reference/setup-intents/setup-intent.md): A setup intent allows a user to save a payment method for future use without making an immediate purchase.
- [List setup intents](https://docs.whop.com/api-reference/setup-intents/list-setup-intents.md): Returns a paginated list of setup intents for a company, with optional filtering by creation date. A setup intent securely collects and stores a member's payment method for future use without charging them immediately.
- [Create setup intent](https://docs.whop.com/api-reference/setup-intents/create-setup-intent.md): Save a buyer's payment method for later without charging it. Provide a confirmation token for a method the buyer just supplied, or an existing payment method to re-verify. The buyer may still have a step to complete — 3D Secure, a hosted enrollment, linking a bank account — so poll the setup intent'…
- [Retrieve setup intent](https://docs.whop.com/api-reference/setup-intents/retrieve-setup-intent.md): Retrieves the details of an existing setup intent.
- [Setupintent canceled](https://docs.whop.com/api-reference/setup-intents/setupintent-canceled.md): Sent when a setup intent is canceled
- [Setupintent requires action](https://docs.whop.com/api-reference/setup-intents/setupintent-requires-action.md): Sent when a setup intent is requires action
- [Setupintent succeeded](https://docs.whop.com/api-reference/setup-intents/setupintent-succeeded.md): Sent when a setup intent is succeeded

### Courses

#### Course Chapters

- [Course Chapter](https://docs.whop.com/api-reference/course-chapters/course-chapter.md): A grouping of related lessons within a course, used to organize content into sections.
- [List course chapters](https://docs.whop.com/api-reference/course-chapters/list-course-chapters.md): Returns a paginated list of chapters within a course, ordered by position.
- [Create course chapter](https://docs.whop.com/api-reference/course-chapters/create-course-chapter.md): Create a new chapter within a course to organize lessons into sections.
- [Delete course chapter](https://docs.whop.com/api-reference/course-chapters/delete-course-chapter.md): Permanently delete a chapter and all of its lessons from a course.
- [Retrieve course chapter](https://docs.whop.com/api-reference/course-chapters/retrieve-course-chapter.md): Retrieves the details of an existing course chapter.
- [Update course chapter](https://docs.whop.com/api-reference/course-chapters/update-course-chapter.md): Update a chapter's title within a course.

#### Course Lesson Interactions

- [Course Lesson Interaction](https://docs.whop.com/api-reference/course-lesson-interactions/course-lesson-interaction.md): A record of a user's progress on a specific lesson, tracking whether they have completed it.
- [List course lesson interactions](https://docs.whop.com/api-reference/course-lesson-interactions/list-course-lesson-interactions.md): Returns a paginated list of lesson interactions, filtered by lesson, course, user, or completion status.
- [Retrieve course lesson interaction](https://docs.whop.com/api-reference/course-lesson-interactions/retrieve-course-lesson-interaction.md): Retrieves the details of an existing course lesson interaction.
- [Courselessoninteraction completed](https://docs.whop.com/api-reference/course-lesson-interactions/courselessoninteraction-completed.md): Sent when a course lesson interaction is completed

#### Course Lessons

- [Course Lesson](https://docs.whop.com/api-reference/course-lessons/course-lesson.md): An individual learning unit within a chapter, which can contain text, video, PDF, or assessment content.
- [List course lessons](https://docs.whop.com/api-reference/course-lessons/list-course-lessons.md): Returns a paginated list of lessons within a course or chapter, ordered by position.
- [Create course lesson](https://docs.whop.com/api-reference/course-lessons/create-course-lesson.md): Create a new lesson within a course chapter. Lessons can contain video, text, or assessment content.
- [Delete course lesson](https://docs.whop.com/api-reference/course-lessons/delete-course-lesson.md): Permanently delete a lesson and remove it from its chapter.
- [Retrieve course lesson](https://docs.whop.com/api-reference/course-lessons/retrieve-course-lesson.md): Retrieves the details of an existing course lesson.
- [Update course lesson](https://docs.whop.com/api-reference/course-lessons/update-course-lesson.md): Update a lesson's content, type, visibility, assessment questions, or media attachments.
- [Mark as completed course lesson](https://docs.whop.com/api-reference/course-lessons/mark-as-completed-course-lesson.md): Mark a lesson as completed for the current user after they finish the content.
- [Start course lesson](https://docs.whop.com/api-reference/course-lessons/start-course-lesson.md): Record that the current user has started viewing a lesson, creating progress tracking records.
- [Submit assessment course lesson](https://docs.whop.com/api-reference/course-lessons/submit-assessment-course-lesson.md): Submit answers for a quiz or knowledge check lesson and receive a graded result.

#### Course Students

- [Course Student](https://docs.whop.com/api-reference/course-students/course-student.md): An enrollment record for a student in a course, including progress and completion metrics.
- [List course students](https://docs.whop.com/api-reference/course-students/list-course-students.md): Returns a paginated list of students enrolled in a course, with optional name filtering.
- [Retrieve course student](https://docs.whop.com/api-reference/course-students/retrieve-course-student.md): Retrieves the details of an existing course student.

#### Courses

- [Course](https://docs.whop.com/api-reference/courses/course.md): A structured learning module containing chapters and lessons, belonging to an experience.
- [List courses](https://docs.whop.com/api-reference/courses/list-courses.md): Returns a paginated list of courses, filtered by either an experience or a company.
- [Create course](https://docs.whop.com/api-reference/courses/create-course.md): Create a new course within an experience, with optional chapters, lessons, and a certificate.
- [Delete course](https://docs.whop.com/api-reference/courses/delete-course.md): Permanently delete a course and all of its chapters, lessons, and student progress.
- [Retrieve course](https://docs.whop.com/api-reference/courses/retrieve-course.md): Retrieves the details of an existing course.
- [Update course](https://docs.whop.com/api-reference/courses/update-course.md): Update a course's title, description, visibility, thumbnail, or chapter ordering.

### Payouts

- [Transfers](https://docs.whop.com/api-reference/transfers/transfer.md): The Transfers API is documented in the Whop API reference.

#### Identity Profiles

- [Identity Profile](https://docs.whop.com/api-reference/identity-profiles/identity-profile.md): A consolidated identity or business profile synced from verification provider data.
- [List identity profiles](https://docs.whop.com/api-reference/identity-profiles/list-identity-profiles.md): Returns a paginated list of identity profiles. When account_id is provided, lists IPs currently linked to that account's ledger. When omitted, lists IPs linked to any ledger the actor can read (including child accounts under a parent).
- [Unlink an identity profile](https://docs.whop.com/api-reference/identity-profiles/unlink-an-identity-profile.md): Unlinks an IdentityProfile from a LedgerAccount (flips the matching link to is_current=false).
- [Retrieve identity profile](https://docs.whop.com/api-reference/identity-profiles/retrieve-identity-profile.md): Retrieves the details of an existing identity profile.
- [List identity profile verifications](https://docs.whop.com/api-reference/identity-profiles/list-identity-profile-verifications.md): Returns a list of verifications attached to an identity profile, ordered by most recent first.
- [Identityprofile updated](https://docs.whop.com/api-reference/identity-profiles/identityprofile-updated.md): Sent whenever an identity profile changes state — a verification is approved, needs action, or is rejected, or a Whop review opens or clears. Every other identity_profile event is also delivered as an identity_profile.updated, so you can subscribe to this single event and re-fetch the verification t…

#### Ledger Accounts

- [Ledger Account](https://docs.whop.com/api-reference/ledger-accounts/ledger-account.md): A ledger account represents a financial account on Whop that can hold many balances.
- [Retrieve ledger account](https://docs.whop.com/api-reference/ledger-accounts/retrieve-ledger-account.md): Retrieves the details of an existing ledger account.
- [Ledgeraccount funds available](https://docs.whop.com/api-reference/ledger-accounts/ledgeraccount-funds-available.md): Sent when a ledger account is funds available

#### Payout Accounts

- [Payout Account](https://docs.whop.com/api-reference/payout-accounts/payout-account.md): An object representing an account used for payouts.
- [Retrieve payout account](https://docs.whop.com/api-reference/payout-accounts/retrieve-payout-account.md): Retrieves the details of an existing payout account.
- [Payoutaccount status updated](https://docs.whop.com/api-reference/payout-accounts/payoutaccount-status-updated.md): Sent when a payout account is status updated

#### Payout Methods

- [Payout Method](https://docs.whop.com/api-reference/payout-methods/payout-method.md): A configured payout destination where a user receives earned funds, such as a bank account or digital wallet.
- [List payout methods](https://docs.whop.com/api-reference/payout-methods/list-payout-methods.md): Returns a list of active payout methods configured for a company, ordered by most recently created.
- [Retrieve payout method](https://docs.whop.com/api-reference/payout-methods/retrieve-payout-method.md): Retrieves the details of an existing payout method.
- [Payoutmethod created](https://docs.whop.com/api-reference/payout-methods/payoutmethod-created.md): Sent when a payout method is created

#### Topups

- [Topup](https://docs.whop.com/api-reference/topups/topup.md): A payment represents a completed or attempted charge. Payments track the amount, status, currency, and payment method used.
- [Create topup](https://docs.whop.com/api-reference/topups/create-topup.md): Add funds to a company's platform balance by charging a stored payment method. Top-ups have no fees or taxes and do not count as revenue.

#### Verifications

- [Verification](https://docs.whop.com/api-reference/verifications/verification.md): An identity verification session used to confirm a person or entity's identity for payout account eligibility.
- [List verifications](https://docs.whop.com/api-reference/verifications/list-verifications.md): Returns a list of identity verifications for a payout account, ordered by most recent first.
- [Retrieve verification](https://docs.whop.com/api-reference/verifications/retrieve-verification.md): Retrieves the details of an existing verification.
- [Verification succeeded](https://docs.whop.com/api-reference/verifications/verification-succeeded.md): Sent when a verification is succeeded

### Ads

- [Ad Campaigns](https://docs.whop.com/api-reference/ad-campaigns/ad-campaign.md): The Ad campaigns API is documented in the Whop API reference.
- [Ad Groups](https://docs.whop.com/api-reference/ad-groups/ad-group.md): The Ad groups API is documented in the Whop API reference.
- [Ads](https://docs.whop.com/api-reference/ads/ad.md): The Ads API is documented in the Whop API reference.

## OpenAPI Specs

- [ledger-stats](/openapi/ledger-stats.yaml)
- [api-v1-stable](/openapi/api-v1-stable.json)