Cancel a Membership
Cancels a specific Membership, using its unique ID. It will set the Membership to cancel at period end.
Headers
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
The ID of the Membership, which will look like mem_*************
Query Parameters
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]
product, user, plan, promo_code Response
Membership model
The ID of the Membership, which will look like mem_*************
The Product attached to this Membership. By default this will just be the ID of the Product, but you can expand it to get more information about the Product by passing [product] in the expand parameter.
The User that owns this Membership. By default this will just be the ID of the User, but you can expand it to get more information about the User by passing [user] in the expand parameter.
The Plan attached to this Membership. By default this will just be the ID of the Plan, but you can expand it to get more information about the Plan by passing [plan] in the expand parameter.
The Promo Code used to purchase this Membership. By default this will just be the ID of the Promo Code, but you can expand it to get more information about the Promo Code by passing [promo_code] in the expand parameter.
The email of the User attached to this Membership
The Stripe Subscription ID attached to this Membership if it was checked out using Stripe
The Stripe Customer ID attached to this Membership if it was checked out using Stripe
The status of the Membership
trialing, active, past_due, completed, canceled, expired, unresolved Whether or not the Membership has a valid status
Whether or not this membership is scheduled to cancel at the end of the renewal period.
The payment processor used to pay for the Membership.
free, stripe, coinbase, crypto, paypal, apple The license key of the Membership
The metadata of the Membership
The amount of items included in the Membership
The crypto wallet address used to pay for the Membership (if paid through the one-time ETH or renewal WETH Whop contracts)
Questions and answers collected from the User at checkout
Questions and answers collected from the User at checkout
The time of when the Membership is set to go expired
The UTC timestamp of when the Membership will begin
The UTC timestamp of when the Membership will end
The time at which the Membership was created. Measured in seconds since the Unix epoch.
The URL to manage the Membership (top-up, cancel, etc.)
Gives the url of the page with the user's affiliate code appended. Does not guarantee the user can affiliate anything on the page.
The ID of the checkout session (like ch_***************) used to purchase this membership, if any.
The username of the affiliate who referred the user to this membership, if any.
Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.
The Whop ID of their connected Telegram account, if any.
The phone number of the User attached to this Membership, if its allowed to be shared.
Was this page helpful?