GET
/
v2
/
memberships
/
{id}
curl --request GET \
  --url https://api.whop.com/api/v2/memberships/{id}
{
  "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 ***************************

Path Parameters

​
id
string
required

The ID of the Membership, which will look like mem_*************, or the license key of the membership.

Query Parameters

​
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]

Response

200 - application/json

Retrieve a Membership

Membership model