Use cases

Create a checkout configuration
Onboard sub-merchants
Verify your platform account
Programmatically pay out users
Generate payout onboarding links for your sub-merchants

pnpm install @whop/sdk

pip install whop-sdk

gem install whop_sdk

Before you begin, follow the Quickstart to create an API key.

Troubleshoot API requests

Debug authentication failures, permission errors, retryable responses, and sandbox/production mismatches.

from whop_sdk import Whop, BadRequestError
import random

client = Whop(
    api_key="YOUR_API_KEY",
)

your_company_id = "YOUR_COMPANY_ID"

# 1. Create a checkout configuration
checkout = client.checkout_configurations.create(
    currency="usd",
    plan={
        "initial_price": 10.0,
        "plan_type": "one_time",
        "company_id": your_company_id,
        "currency": "usd",
        "payment_method_configuration": {
            "enabled": [
                "crypto", # low fees
                "us_bank_transfer", # very low fees
                "apple_pay", # standard cc rates
            ],
            "disabled": [
                "acss_debit",
                "affirm",
                "afterpay_clearpay",
                "alipay",
                "alma",
                "amazon_pay",
            ],
        },
    },
    metadata={
        "order_id": "order_12345",
    },
)

checkout_link = f"https://whop.com/checkout/{checkout.plan.id}"
print(f"\n✅ Checkout created → {checkout_link}\n   (redirect customers here to pay or embed it)")
input("\nPress Enter to continue...")

# 2. Onboard sub-merchants to pay them out
sub_merchant = client.companies.create(
    email="merchant@example.com",
    parent_company_id=your_company_id,
    title="Acme Merchant Store #" + str(random.randint(1, 200)),
    # logo=FileAttachment("https://example.com/logo.png"),
    metadata={
        "internal_user_id": "user_12345",
        "seller_tier": "gold",
    },
)
print(f"\n✅ Sub-merchant onboarded → {sub_merchant.id}")

# 2.5 Verify your platform account (skip if already done)
# Your account must be verified to send transfers.
print(f"\n🔐 Verify your platform account:\n   https://whop.com/payouts/{your_company_id}/verify/")
input("\nPress Enter when done...")

# 3. Programmatically pay out users
while True:
    try:
        transfer = client.transfers.create(
            amount=1.0,
            currency="usd",
            origin_id=your_company_id,
            destination_id=sub_merchant.id,
            metadata={"reason": "creator_payout"},
        )
        print(f"\n✅ Transfer complete → {transfer.id}")
        break
    except BadRequestError as e:
        print(f"\n❌ Transfer failed: {e}")
        input("\nFix the issue above, then press Enter to retry...")


# 4. Generate a payout onboarding link for your sub-merchant
# Short-lived URL — send to the sub-merchant to complete identity verification and payout setup.
account_link = client.account_links.create(
    company_id=sub_merchant.id,
    refresh_url="https://yourapp.com/onboarding/refresh",
    return_url="https://yourapp.com/onboarding/complete",
    use_case="account_onboarding",
)
print(f"\n✅ Send to sub-merchant for payout setup:\n   {account_link.url}")

import Whop from "@whop/sdk";
import * as readline from "node:readline/promises";

const client = new Whop({
  apiKey: "YOUR_API_KEY",
});

const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
const yourCompanyId = "YOUR_COMPANY_ID";

// 1. Create a checkout configuration
const checkout = await client.checkoutConfigurations.create({
  currency: "usd",
  plan: {
    initial_price: 10.0,
    plan_type: "one_time",
    company_id: yourCompanyId,
    currency: "usd",
    payment_method_configuration: {
      enabled: [
        "crypto", // low fees
        "us_bank_transfer", // very low fees
        "apple_pay", // standard cc rates
      ],
      disabled: [
        "acss_debit",
        "affirm",
        "afterpay_clearpay",
        "alipay",
        "alma",
        "amazon_pay",
      ],
    },
  },
  metadata: {
    order_id: "order_12345",
  },
});

const checkoutLink = `https://whop.com/checkout/${checkout.plan.id}`;
console.log(`\n✅ Checkout created → ${checkoutLink}\n   (redirect customers here to pay or embed it)`);
await rl.question("\nPress Enter to continue...");

// 2. Onboard sub-merchants to pay them out
const subMerchant = await client.companies.create({
  email: "merchant@example.com",
  parent_company_id: yourCompanyId,
  title: `Acme Merchant Store #${Math.floor(Math.random() * 200) + 1}`,
  // logo: new File([...], "logo.png"),
  metadata: {
    internal_user_id: "user_12345",
    seller_tier: "gold",
  },
});
console.log(`\n✅ Sub-merchant onboarded → ${subMerchant.id}`);

// 2.5 Verify your platform account (skip if already done)
// Your account must be verified to send transfers.
console.log(`\n🔐 Verify your platform account:\n   https://whop.com/payouts/${yourCompanyId}/verify/`);
await rl.question("\nPress Enter when done...");

// 3. Programmatically pay out users
while (true) {
  try {
    const transfer = await client.transfers.create({
      amount: 1.0,
      currency: "usd",
      origin_id: yourCompanyId,
      destination_id: subMerchant.id,
      metadata: { reason: "creator_payout" },
    });
    console.log(`\n✅ Transfer complete → ${transfer.id}`);
    break;
  } catch (err) {
    if (err instanceof Whop.BadRequestError) {
      console.log(`\n❌ Transfer failed: ${err.message}`);
      await rl.question("\nFix the issue above, then press Enter to retry...");
      continue;
    }
    throw err;
  }
}

