List Memberships - Whop Developers

API Documentation

Apps

Overview
Companies
Experiences
Members
Memberships
Products
Payments
Reviews
Notifications
Line Items
App Connections
Users
Feed Content Items
Inbound Webhooks
Inbound Webhook Filters
GET
Retrieve the current app
GET
Check Access

Company

Overview
Memberships
Products
Payments
Reviews
Users
GET
Retrieve the current company

Me

Chat

Webhooks

GET

app

memberships

curl --request GET \
  --url https://{defaultHost}/v5/app/memberships \
  --header 'Authorization: Bearer <token>'

{
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "product_id": "<string>",
      "user_id": "<string>",
      "plan_id": "<string>",
      "page_id": "<string>",
      "created_at": 123,
      "expires_at": 123,
      "renewal_period_start": 123,
      "renewal_period_end": 123,
      "quantity": 123,
      "status": "trialing",
      "valid": true,
      "cancel_at_period_end": true,
      "license_key": "<string>",
      "metadata": {},
      "checkout_id": "<string>",
      "affiliate_username": "<string>",
      "manage_url": "<string>",
      "company_buyer_id": 123,
      "marketplace": true,
      "custom_field_responses": [
        {
          "id": "<string>",
          "created_at": 123,
          "updated_at": 123,
          "question": "<string>",
          "answer": "<string>"
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

App API key for /v5/app and /v5/company endpoints

Query Parameters

company_id

string

An ID of a company to filter by, which will look like biz_*************

product_id

string

An ID of a product to filter by, which will look like prod_*************

user_id

string

An ID of a user to filter by, which will look like user_*************

experience_id

string

An ID of an experience to filter by, which will look like exp_*************

license_key

string

A license key to filter by.

statuses

enum<string>[]

An array of statuses to filter by.

Available options:

active,

trialing,

past_due,

completed,

canceled,

expired,

unresolved

valid

boolean

default:true

A boolean to filter by valid memberships

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.

Response

200 - application/json

memberships retrieved

pagination

object

required

data

object[]

required

data.id

string

required

The ID of the membership, which will look like mem_*************

data.product_id

string

required

The ID of the product, which will look like prod_*************

data.user_id

string

required

The ID of the user, which will look like user_*************

data.plan_id

string

required

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

data.page_id

string

required

The ID of the page, which will look like page_*************

data.created_at

number

required

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

data.expires_at

integer | null

required

The time of when the Membership is set to go expired

data.renewal_period_start

integer | null

required

The UTC timestamp of when the Membership will begin

data.renewal_period_end

integer | null

required

The UTC timestamp of when the Membership will end

data.quantity

number

required

The quantity purchased

data.valid

boolean

required

Whether or not the membership is valid

data.cancel_at_period_end

boolean

required

Whether or not this membership is scheduled to cancel at the end of the renewal period.

data.metadata

object

required

The metadata for the membership

data.affiliate_username

string | null

required

The username of the affiliate that referred the customer to this membership, if any.

data.manage_url

string

required

The URL for the customer to manage their membership on whop.com.

data.custom_field_responses

object[]

required

Array of related custom field responses.

data.status

enum<string> | null

The status of the membership

Available options:

trialing,

active,

past_due,

completed,

canceled,

expired,

unresolved

data.license_key

string | null

The license key for the membership

data.checkout_id

string | null

The ID of the checkout used to first purchase / generate the membership.

data.company_buyer_id

number | null

The ID of the company that purchased/owns the membership. (For example, they installed an app). Looks like biz_*************

data.marketplace

boolean

Whether or not the membership was purchased through the whop marketplace.

Was this page helpful?

Retrieve a Member Retrieve a Membership

curl --request GET \
  --url https://{defaultHost}/v5/app/memberships \
  --header 'Authorization: Bearer <token>'

{
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "product_id": "<string>",
      "user_id": "<string>",
      "plan_id": "<string>",
      "page_id": "<string>",
      "created_at": 123,
      "expires_at": 123,
      "renewal_period_start": 123,
      "renewal_period_end": 123,
      "quantity": 123,
      "status": "trialing",
      "valid": true,
      "cancel_at_period_end": true,
      "license_key": "<string>",
      "metadata": {},
      "checkout_id": "<string>",
      "affiliate_username": "<string>",
      "manage_url": "<string>",
      "company_buyer_id": 123,
      "marketplace": true,
      "custom_field_responses": [
        {
          "id": "<string>",
          "created_at": 123,
          "updated_at": 123,
          "question": "<string>",
          "answer": "<string>"
        }
      ]
    }
  ]
}