# Whop Docs: For Developers

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

## For Developers

- [For Developers / API Reference (761 pages)](https://docs.whop.com/_llms/for-developers/api-reference.md): Documentation for For Developers / API Reference.
- [For Developers / SDKs & Tools (121 pages)](https://docs.whop.com/_llms/for-developers/sdks-and-tools.md): Documentation for For Developers / SDKs & Tools.

### Start Here

#### Get Started

- [What You Can Build with Whop](https://docs.whop.com/developer/start.md): Payments, payouts, identity, community, and distribution through one API. Pick your mode and make your first call in about five minutes.
- [Quickstart](https://docs.whop.com/developer/quickstart.md): Create your Whop account, get an API key, make your first call, take a payment, and test a webhook.
- [Test in the Sandbox](https://docs.whop.com/developer/guides/sandbox.md): Test your integration in a safe environment before going live

#### Foundations

- [Core Concepts](https://docs.whop.com/developer/concepts.md): The objects Whop's API is built from: what each one is, what it's called, and how they connect.
- [Auth & API Keys](https://docs.whop.com/developer/guides/auth-scoping.md): The five Whop credential types, when to use each, and how to scope a credential down to the actions it actually needs.

#### Support

- [Troubleshooting](https://docs.whop.com/developer/troubleshooting.md): Fix common Whop API, OAuth, checkout, webhook, and Whop Elements errors.

### AI Tools

- [AI Tools](https://docs.whop.com/developer/ai/overview.md): MCP servers, an installable skill, an LLM page index, and raw Markdown for every page: what Whop gives a coding agent.
- [AI and MCP](https://docs.whop.com/developer/guides/ai_and_mcp.md): Per-client setup for both Whop MCP servers, browser sign-in, confirmation and idempotency, plus the LLM page index and raw Markdown for agents with no MCP client.
- [Build with the CLI and Claude](https://docs.whop.com/developer/guides/cli-with-claude.md): Use the Whop CLI together with Claude to scaffold, build, and ship a Whop app from your terminal.
- [Blueprints](https://docs.whop.com/developer/guides/blueprints.md): Start from a working Whop business. Browse the blueprint gallery, deploy one in a step, or clone its code and hand it to your AI assistant.

#### Plugins

- [Claude Code](https://docs.whop.com/developer/guides/plugins/claude-code.md): Install the Whop plugin for Claude Code to run your business from the terminal — products, checkout, payments, payouts, ads, and stats.
- [Grok](https://docs.whop.com/developer/guides/plugins/grok.md): Install the Whop plugin for Grok Build to run your business from the terminal — products, checkout, payments, payouts, ads, and stats.

### Build

#### Payments

- [Payments Overview](https://docs.whop.com/developer/payments/overview.md): Accept one-time and recurring payments, manage subscriptions, and handle refunds and disputes.
- [Accept Payments](https://docs.whop.com/developer/guides/accept-payments.md): Accept one-time and recurring payments across 195 countries with 100+ payment methods
- [Build a Checkout with Payment Elements](https://docs.whop.com/developer/guides/payment-elements.md): Design your own checkout around the payment elements: collect a confirmation token in the browser, charge it from your server, and fulfill from a webhook
- [Embed a Checkout](https://docs.whop.com/developer/guides/embed-checkout.md): Drop Whop's whole checkout into your page with the Checkout element, straight from the browser, and fulfill from a webhook
- [Add Express Checkout](https://docs.whop.com/developer/guides/express-checkout.md): Put one-press Apple Pay and Google Pay buttons on your page with the Express Checkout element, straight from the browser, and fulfill from a webhook
- [Open a Wallet Sheet from Your Own Button](https://docs.whop.com/developer/guides/payment-request.md): Open the Apple Pay or Google Pay sheet from a button you render, price the order yourself, and charge the confirmation token from your server
- [Enable Apple Pay and Google Pay](https://docs.whop.com/payments/apple-pay.md): Enable Apple Pay and Google Pay on your own domain by verifying it as a payment method domain
- [Save Payment Methods](https://docs.whop.com/developer/guides/save-payment-methods.md): Save customer payment methods to charge them later
- [Refunds and Disputes](https://docs.whop.com/developer/guides/refunds-and-disputes.md): Issue refunds, respond to disputes with evidence, and listen for chargeback events.
- [Manage Fraud](https://docs.whop.com/developer/guides/manage-fraud.md): Cut fraud and chargebacks with payment rules that block risky checkouts, send card payments to review, challenge them with 3D Secure, or let trusted buyers through.

##### iOS Payments

- [iOS Checkout SDK](https://docs.whop.com/developer/guides/ios/overview.md): Sell in-app purchases and subscriptions natively on iOS (2.7% + $0.30 vs Apple's 15-30%)
- [Installation](https://docs.whop.com/developer/guides/ios/installation.md): Install the WhopCheckout SDK and configure it with an iap:read API key
- [Build a Paywall](https://docs.whop.com/developer/guides/ios/build-a-paywall.md): Display subscription variants and handle purchases in your iOS app
- [Accept One-time Payments](https://docs.whop.com/developer/guides/ios/accept-one-time-payments.md): Sell physical goods and real-world services with native Apple Pay through Whop (2.7% + $0.30 fees)
- [Check Entitlements](https://docs.whop.com/developer/guides/ios/check-entitlements.md): Verify subscription status and gate premium content in your iOS app
- [API Reference](https://docs.whop.com/developer/guides/ios/checkout-reference.md): Complete API documentation for WhopCheckout

#### Payouts & Money Movement

- [Payouts & Money Movement](https://docs.whop.com/developer/payouts/overview.md): Pay out users, move money between accounts, and read balances and ledgers.
- [Add Funds to Your Balance](https://docs.whop.com/developer/platforms/add-funds-to-your-balance.md): Top up your platform balance to pay out connected accounts
- [Enable Connected Account Payouts](https://docs.whop.com/developer/platforms/render-payout-portal.md): Let your connected accounts manage their own payouts with Whop Elements or a hosted portal
- [Manual Payouts to Connected Accounts](https://docs.whop.com/developer/platforms/manual-payouts.md): Onboard connected accounts and programmatically pay them out
- [Wallet Stats API](https://docs.whop.com/developer/guides/ledger-stats.md): Query aggregated financial time-series from your Fragment ledger
- [Stats API](https://docs.whop.com/developer/guides/stats.md): Discover metrics and query revenue, payments, and engagement over time

#### Communities & Chat

##### Get Started

- [Communities & Chat](https://docs.whop.com/developer/communities/overview.md): Send messages, run channels and forums, and push notifications inside any Whop community.
- [Playground](https://docs.whop.com/developer/guides/chat/playground.md): Interactive playground for embedded chat components

##### Setup

- [Chat Quickstart](https://docs.whop.com/developer/guides/chat/quickstart.md): Give your users a real-time messaging chat on web and native iOS. Support many types of conversations. Whop handles the messages, real-time updates, media uploads, and UI.
- [Chat Authentication](https://docs.whop.com/developer/guides/chat/authentication.md): Authenticate users for embedded chat with account-scoped tokens or OAuth
- [Sync Your Users](https://docs.whop.com/developer/guides/chat/sync-users.md): Create or map Whop users with your own platform users.
- [Chat OAuth](https://docs.whop.com/developer/guides/chat/oauth.md): Authenticate embedded chat users with Whop OAuth and SDK-managed sign-in.

##### Chat Types

- [Channels](https://docs.whop.com/developer/guides/chat/channels.md): Use channels for shared chat rooms connected to products and memberships
- [Direct Messages](https://docs.whop.com/developer/guides/chat/direct-messages.md): Use DMs for private and group conversations between users
- [Support Chats](https://docs.whop.com/developer/guides/chat/support-chats.md): Use support chats for one-on-one customer support conversations with your account

##### Components

- [Chat Element](https://docs.whop.com/developer/guides/chat/chat-element.md): Display a chat in your app
- [DMs List Element](https://docs.whop.com/developer/guides/chat/dms-list-element.md): Display a list of direct message conversations
- [Theming & Styles](https://docs.whop.com/developer/guides/chat/theming-and-styles.md): Customize the appearance of chat elements

#### Whop Apps

- [Whop Apps](https://docs.whop.com/developer/apps/overview.md): Ship an app that thousands of Whop businesses can install from the App Store.
- [Permissions](https://docs.whop.com/developer/guides/permissions.md): Configure the permissions your app needs and request approval from the creators who install it.
- [App Views](https://docs.whop.com/developer/guides/app-views.md): Configure how and where your app appears on Whop
- [Frosted UI](https://docs.whop.com/developer/guides/frosted_ui.md): Use Whop's UI kit and Tailwind design system.
- [Authentication](https://docs.whop.com/developer/guides/authentication.md): Verify the current user and check their access level inside your Whop app.
- [OAuth](https://docs.whop.com/developer/guides/oauth.md): Add "Sign in with Whop" to your site with OAuth 2.1 and Proof Key for Code Exchange (PKCE).
- [React Native](https://docs.whop.com/developer/guides/react-native.md): Build cross-platform mobile and web apps for Whop using React Native.
- [Development Proxy](https://docs.whop.com/developer/guides/dev-proxy.md): Run the Whop development proxy to replicate production authentication and iframe behavior during development.
- [Iframe SDK](https://docs.whop.com/developer/guides/iframe.md): Interact with the whop website from within your app.
- [Chat](https://docs.whop.com/developer/guides/chat.md): Send messages, manage channels, and react to events in any Whop community.
- [Forums](https://docs.whop.com/developer/guides/forums.md): Create forum posts, fetch threads, and add comments or reactions inside any Whop community.
- [Push Notifications](https://docs.whop.com/developer/guides/notifications.md): Send push notifications to users in your app, scoped by experience or account.
- [Affiliates](https://docs.whop.com/developer/guides/affiliates.md): Create affiliate records, assign per-variant or rev-share commission overrides, and track referral earnings.
- [Memberships](https://docs.whop.com/developer/guides/memberships.md): Manage subscription lifecycle. Pause, resume, cancel, restore, and add free days.
- [Upload Files](https://docs.whop.com/developer/guides/upload-files.md): Upload images and files for use across the Whop platform
- [Upload Files Directly](https://docs.whop.com/developer/guides/direct-file-uploads.md): Upload files to Whop storage with presigned single-part and multipart uploads
- [Example Integration](https://docs.whop.com/developer/guides/example-integration.md): Build a marketplace on top of Whop's global payment and payout rails.

#### Websites

- [Websites](https://docs.whop.com/developer/websites/overview.md): Ship a fully hosted website on Whop — served at your own whop.site address, versioned on every deploy, and wired to payments and analytics.
- [Build a Website with the CLI](https://docs.whop.com/developer/websites/quickstart.md): Scaffold a Vite app, run it locally against real Whop data, and deploy it to your own whop.site address.
- [Blueprints](https://docs.whop.com/developer/websites/blueprints.md): Deploy a working Whop business — products, pricing, and a live website — in one step, or clone its code with the CLI.
- [Hosting](https://docs.whop.com/developer/websites/hosting.md): What Whop runs when someone visits your site: builds and rollbacks, app secrets, automatic API authentication, and server logs.
- [Track Visitors](https://docs.whop.com/developer/websites/tracking.md): Every site on whop.site ships the Whop pixel already installed. Page views and checkout events are automatic; add whop.track calls for the funnel steps Whop can't see.

#### Marketplaces & Platforms

- [Marketplaces & Platforms](https://docs.whop.com/developer/marketplaces/overview.md): Build on Whop's payment and payout rails: connected accounts, affiliates, and identity verification.
- [Platform Quickstart](https://docs.whop.com/developer/platforms/quickstart.md): Embed a payout portal for your connected accounts with Whop Elements in minutes
- [Enroll Connected Accounts](https://docs.whop.com/developer/platforms/enroll-connected-accounts.md): Onboard businesses or individuals to your platform and facilitate payments
- [Collect Payments for Connected Accounts](https://docs.whop.com/developer/platforms/collect-payments-for-connected-accounts.md): Direct charges and transfers for connected accounts

##### Verification

- [Verification](https://docs.whop.com/developer/verification/overview.md): Verify your users' identities before they can receive payouts. One API call starts Know Your Customer (KYC) verification, and Whop handles everything else.
- [Check Status](https://docs.whop.com/developer/verification/retrieve.md): List verifications for an account and read verified identity data.
- [Handle RFIs](https://docs.whop.com/developer/verification/rfis.md): Respond when Whop needs more information — a document, tax ID, or business detail.
- [Update & Delete](https://docs.whop.com/developer/verification/manage.md): Update identity fields before verification, or remove a verification entirely.
- [Identity Documents](https://docs.whop.com/developer/verification/identity-documents.md): Which identity documents the API accepts, and the exact file keys to send for each.
- [Business Structures](https://docs.whop.com/developer/verification/business-structures.md): business_structure values by country of incorporation.

#### Ads

- [Advertising](https://docs.whop.com/developer/ads/overview.md): Run ads through Whop with account-level billing. Learn how shared payments, delivery failures, and account payment retries work.
- [Install the Whop Pixel](https://docs.whop.com/developer/ads/pixel.md): How to use the Whop Pixel to capture the full customer journey.
- [Send Server-Side Events](https://docs.whop.com/developer/ads/events-api.md): Send conversion events from your server and tie them to the visitor the Whop Pixel already tracks.

##### Integrate with Hosting Platforms

- [Install the Whop Pixel on ClickFunnels](https://docs.whop.com/developer/ads/platforms/clickfunnels.md): Add the Whop Pixel to a ClickFunnels funnel so every step is tracked.
- [Install the Whop Pixel on GoHighLevel](https://docs.whop.com/developer/ads/platforms/gohighlevel.md): Add the Whop Pixel to a GoHighLevel site or funnel so every step is tracked.
- [Install the Whop Pixel on Kajabi](https://docs.whop.com/developer/ads/platforms/kajabi.md): Add the Whop Pixel to a Kajabi site so every page is tracked.
- [Install the Whop Pixel on WordPress](https://docs.whop.com/developer/ads/platforms/wordpress.md): Add the Whop Pixel to a WordPress site so every page is tracked.
- [Install the Whop Pixel on WooCommerce](https://docs.whop.com/developer/ads/platforms/woocommerce.md): Add the Whop Pixel to a WooCommerce store so every page is tracked.
- [Install the Whop Pixel on Shopify](https://docs.whop.com/developer/ads/platforms/shopify.md): Add the Whop Pixel to a Shopify storefront with a theme snippet, plus a custom pixel that covers checkout.

##### Integrate with Sales Tools

- [Install the Whop Pixel on WebinarJam](https://docs.whop.com/developer/ads/platforms/webinarjam.md): Add the Whop Pixel to a WebinarJam webinar so every step is tracked.
- [Install the Whop Pixel with iClosed](https://docs.whop.com/developer/ads/platforms/iclosed.md): Track iClosed bookings with the Whop Pixel using a custom confirmation page.
- [Install the Whop Pixel with Calendly](https://docs.whop.com/developer/ads/platforms/calendly.md): Track Calendly bookings with the Whop Pixel.

#### Bounties

- [Bounties](https://docs.whop.com/developer/bounties/overview.md): Post paid tasks with an escrowed reward, collect submitted work from workers, and pay out on approval.
- [Run a Bounty Program](https://docs.whop.com/developer/bounties/run-a-bounty-program.md): Post bounties on behalf of an account, fund the escrow, and surface the submission queue in your own product: rewards, the $5 escrow floor, `experience_id`, and review.

#### Partners

- [Partners](https://docs.whop.com/developer/partners/overview.md): Refer businesses onto Whop and earn on their activity across two tiers, with a referral link and earnings you can read from the API.

## OpenAPI Specs

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