Skip to main content
A Membership is a customer’s purchase of a plan: the subscription or one-time grant that gives them access to a product. It tracks billing state (active, trialing, past_due, and so on), the current period, pending cancellations, custom metadata, and the software license key when the product includes licensing. Use the Memberships API to list an account’s memberships or the caller’s own, retrieve one by ID or license key, and manage the lifecycle: cancel immediately or at period end, reverse a scheduled period-end cancellation, pause and resume payment collection, extend with free days, and update metadata.

​
Endpoints

​
Attributes

​
string
required
Membership ID, prefixed mem_.
​
object
required
The account (seller) this membership belongs to.

Properties

​
string
required
Account ID, prefixed biz_.
​
string | null
required
Account logo image URL.
​
string
required
Account public route identifier — the whop.com/\{route} storefront path.
​
string
required
Account display name.
​
boolean
required
Whether the membership is set to cancel when the current billing period ends. Only meaningful for recurring plans.
​
string
required
When the membership was created, as an ISO 8601 timestamp.
​
string | null
required
When the current billing period renews, or when a non-renewing membership expires, as an ISO 8601 timestamp. null for one-time purchases with no expiration.
​
string | null
required
The software license key for this membership. Only present when the product includes a software licensing experience.
​
object | null
required
The caller’s member row on the account. Present only when the membership belongs to the caller; null on seller-side reads.

Properties

​
string
required
What the member can reach on the account: customer for paying members, admin for team members, no_access once every grant has lapsed.Available options: no_access, admin, customer
​
string | null
required
When the member last opened the account’s content, as an ISO 8601 timestamp. null if they never have.
​
number | null
required
The member’s sort position in the buyer’s own account list. null until they arrange it.
​
object
required
Custom key-value pairs stored on the membership, commonly used for software licensing.
​
string
required
The plan the buyer purchased, prefixed plan_.
​
string
required
The product this membership grants access to, prefixed prod_.
​
string
required
Billing state of the membership. active/trialing memberships grant access; past_due is the grace period after a failed payment; completed one-time purchases keep access; canceled/expired do not.Available options: trialing, active, past_due, completed, canceled, expired, unresolved
​
string | null
required
The buyer, prefixed user_. null when the buyer is another business or the membership is unclaimed.
Membership