For AI agents: visit https://whop.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
WhopWhop
API Reference
Log InWhop
API Reference
Log In
API Reference

Introduction

  • 🏠 Home
  • 🔑 Authentication
  • 🔒 OAuth Implementation
  • ⛔️ Error Handling

oauth

  • Obtain a user's access tokenpost
  • Retrieve Userget
  • Retrieve User Membershipsget

Whop API

  • Products
    • List Productsget
    • Retrieve a Productget
    • Update a Productpost
  • Plans
    • List Plansget
    • Create a planpost
    • Retrieve a Planget
    • Update a Planpost
    • Create a quick linkpost
  • Memberships
    • List Membershipsget
    • Retrieve a Membershipget
    • Update a Membershippost
    • Add Free Days to a Membershippost
    • Terminate a Membershippost
    • Cancel a Membershippost
    • Validate a License Keypost
  • Companies
    • Retrieve a Companyget
  • Experiences
    • List Experiencesget
    • Retrieve an Experienceget
    • Update an Experiencepost
    • Delete an Experiencedel
  • Payments
    • List Paymentsget
    • Retrieve a Paymentget
  • Checkout Sessions
    • List Checkout Sessionsget
    • Create a Checkout Sessionpost
    • Retrieve a Checkout Sessionget
    • Delete a Checkout Sessiondel
  • Members
    • Retrieve Memberget
  • Customers
    • List Customersget
    • Retrieve Customerget
  • Promo Codes
    • List Promo Codesget
    • Create a promo codepost
    • Retrieve a promo codeget
    • Update a promo codepost
    • Delete a promo codedel
  • Webhooks
    • List Webhooksget
    • Create a Webhookpost
    • Retrieve a Webhookget
    • Update a Webhookpost
    • Delete a Webhookdel
  • Reviews
    • List Reviewsget
    • Retrieve a reviewget

Example Webhooks

  • membership.went_valid
  • membership.went_invalid
  • payment.succeeded
  • payment.failed
  • membership.metadata_updated

Other

  • ⇪ Upgrading from v1.0
  • 📖 View our integration docs
  • Whop Dev Discord Server
Powered by 

🏠 Home

2048

📘

Integration Docs

View our full integration guides here for in-depth tutorials and the easiest way to get started!

Updated about 3 years ago


What’s Next

Ready to dive in? Get started with one of the primary use cases:

Did this page help you?

Updated about 3 years ago


What’s Next

Ready to dive in? Get started with one of the primary use cases:

Did this page help you?