> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # List memberships > Returns a paginated list of memberships, with optional filtering by product, plan, status, and user. Required permissions: - `member:basic:read` - `member:email:read` ## OpenAPI ````yaml /openapi/api-v1-stable.json get /memberships openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: '2026-08-21' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: Products name: Products - description: Payments name: Payments - description: Refunds name: Refunds - description: Disputes name: Disputes - description: Dispute alerts name: Dispute alerts - description: Resolution center cases name: Resolution center cases - description: Checkout configurations name: Checkout configurations - description: Setup intents name: Setup intents - description: Payment methods name: Payment methods - description: Invoices name: Invoices - description: Promo codes name: Promo codes - description: Card transactions name: Card transactions - description: Ledger accounts name: Ledger accounts - description: Withdrawals name: Withdrawals - description: Payout methods name: Payout methods - description: Verifications name: Verifications - description: Identity profiles name: Identity profiles - description: Payout accounts name: Payout accounts - description: Topups name: Topups - description: Companies name: Companies - description: Authorized users name: Authorized users - description: Fee markups name: Fee markups - description: Members name: Members - description: Memberships name: Memberships - description: Leads name: Leads - description: Entries name: Entries - description: Shipments name: Shipments - description: Reviews name: Reviews - description: Company token transactions name: Company token transactions - description: Affiliates name: Affiliates - description: Experiences name: Experiences - description: Forums name: Forums - description: Forum posts name: Forum posts - description: Chat channels name: Chat channels - description: Support channels name: Support channels - description: Messages name: Messages - description: Reactions name: Reactions - description: Dm members name: Dm members - description: Dm channels name: Dm channels - description: Notifications name: Notifications - description: Courses name: Courses - description: Course chapters name: Course chapters - description: Course lessons name: Course lessons - description: Course students name: Course students - description: Course lesson interactions name: Course lesson interactions - description: Apps name: Apps - description: Webhooks name: Webhooks - description: App builds name: App builds - description: Access tokens name: Access tokens - description: Account links name: Account links - description: Files name: Files - description: Ai chats name: Ai chats - description: Bounties name: Bounties - description: Stats name: Stats - description: Conversions name: Conversions - description: Ad reports name: Ad reports paths: /memberships: get: tags: - Memberships summary: List memberships description: >- Returns a paginated list of memberships, with optional filtering by product, plan, status, and user. Required permissions: - `member:basic:read` - `member:email:read` operationId: listMembership parameters: - explode: true in: query name: after required: false schema: description: >- Returns the elements in the list that come after the specified cursor. type: string style: form - explode: true in: query name: before required: false schema: description: >- Returns the elements in the list that come before the specified cursor. type: string style: form - explode: true in: query name: first required: false schema: description: Returns the first _n_ elements from the list. example: 42 type: integer style: form - explode: true in: query name: last required: false schema: description: Returns the last _n_ elements from the list. example: 42 type: integer style: form - explode: true in: query name: company_id required: false schema: description: >- The unique identifier of the company to list memberships for. Required when using an API key. example: biz_xxxxxxxxxxxxxx type: string style: form - explode: true in: query name: direction required: false schema: $ref: '#/components/schemas/Direction' description: The sort direction for results. Defaults to descending. style: form - explode: true in: query name: order required: false schema: $ref: '#/components/schemas/MembershipsSortableColumns' description: The field to sort results by. Null uses the default sort order. style: form - explode: true in: query name: product_ids required: false schema: description: Filter to only memberships belonging to these product identifiers. items: description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. type: string type: array style: form - explode: true in: query name: statuses required: false schema: description: Filter to only memberships matching these statuses. items: $ref: '#/components/schemas/MembershipStatus' type: array style: form - explode: true in: query name: cancel_options required: false schema: description: Filter to only memberships matching these cancellation reasons. items: $ref: '#/components/schemas/CancelOptions' type: array style: form - explode: true in: query name: cancelation_status required: false schema: $ref: '#/components/schemas/CancelationStatus' description: >- Filter memberships by whether the customer is canceling, left, or was won back. style: form - explode: true in: query name: has_cancelation_reason required: false schema: description: >- Filter memberships by whether they have a structured or free-text cancellation reason. type: boolean style: form - explode: true in: query name: include_text_only_cancelation_reasons required: false schema: description: >- When filtering by the other cancellation option, also include memberships that only have a free-text cancellation reason. type: boolean style: form - explode: true in: query name: plan_ids required: false schema: description: Filter to only memberships belonging to these plan identifiers. items: description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. type: string type: array style: form - explode: true in: query name: user_ids required: false schema: description: Filter to only memberships belonging to these user identifiers. items: description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. type: string type: array style: form - explode: true in: query name: promo_code_ids required: false schema: description: Filter to only memberships that used these promo code identifiers. items: description: >- Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) input value will be accepted as an ID. type: string type: array style: form - explode: true in: query name: created_before required: false schema: description: Only return memberships created before this timestamp. example: '2023-12-01T05:00:00.401Z' format: date-time type: string style: form - explode: true in: query name: created_after required: false schema: description: Only return memberships created after this timestamp. example: '2023-12-01T05:00:00.401Z' format: date-time type: string style: form responses: '200': content: application/json: schema: description: The connection type for PublicMembership. properties: data: description: A list of nodes. items: $ref: '#/components/schemas/MembershipListItem' type: array page_info: $ref: '#/components/schemas/PageInfo' description: Information to aid in pagination. total_count: description: The total number of items in this connection. example: 42 type: integer required: - data - page_info - total_count type: object description: A successful response '400': content: application/json: example: error: code: parameter_missing message: 'Missing required parameter: amount.' param: amount type: invalid_request_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Bad request '401': content: application/json: example: error: message: Invalid or missing API key type: unauthorized schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Unauthorized '403': content: application/json: example: error: message: You do not have permission to access this resource type: forbidden schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Forbidden '404': content: application/json: example: error: message: Resource not found type: not_found schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Not found '422': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Verification required '429': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Too many requests '500': content: application/json: example: error: message: An unexpected error occurred type: internal_server_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Internal server error security: - bearerAuth: - member:basic:read - member:email:read x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const membership of client.memberships.list()) { console.log(membership.id); } components: schemas: Direction: description: The direction of the sort. enum: - asc - desc type: string MembershipsSortableColumns: description: Which columns can be used to sort. enum: - id - created_at - status - canceled_at - date_joined - total_spend type: string MembershipStatus: description: The status of a membership enum: - trialing - active - past_due - completed - canceled - expired - unresolved - drafted - canceling type: string CancelOptions: description: >- The different reasons a user can choose for why they are canceling their membership. enum: - too_expensive - switching - missing_features - technical_issues - bad_experience - other - testing type: string CancelationStatus: description: >- The state of a membership after a customer provides a cancelation reason. enum: - won_back - left - canceling type: string MembershipListItem: description: >- A membership represents an active relationship between a user and a product. It tracks the user's access, billing status, and renewal schedule. properties: cancel_at_period_end: description: >- Whether this membership is set to cancel at the end of the current billing cycle. Only applies to memberships with a recurring plan. type: boolean cancel_option: description: >- The category selected for why the member canceled (e.g. too_expensive, switching, missing_features). oneOf: - $ref: '#/components/schemas/CancelOptions' - type: 'null' cancelation_status: description: >- Whether the customer is canceling, left, or was won back. Null if the membership has no cancellation reason or its cancellation state is indeterminate. oneOf: - $ref: '#/components/schemas/CancelationStatus' - type: 'null' canceled_at: description: >- The time the customer initiated cancellation of this membership. As a Unix timestamp. Null if the membership has not been canceled. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' cancellation_reason: description: >- Free-text explanation provided by the customer when canceling. Null if the customer did not provide a reason. example: I found a better alternative. type: - string - 'null' checkout_configuration_id: description: >- The ID of the checkout session/configuration that produced this membership, if any. Use this to map memberships back to the checkout configuration that created them. example: ch_xxxxxxxxxxxxxxx type: - string - 'null' company: description: The company this membership belongs to. properties: id: description: The unique identifier for the company. example: biz_xxxxxxxxxxxxxx type: string title: description: The display name of the company shown to customers. example: Pickaxe type: string required: - id - title type: object created_at: description: The datetime the membership was created. example: '2023-12-01T05:00:00.401Z' format: date-time type: string currency: description: >- The three-letter ISO currency code for this membership's billing. Null if the membership is free. oneOf: - $ref: '#/components/schemas/Currencies' - type: 'null' formatted_renewal_price: description: >- The recurring renewal price for this membership, formatted with currency symbol and billing interval. Null if the membership is not recurring. example: $25.00 / month type: - string - 'null' id: description: The unique identifier for the membership. example: mem_xxxxxxxxxxxxxx type: string initial_price_paid: description: >- The amount the customer paid when first purchasing this membership, formatted with currency symbol. example: $25.00 type: string joined_at: description: >- The time the user first joined the company associated with this membership. As a Unix timestamp. Null if the member record does not exist. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' license_key: description: >- The software license key associated with this membership. Only present if the product includes a Whop Software Licensing experience. Null otherwise. example: A1B2C3-D4E5F6-G7H8I9 type: - string - 'null' manage_url: description: >- The URL where the customer can view and manage this membership, including cancellation and plan changes. Null if no member record exists. example: https://whop.com/billing/manage/mem_abc123 type: - string - 'null' member: description: >- The member record linking the user to the company for this membership. Null if the member record has not been created yet. properties: id: description: The unique identifier for the member. example: mber_xxxxxxxxxxxxx type: string required: - id type: - object - 'null' metadata: additionalProperties: true description: >- Custom key-value pairs for the membership (commonly used for software licensing, e.g., HWID). Max 50 keys, 100 chars per key, 500 chars per string value. type: - object - 'null' payment_collection_paused: description: >- Whether recurring payment collection for this membership is temporarily paused by the company. type: boolean plan: description: The plan the customer purchased to create this membership. properties: id: description: The unique identifier for the plan. example: plan_xxxxxxxxxxxxx type: string metadata: additionalProperties: true description: >- Custom key-value pairs stored on the plan. Included in webhook payloads for payment and membership events. Max 50 keys, 100 chars per key, 500 chars per string value. The reserved keys `custom_cta` and `custom_cta_url`, when set, override the product's checkout call to action for this plan. type: - object - 'null' required: - id - metadata type: object product: description: The product this membership grants access to. properties: id: description: The unique identifier for the product. example: prod_xxxxxxxxxxxxx type: string metadata: additionalProperties: true description: >- Custom key-value pairs stored on the product and included in payment and membership webhook payloads. Max 50 keys, 100 characters per key, 500 characters per string value. type: - object - 'null' title: description: >- The display name of the product shown to customers on the product page and in search results. example: Pickaxe Analytics type: string required: - id - title - metadata type: object promo_code: description: >- The promotional code currently applied to this membership's billing. Null if no promo code is active. properties: id: description: The unique identifier for the promo code. example: promo_xxxxxxxxxxxx type: string required: - id type: - object - 'null' renewal_period_end: description: >- The end of the current billing period for this recurring membership. As a Unix timestamp. Null if the membership is not recurring. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' renewal_period_start: description: >- The start of the current billing period for this recurring membership. As a Unix timestamp. Null if the membership is not recurring. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' status: $ref: '#/components/schemas/MembershipStatus' description: >- The current lifecycle status of the membership (e.g., active, trialing, past_due, canceled, expired, completed). updated_at: description: The datetime the membership was last updated. example: '2023-12-01T05:00:00.401Z' format: date-time type: string user: description: >- The user who owns this membership. Null if the user account has been deleted. properties: email: description: >- The user's email address. Requires the member:email:read permission to access. Null if not authorized. example: john.doe@example.com type: - string - 'null' id: description: The unique identifier for the user. example: user_xxxxxxxxxxxxx type: string name: description: The user's display name shown on their public profile. example: John Doe type: - string - 'null' profile_pic: description: >- The URL of the user's profile picture. Use profilePicture for the full attachment object. type: string username: description: The user's unique username shown on their public profile. example: johndoe42 type: string required: - id - username - name - email - profile_pic type: - object - 'null' required: - id - status - created_at - joined_at - updated_at - manage_url - member - user - renewal_period_start - renewal_period_end - cancel_at_period_end - cancel_option - cancelation_status - cancellation_reason - canceled_at - currency - formatted_renewal_price - initial_price_paid - company - plan - promo_code - product - license_key - metadata - payment_collection_paused - checkout_configuration_id type: object PageInfo: description: Information about pagination in a connection. properties: end_cursor: description: When paginating forwards, the cursor to continue. type: - string - 'null' has_next_page: description: When paginating forwards, are there more items? type: boolean has_previous_page: description: When paginating backwards, are there more items? type: boolean start_cursor: description: When paginating backwards, the cursor to continue. type: - string - 'null' required: - end_cursor - start_cursor - has_next_page - has_previous_page type: object Currencies: description: The available currencies on the platform enum: - usd - sgd - inr - aud - brl - cad - dkk - eur - nok - gbp - sek - chf - hkd - huf - jpy - mxn - myr - pln - czk - nzd - aed - eth - ape - cop - ron - thb - bgn - idr - dop - php - try - krw - twd - vnd - pkr - clp - uyu - ars - zar - dzd - tnd - mad - kes - kwd - jod - all - xcd - amd - bsd - bhd - bob - bam - khr - crc - xof - egp - etb - gmd - ghs - gtq - gyd - ils - jmd - mop - mga - mur - mdl - mnt - nad - ngn - mkd - omr - pyg - pen - qar - rwf - sar - rsd - lkr - tzs - ttd - uzs - rub - btc - cny - usdt - kzt - awg - whop_usd - xau type: string securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. scheme: bearer type: http ````