// 4. Generate a payout onboarding link for your sub-merchant
// Short-lived URL — send to the sub-merchant to complete identity verification and payout setup.
const accountLink = await client.accountLinks.create({
  company_id: subMerchant.id,
  refresh_url: "https://yourapp.com/onboarding/refresh",
  return_url: "https://yourapp.com/onboarding/complete",
  use_case: "account_onboarding",
});
console.log(`\n✅ Send to sub-merchant for payout setup:\n   ${accountLink.url}`);

rl.close();

require "whop_sdk"

whop = WhopSDK::Client.new(
  api_key: "YOUR_API_KEY",
)

your_company_id = "YOUR_COMPANY_ID"

# 1. Create a checkout configuration
checkout = whop.checkout_configurations.create(
  currency: "usd",
  plan: {
    initial_price: 10.0,
    plan_type: "one_time",
    company_id: your_company_id,
    currency: "usd",
    payment_method_configuration: {
      enabled: [
        "crypto", # low fees
        "us_bank_transfer", # very low fees
        "apple_pay", # standard cc rates
      ],
      disabled: [
        "acss_debit",
        "affirm",
        "afterpay_clearpay",
        "alipay",
        "alma",
        "amazon_pay",
      ],
    },
  },
  metadata: {
    order_id: "order_12345",
  },
)

checkout_link = "https://whop.com/checkout/#{checkout.plan.id}"
puts "\n✅ Checkout created → #{checkout_link}\n   (redirect customers here to pay or embed it)"
print "\nPress Enter to continue..."
gets

# 2. Onboard sub-merchants to pay them out
sub_merchant = whop.companies.create(
  email: "merchant@example.com",
  parent_company_id: your_company_id,
  title: "Acme Merchant Store ##{rand(1..200)}",
  metadata: {
    internal_user_id: "user_12345",
    seller_tier: "gold",
  },
)
puts "\n✅ Sub-merchant onboarded → #{sub_merchant.id}"

# 2.5 Verify your platform account (skip if already done)
# Your account must be verified to send transfers.
puts "\n🔐 Verify your platform account:\n   https://whop.com/payouts/#{your_company_id}/verify/"
print "\nPress Enter when done..."
gets

# 3. Programmatically pay out users
loop do
  begin
    transfer = whop.transfers.create(
      amount: 1.0,
      currency: "usd",
      origin_id: your_company_id,
      destination_id: sub_merchant.id,
      metadata: { reason: "creator_payout" },
    )
    puts "\n✅ Transfer complete → #{transfer.id}"
    break
  rescue WhopSDK::Errors::BadRequestError => e
    puts "\n❌ Transfer failed: #{e.message}"
    print "\nFix the issue above, then press Enter to retry..."
    gets
  end
end

# 4. Generate a payout onboarding link for your sub-merchant
# Short-lived URL — send to the sub-merchant to complete identity verification and payout setup.
account_link = whop.account_links.create(
  company_id: sub_merchant.id,
  refresh_url: "https://yourapp.com/onboarding/refresh",
  return_url: "https://yourapp.com/onboarding/complete",
  use_case: "account_onboarding",
)
puts "\n✅ Send to sub-merchant for payout setup:\n   #{account_link.url}"

API keys

Account API keys

Use Account API keys when you only want to fetch data or perform actions for your own Account and connected accounts.

Follow the Quickstart API key steps and open Account API Keys.
Select Create in the Account API Keys section.
Give your API key a name, such as Data pipeline or GHL Integration.
Select a role or a custom set of permissions. You can update the key and add permissions later.
Create the API key, and copy it from the modal.

App API keys

Use app API keys when you are building an app and need to access data on companies that have installed your app.

Follow the Quickstart API key steps and open Apps.
Select Create app and give your app a name. You can change this name later.
Your API key is the hidden text after WHOP_API_KEY in the Environment variables section. Use the reveal button to show the key, copy it and keep it in a safe place. You will need it to make API calls.

OAuth tokens

Use OAuth tokens when you want users to sign in with their Whop account and grant your app permission to act on their behalf. Unlike API keys which use your app’s permissions, OAuth tokens are scoped to what each individual user can access.Common use cases:

“Sign in with Whop” authentication
Accessing a user’s memberships, purchases, or profile
Performing actions as a specific user (not as your app)

OAuth tokens are obtained through the OAuth 2.1 + PKCE flow:

Redirect users to Whop’s authorization page
User logs in and approves your requested scopes
Exchange the authorization code for access and refresh tokens
Use the access token as your API key in SDK calls or the Authorization header

See the OAuth guide for full implementation details.

Making API calls

The public API is available at https://api.whop.com/api/v1. Use curl to test the API by fetching your public user profile data:

# replace "j" with your own whop username
curl https://api.whop.com/api/v1/users/j

To make authenticated requests you need to include your API key in the Authorization header using the Bearer scheme:

# replace "YOUR_API_KEY" with your real API key
curl https://api.whop.com/api/v1/payments?company_id=biz_xxxxxxxxxxx \
    -H "Authorization: Bearer YOUR_API_KEY"

SDK reference

MCP

You can also access the API through the Whop Model Context Protocol server at https://mcp.whop.com/mcp (Cursor) or https://mcp.whop.com/sse (Claude). Learn more here

Introduction

Ledger stats

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats

Getting started

Use cases

Troubleshoot API requests

API keys

Making API calls

SDK reference

MCP

​Use cases

Troubleshoot API requests

​API keys

​Making API calls

​SDK reference

​MCP

Use cases

API keys

Making API calls

SDK reference

MCP