GET
/
v2
/
memberships
curl --request GET \
  --url https://api.whop.com/api/v2/memberships
{
  "pagination": {
    "current_page": 123,
    "total_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "product": "<string>",
      "user": "<string>",
      "plan": "<string>",
      "promo_code": "<string>",
      "email": "<string>",
      "stripe_subscription_id": "<string>",
      "stripe_customer_id": "<string>",
      "status": "trialing",
      "valid": true,
      "cancel_at_period_end": true,
      "payment_processor": "free",
      "license_key": "<string>",
      "metadata": {},
      "quantity": 123,
      "wallet_address": "<string>",
      "custom_fields_responses": {},
      "custom_fields_responses_v2": {},
      "discord": {
        "id": "<string>",
        "username": "<string>",
        "image_url": "<string>"
      },
      "nft_tokens": "<string>",
      "expires_at": 123,
      "renewal_period_start": 123,
      "renewal_period_end": 123,
      "created_at": 123,
      "manage_url": "<string>",
      "affiliate_page_url": "<string>",
      "checkout_session": "<string>",
      "affiliate_username": "<string>",
      "access_pass": "<string>",
      "telegram_account_id": "<string>",
      "phone_number": "<string>"
    }
  ]
}

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 ***************************

Query Parameters

​
page
integer
default:1

The page number to retrieve

​
per
integer
default:10

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

​
status
enum<string>

The status of the Membership

Available options:
active,
completed,
trialing,
past_due,
unresolved,
canceled,
expired
​
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
default:false

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

​
direction
enum<string>
default:desc

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

Available options:
asc,
desc
​
expand
enum<string>[]

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]

Available options:
product,
user,
plan,
promo_code

Response

200 - application/json
List Memberships
​
pagination
object

Pagination model

​
data
object[]

Membership model

Was this page helpful?

Rate LimitsValidate a License Key