Cancel a Membership

post https://api.whop.com/api/v2/memberships/{id}/cancel

Cancels a specific Membership, using its unique ID. It will set the Membership to cancel at period end.

Response

Response body

object

string

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

product

string

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.

user

string

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.

plan

string

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.

promo_code

string

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.

string

The email of the User attached to this Membership

stripe_subscription_id

string

The Stripe Subscription ID attached to this Membership if it was checked out using Stripe

stripe_customer_id

string

The Stripe Customer ID attached to this Membership if it was checked out using Stripe

status

string

The status of the Membership

trialing active past_due completed canceled expired unresolved

valid

boolean

Whether or not the Membership has a valid status

cancel_at_period_end

boolean

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

payment_processor

string

The payment processor used to pay for the Membership.

free stripe coinbase crypto paypal

license_key

string

The license key of the Membership

metadata

object

The metadata of the Membership

Has additional fields

quantity

int32

The amount of items included in the Membership

wallet_address

string

The crypto wallet address used to pay for the Membership (if paid through the one-time ETH or renewal WETH Whop contracts)

custom_fields_responses

object

Questions and answers collected from the User at checkout

Has additional fields

custom_fields_responses_v2

object

Questions and answers collected from the User at checkout

Has additional fields

discord

object

string

The Discord account's user ID (~18 digits)

username

string

The Discord account's username, including the discriminator (Ex. John#1234)

image_url

string

The image URL from Discord

nft_tokens

object

token_id

string

The ID of the NFT

current_holder

string

The current holder of the NFT

smart_contract

object

balance

int32

The balance of the NFT

metadata

object

The metadata of the NFT

Has additional fields

expires_at

int32

The time of when the Membership is set to go expired

renewal_period_start

int32

The UTC timestamp of when the Membership will begin

renewal_period_end

int32

The UTC timestamp of when the Membership will end

created_at

int32

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

manage_url

string

The URL to manage the Membership (top-up, cancel, etc.)

affiliate_page_url

string

Gives the url of the page with the user's affiliate code appended. Does not guarantee the user can affiliate anything on the page.

checkout_session

string

The ID of the checkout session (like ch_***************) used to purchase this membership, if any.

access_pass

string

Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.

deliveries

object

A hash of deliveries for this membership, as a series of key value pairs of the experience id to the delivery id. Ex. { 'exp*': 'dlv*' }

Has additional fields

telegram_account_id

string

The Whop ID of their connected Telegram account, if any.

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.whop.com/api/v2/memberships/id/cancel \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Cancel a Membership