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 Plan

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

Returns a specific Plan, using its unique ID. Plans represent a pricing and release method configuration used to purchase a Product.

URL Expired

The URL for this request expired after 30 days.

Path Params

string

required

The ID of the Plan, which will look like plan_*************

Query Params

expand

array of strings

Whether or not to expand the Product on the returned Plan(s). Pass an array with each object(s) you want to expand, e.g. [product]

expand

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 Plan, which will look like plan_*************

product

string

The Product this Plan is tied to. By default this will just be the ID of the Product, but you can expand it to get more information about the Product by passing [product] in the expand parameter.

plan_type

string

Whether the Plan is a renewal or one-time purchase

release_method

string

The method the customer will use to gain access to this Plan's Product

visibility

string

The level of visibility of the Plan

visible hidden archived quick_link

billing_period

int32

How often a user will get charged for their membership (if it is a renewal plan), in number of days

internal_notes

string

A nickname for the Plan set by the company and not visible to the customer

metadata

object

A polymorphic object containing information that can be user defined

Has additional fields

direct_link

string

A URL that targets a customer on this specific Plan

renewal_price

float

The price to be charged for each successive billing period

initial_price

float

The price to be initially charged when a user first purchases the Plan

base_currency

string

The base currency

requirements

object

Represents the different restrictions (if any) in place for purchasing the Plan

Has additional fields

release_method_settings

object

Configurable settings on how this Plan is released.

Has additional fields

accepted_payment_methods

array of arrays

An array of payment methods that are accepted for this Plan

accepted_payment_methods

array

stock

int32

The amount of stock left in the Plan

unlimited_stock

boolean

Whether or not the Plan offers unlimited stock

created_at

int32

The time at which the Plan was created. Measured in seconds since the Unix epoch.

access_pass

string

Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.

card_payments

boolean

Deprecated. Please use accepted_payment_methods instead.

Updated over 1 year ago

Create a plan

Update a Plan

Did this page help you?

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.whop.com/api/v2/plans/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 plan

Update a Plan

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 Plan