Accounts and identity
user_
A person with a Whop login. A user can buy from many accounts, and can also help run one. See Users.
A user granted access to operate an account. Their role decides what they can do. See Team members.
A user seen as a customer: someone who holds or once held a membership to something the account sells. See Members.
Connected account
An account you enroll and act for when you run a marketplace. You collect payments on its behalf and pay it out. Platform guides sometimes call this a sub-merchant. The two words mean the same object. The platform quickstart walks the whole flow.The identity check an account clears before it can receive payouts. Individuals complete Know Your Customer (KYC) checks. Businesses complete Know Your Business (KYB) checks. See Verifications.
idpf_
The record of verified identity data a verification produces.
What you sell
An account sells products. A product carries one or more plans, which set the price, and connects to the experiences a buyer actually gets.prod_
A thing an account sells. Holds the description, the media, and the plans a buyer can choose from. See Products.
plan_
One price and billing shape for a product: one-time or recurring, with an optional trial. A product can carry several. See Plans.
mem_
What a buyer gets when they pay. Ties a user to a plan and carries a status telling you whether access is valid right now. See Memberships.
Experience
A unit of content or functionality inside what an account sells. A product connects to one or more experiences, and a membership to that product is what grants access to them. This is Whop’s most platform-specific noun and the one you can’t guess from its name. If you are building an app that runs inside Whop, the experience is the thing your app renders into. See App views.Entitlement
The record that says a user may use a specific thing right now. Access is the question, and the entitlement is the stored answer. Check it against an account, a product, or an experience. See Authentication.How money moves
Money arrives, sits somewhere, then leaves. Every object below is one step along that path, in the order it happens.ch_
The reusable definition of a purchase: which plan, at what price, with what redirect. Produces a live checkout page. See Checkout configurations.
pay_
One attempt to move money from a buyer to an account, carrying a status that says whether it worked.
The same event described from the card network’s side. The docs use both words. The API object is the payment.
Ledger
The running record of every credit and debit on an account’s money. It’s the source of truth for what an account holds and what it’s owed. Money lands in a ledger before it goes anywhere else. See Ledger activity.The amount sitting on a ledger right now that you can spend or withdraw.
A slice of a balance Whop holds back against future refunds and disputes. It releases on a schedule.
Whop’s cut of a payment, taken before the money reaches a balance.
A completed payment returned to the buyer, initiated by you.
Building on Whop
Platform means two things in these docs. Whop-the-platform is the product you are integrating with. A platform in the marketplace sense is you, once you enroll connected accounts and take a cut of what they sell. The surrounding sentence tells you which is meant.
One screen an app renders inside Whop: the customer-facing experience view, or the creator-facing dashboard view. See App views.
How Whop embeds your app’s pages in its own interface. Your app runs on your servers and renders inside Whop’s chrome. See iframe.
A single capability an API key is allowed to exercise. See Permissions.
Scope
The same idea as a permission, but on an OAuth token: the set of things a user has agreed your app may do on their behalf. A permission is what your key can do. A scope is what a user let you do. See the OAuth guide.The record of a user approving your app for a set of scopes.
A prebuilt UI component Whop ships that you drop into your own product, so you don’t build the interface yourself.
Something that happened in an account, like a payment succeeding.
Community
One post in a chat channel or a direct message.
One thread in a forum, with its replies, and its reactions.
A message pushed to a user inside Whop. Each send is scoped to one experience or one user. See Notifications.
Advertising
adcamp_
The top-level container for paid ads on an ad network. Sets the platform, the objective, and the budget strategy. See Ad campaigns.
adgrp_
Sits inside a campaign and controls delivery: targeting, the optimization goal, and the schedule. See Ad groups.
A customer list uploaded to Whop and used to target or exclude people in an ad group. See Audiences.
Referrals and rewards
aff_
Someone who earns commission for sending buyers to a product. See Affiliates.
A user enrolled in Whop’s partner program, earning on the businesses they refer onto Whop. See Partners.
coma_
A business a partner brought onto Whop, carrying the commission rates and the referral window that apply to it.
One commission line for a referred business, naming the income source it came from and its status.
btys_
One worker’s attempt on a bounty, from the attempt through review, and on to payout.
Environments and keys
Whop runs two environments. They share nothing.
See Test in the sandbox for how to switch.
Four credential types reach the API. Pick by whose data you need.
See Auth & API keys for how to choose and scope each one.
The header that pins your integration to a dated version of the API, so later changes don’t alter the responses you built against. See API versioning.
A value you attach to a
POST so retrying it replays the original response instead of doing the work twice. See Idempotent requests.ID reference
Every object carries a prefixed ID. When you are staring at a payload, this table tells you what you are holding.Next steps
Quickstart
Make your first API call in a few minutes.
Test in sandbox
Try everything against test data before going live.
API overview
How requests, versioning, and pagination work.
What you can build
The full capability map, and the guide for what you’re building.