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 your own, retrieve one by ID or license key, invite a recipient to join through a free variant, and manage the lifecycle: cancel immediately or at period end, reverse a scheduled cancellation, pause and resume payment collection, extend or reactivate access, apply a promo code or affiliate, change renewal cadence, resync access, generate a transfer link, and update metadata.
Replaces the Legacy Memberships
resource. Existing Legacy integrations keep working; see API
versions for the stability contract.
Endpoints
Attributes
The account (seller) this membership belongs to.
The membership’s affiliate commission.
null without an affiliate, without affiliate:basic:read on the account, and always in webhooks.Properties
Properties
Whether the commission is paid on the membership’s first payment only or on all its payments.Available options:
first_payment, all_paymentsThe flat fee commission in the membership currency, or
null for a percentage.Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
The percentage commission in percentage points, so
20 means 20%, or null
for a flat fee.How the commission rate was set:
custom for a rate set for this affiliate, member for the member affiliate rate of the plan or product, global for the product’s global affiliate rate, or marketplace for a Whop marketplace referral.Available options: custom, member, marketplace, globalWhether the commission is a percentage or a flat fee.Available options:
flat_fee, percentageWhether this membership pays affiliate commissions.
false means the
affiliate is kept on the membership but is no longer paid.Number of days between recurring charges.
null for non-renewing memberships
or memberships with multiple renewal schedules.Whether the membership is set to cancel when the current billing period ends.
Only meaningful for recurring variants.
The category the member picked for why they canceled.
null when no category was picked.Available options: too_expensive, switching, missing_features, technical_issues, bad_experience, unused, other, testingWhen cancellation was requested, or when the membership was canceled if no
request time is recorded, as an ISO 8601 timestamp.
null when neither is
recorded.Free-text explanation provided when canceling.
null when no reason was
provided.How renewals are collected.
charge_automatically charges the saved payment method each period; send_invoice emails the buyer an invoice each period. null when not set.Available options: charge_automatically, send_invoiceWhen 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.When the current billing period started, as an ISO 8601 timestamp.
null when
no billing period is recorded.When access ends for a membership with a fixed expiration, as an ISO 8601
timestamp.
null when the membership has no expiration, such as a renewing
membership.The member’s accounts on outside platforms, such as Discord and Telegram. Empty when the member has none linked.
null in webhooks.Properties
Properties
The member’s user ID on the platform, such as a Discord user ID. Prefixed with the platform (
discord_\<external_id>), it is the external_account value List Memberships filters by.The variant’s current up-front price, in the variant’s currency. A list price, not necessarily what the buyer paid.
amount is "0.00" when the first charge is free.Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
The software license key for this membership. Only present when the product
includes a software licensing experience.
URL where the buyer can sign in to manage billing.
null without a member
record or unless the caller is the buyer or has member:manage on the
account.The caller’s member row on the account. Present only when the membership belongs to the caller;
null on seller-side reads.Properties
Properties
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, customerWhen the member last opened the account’s content, as an ISO 8601 timestamp.
null if they never have.The buyer’s member record on the account, prefixed
mber_. null when the
membership has no member record, such as an unclaimed membership.Custom key-value pairs stored on the membership, commonly used for software
licensing.
The membership’s latest lifecycle event, such as
renewing_on or canceled_on. Pair it with most_recent_action_at. null when none is recorded.Available options: canceled_on, finished_split_pay_at, canceling_on, ending_on, renewing_on, past_due, next_payment_attempt, paused_at, trial_ends_at, unresolved_at, trial_canceling_onWhen
most_recent_action happened or is scheduled to happen, as an ISO 8601
timestamp. A future time for upcoming events such as renewing_on. null
when no action is recorded.The buyer’s phone number recorded for this membership, or
null. The number
collected (or verified) at checkout when the seller’s phone collection is on;
falls back to the buyer’s account number when they have shared one with this
seller.The promo code discounting this membership, prefixed
promo_. null when
none is applied. Set at checkout or by Apply Promo Code to Membership.What the next renewal charges, after any promo code that still applies.
null for non-renewing memberships.Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
Paid installments counted so far on a split pay membership.
null when the
membership is not on split pay, or before its first installment is counted.Installment payments required before the membership stops billing.
null when
the membership is not on split pay.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, unresolvedWhen the membership was last changed, as an ISO 8601 timestamp. Reflects the
most recent change to the membership itself, so you can reconcile against
webhook retries, replays, and backfills.
The buyer, prefixed
user_. null when the buyer is another business or the
membership is unclaimed.Membership

