> ## Documentation Index
> Fetch the complete documentation index at: https://docs.whop.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> What the API does, how requests work, and a map of every resource.

The Whop API is how you move money programmatically. Accept payments with checkout links, hold balances, send payouts, issue cards, transfer funds between accounts, and manage the products and plans you sell. All of it from your server with one API key.

## Make a request

The base URL is `https://api.whop.com/api/v1`. Authenticate every request with a Bearer API key:

```bash theme={null}
curl https://api.whop.com/api/v1/accounts/me \
  -H "Authorization: Bearer $WHOP_API_KEY"
```

```json theme={null}
{
	"id": "biz_XXXXXXXX",
	"title": "Acme Studio",
	"route": "acme-studio",
	"status": "approved"
}
```

New here? The [Quickstart](/api-reference/beta/quickstart) gets you from [creating a key](https://whop.com/dashboard/developer) to a live checkout link in about five minutes.

## How the API works

### Authentication

[Create an API key here](https://whop.com/dashboard/developer) under **Account API Keys**. Keys are scoped to an account and carry the permissions you grant them. Keep keys on your server, never in browser code, mobile apps, or public repos.

### Versioning

The API is versioned by date. Send an `Api-Version-Date` header (like `2026-07-01`) to pin the request and response shapes you built against; later changes won't break a pinned caller. When you omit the header, requests use the original `2025-01-01` shapes, and generated SDKs always send the latest version they were built against. See [Versioning](/developer/api/versioning).

### Pagination

List endpoints return a `data` array plus a `page_info` object. Pass `first` to set the page size and `after` with the previous response's `page_info.end_cursor` to fetch the next page. `page_info.has_next_page` tells you when to stop.

### Errors

Failed requests return a conventional HTTP status (`400`, `401`, `403`, `404`) and a body with a single `error` object: `type` is a machine-readable code and `message` explains what went wrong.

```json theme={null}
{
	"error": {
		"type": "invalid_parameters",
		"message": "initial_price must be greater than 0"
	}
}
```

## Resources

### Core Resources

The accounts and people everything else hangs off.

| Resource                                         | What it's for                                                |
| ------------------------------------------------ | ------------------------------------------------------------ |
| [Accounts](/api-reference/beta/accounts/account) | A business on Whop: profile, wallet, capabilities, settings. |
| [Users](/api-reference/beta/users/user)          | A person on Whop: profile and connected identities.          |
| [Stats](/api-reference/beta/stats/stats)         | Aggregated account time series for reporting.                |

### Money

Balances and every way funds move in or out.

| Resource                                                        | What it's for                                             |
| --------------------------------------------------------------- | --------------------------------------------------------- |
| [Ledgers](/api-reference/beta/ledgers/ledger-activity)          | The activity feed behind an account or user's balance.    |
| [Payouts](/api-reference/beta/payouts/payout)                   | Send money from a balance to a bank or wallet.            |
| [Cards](/api-reference/beta/cards/card)                         | Issue cards that spend from a balance.                    |
| [Transfers](/api-reference/beta/transfers/transfer)             | Move funds between Whop accounts and users.               |
| [Deposits](/api-reference/beta/deposits/deposit)                | Add funds to a balance.                                   |
| [Swaps](/api-reference/beta/swaps/swap)                         | Convert a balance between currencies.                     |
| [Verifications](/api-reference/beta/verifications/verification) | Identity review required before payouts and card issuing. |

### Commerce

Sell products and get paid.

| Resource                                                                                      | What it's for                                              |
| --------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| [Products](/api-reference/beta/products/product)                                              | The things you sell. Each owns plans and a store page.     |
| [Plans](/api-reference/beta/plans/plan)                                                       | Pricing for a product: one-time, recurring, trials, stock. |
| [Checkout Configurations](/api-reference/beta/checkout-configurations/checkout-configuration) | Turn a plan into a shareable, prefilled checkout link.     |

### Referrals

Refer users and businesses to Whop and track what you earn.

| Resource                                           | What it's for                                                               |
| -------------------------------------------------- | --------------------------------------------------------------------------- |
| [Partners](/api-reference/beta/referrals/referral) | The users and businesses you referred to Whop, and what you earn from them. |

### Workforce

Post paid tasks and pay people for completed work.

| Resource                                                                      | What it's for                                              |
| ----------------------------------------------------------------------------- | ---------------------------------------------------------- |
| [Workforce Bounties](/api-reference/beta/workforce-bounties/workforce-bounty) | Paid tasks with reviewed submissions and escrowed rewards. |

### Tracking

Who visits and what converts, captured by the pixel.

| Resource                                    | What it's for                                                       |
| ------------------------------------------- | ------------------------------------------------------------------- |
| [People](/api-reference/beta/people/person) | Visitors and customers of an account, aggregated from pixel events. |
| [Events](/api-reference/beta/events/event)  | Conversion and engagement events tracked for attribution.           |

### Ads

Run and measure ad campaigns from your integration.

| Resource                                                     | What it's for                                         |
| ------------------------------------------------------------ | ----------------------------------------------------- |
| [Ads](/api-reference/beta/ads/ad)                            | The creative: copy, assets, and destination URL.      |
| [Ad Campaigns](/api-reference/beta/ad-campaigns/ad-campaign) | Platform, objective, and budget for a set of ads.     |
| [Ad Groups](/api-reference/beta/ad-groups/ad-group)          | Audience, placements, and schedule within a campaign. |
| [Audiences](/api-reference/beta/audiences/audience)          | Reusable targeting lists for ad groups.               |

### Media

Generate media assets from your integration.

| Resource                                 | What it's for                                                                       |
| ---------------------------------------- | ----------------------------------------------------------------------------------- |
| [Media](/api-reference/beta/media/media) | AI-generated assets, billed from a balance, attachable wherever files are accepted. |

### Identity

Accounts connected from other platforms.

| Resource                                                              | What it's for                                           |
| --------------------------------------------------------------------- | ------------------------------------------------------- |
| [Social Accounts](/api-reference/beta/social-accounts/social-account) | Connected Facebook and Instagram accounts that run ads. |

### Developer

Build, host, and observe apps on the Whop platform.

| Resource                             | What it's for                                                  |
| ------------------------------------ | -------------------------------------------------------------- |
| [Apps](/api-reference/beta/apps/app) | Apps you build on Whop: metadata, hosted builds, runtime logs. |
