List Memberships

get

https://api.whop.com/api/v2/memberships

Returns a collection of Memberships, based on the supplied filters. If a Membership is valid, the User has/should have access to the Experiences associated with the Product. If a Membership is invalid, the User will/should have their Product's Experiences unfulfilled. By default, results are returned 10 objects at a time.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

Defaults to 1

The page number to retrieve

per

int32

Defaults to 10

The number of resources to return per page. There is a limit of 50 results per page.

status

string

enum

The status of the Membership

Allowed:

plan_id

string

The ID of the Plan attached to this Membership, which will look like plan_*************

access_pass_id

string

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

product_id

string

The ID of the Product attached to this Membership, which will look like prod_************* or pass_*************

user_id

string

The ID of the User that owns this Membership, which will look like user_*************

discord_id

string

The ID of the Discord account attached to this Membership

wallet_address

string

The crypto wallet address used to pay for the Membership (if paid through the one-time ETH or renewal WETH Whop contracts)

valid

boolean

Whether or not the Membership has a valid status

hide_metadata

boolean

Defaults to false

Whether or not to hide the metadata returned on responses. Passing true will hide the metadata, default value is false.

direction

string

enum

Defaults to desc

The direction to order the results by. Either 'desc' or 'asc'. Default is 'desc'.

Allowed:

expand

array of strings

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

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

200List Memberships