Introduction

🏠 Home
🔑 Authentication
🔒 OAuth Implementation
⛔️ Error Handling

oauth

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

Whop API

Products
Plans
Memberships
Companies
- Retrieve a Companyget
Experiences
Payments
- List Paymentsget
- Retrieve a Paymentget
Checkout Sessions
Members
- Retrieve Memberget
Customers
- List Customersget
- Retrieve Customerget
Promo Codes
Webhooks
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

Introduction

🏠 Home
🔑 Authentication
🔒 OAuth Implementation
⛔️ Error Handling

oauth

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

Whop API

Products
Plans
Memberships
Companies
- Retrieve a Companyget
Experiences
Payments
- List Paymentsget
- Retrieve a Paymentget
Checkout Sessions
Members
- Retrieve Memberget
Customers
- List Customersget
- Retrieve Customerget
Promo Codes
Webhooks
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

Retrieve a Checkout Session

get https://api.whop.com/api/v2/checkout_sessions/{id}

Returns a collection of Checkout Sessions, based on the supplied filters. By default, results are returned 10 objects at a time.

time	status	user agent
Retrieving recent requests…

Loading…

URL Expired

The URL for this request expired after 30 days.

Path Params

string

required

The ID of the session, which will look like ch_*************

Headers

Authorization

string

Your API key, which can be found on the Whop Business Dashboard. You must prepend your key with the word 'Bearer', which will look like Bearer ***************************

Response

Response body

object

string

The ID of the session, which will look like ch_*************

redirect_url

string

The URL the user will be navigated to after successfully completing a checkout with this session

affiliate_code

string

The code to apply as the affiliate for the transaction. Codes are a User object's username field.

metadata

object

The metadata that will be attached to the Membership upon successful purchase.

Has additional fields

plan_id

string

The ID of the plan that the checkout session is associated with, which will look like plan_*************

purchase_url

string

The URL that the customer can use to purchase with this checkout session.

Updated over 1 year ago

Create a Checkout Session

Delete a Checkout Session

Did this page help you?

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.whop.com/api/v2/checkout_sessions/id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

Create a Checkout Session

Delete a Checkout Session

Did this page help you?

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

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

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

Example Webhooks
membership.went_valid
membership.went_invalid
payment.succeeded
payment.failed
membership.metadata_updated

Other
⇪ Upgrading from v1.0

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

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

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

Example Webhooks
membership.went_valid
membership.went_invalid
payment.succeeded
payment.failed
membership.metadata_updated

Other
⇪ Upgrading from v1.0

200Retrieve a Checkout Session