GET
/
v2
/
memberships
Header
Query
curl --request GET \
  --url https://api.whop.com/v2/memberships
{
  "data": [
    {
      "access_pass": "string",
      "affiliate_page_url": "string",
      "cancel_at_period_end": "boolean",
      "checkout_session": "string",
      "created_at": "integer",
      "custom_fields_responses": "object",
      "custom_fields_responses_v2": "object",
      "deliveries": "object",
      "discord": {
        "id": "string",
        "image_url": "string",
        "username": "string"
      },
      "email": "string",
      "expires_at": "integer",
      "id": "string",
      "license_key": "string",
      "manage_url": "string",
      "metadata": "object",
      "nft_tokens": {
        "balance": "integer",
        "current_holder": "string",
        "metadata": "object",
        "smart_contract": {
          "contract_address": "string",
          "contract_name": "string"
        },
        "token_id": "string"
      },
      "payment_processor": "free",
      "plan": "string",
      "product": "string",
      "promo_code": "string",
      "quantity": "integer",
      "renewal_period_end": "integer",
      "renewal_period_start": "integer",
      "status": "trialing",
      "stripe_customer_id": "string",
      "stripe_subscription_id": "string",
      "telegram_account_id": "string",
      "user": "string",
      "valid": "boolean",
      "wallet_address": "string"
    }
  ],
  "pagination": {
    "current_page": "integer",
    "total_count": "integer",
    "total_page": "integer"
  }
}

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
Default: "1"
integer

The page number to retrieve

per
Default: "10"
integer

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
Default: false
boolean

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

direction
Default: "desc"
enum<string>

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
data
object[]
pagination
object

Pagination model

Retrieve User MembershipsValidate a License Key