Skip to main content
POST
Cancel membership
This page documents the Legacy API. For new integrations, use Cancel Membership in the Current API.
Required permissions:
  • membership:cancel
  • member:email:read
  • member:basic:read

Autorisations

Authorization
string
header
requis

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

membership:cancel
member:email:read
member:basic:read

Paramètres de chemin

id
string
requis

The unique identifier of the membership to cancel.

Exemple:

"mem_xxxxxxxxxxxxxx"

Corps

application/json

Parameters for CancelMembership

cancellation_mode
enum<string> | null

Whether to cancel immediately or at the end of the current billing period. Defaults to at_period_end.

Options disponibles:
at_period_end,
immediate

Réponse

A successful response

A membership represents an active relationship between a user and a product. It tracks the user's access, billing status, and renewal schedule.

cancel_at_period_end
boolean
requis

Whether this membership is set to cancel at the end of the current billing cycle. Only applies to memberships with a recurring plan.

cancel_option
enum<string> | null
requis

The category selected for why the member canceled (e.g. too_expensive, switching, missing_features).

Options disponibles:
too_expensive,
switching,
missing_features,
technical_issues,
bad_experience,
unused,
other,
testing
cancelation_status
enum<string> | null
requis

Whether the customer is canceling, left, or was won back. Null if the membership has no cancellation reason or its cancellation state is indeterminate.

Options disponibles:
won_back,
left,
canceling
canceled_at
string<date-time> | null
requis

The time the customer initiated cancellation of this membership. As a Unix timestamp. Null if the membership has not been canceled.

Exemple:

"2023-12-01T05:00:00.401Z"

cancellation_reason
string | null
requis

Free-text explanation provided by the customer when canceling. Null if the customer did not provide a reason.

Exemple:

"I found a better alternative."

checkout_configuration_id
string | null
requis

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.

Exemple:

"ch_xxxxxxxxxxxxxxx"

company
object
requis

The company this membership belongs to.

created_at
string<date-time>
requis

The datetime the membership was created.

Exemple:

"2023-12-01T05:00:00.401Z"

currency
enum<string> | null
requis

The three-letter ISO currency code for this membership's billing. Null if the membership is free.

Options disponibles:
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,
hnl
custom_field_responses
object[]
requis

The customer's responses to custom checkout questions configured on the product at the time of purchase.

external_accounts
object[] | null
requis

The member's accounts on outside platforms, such as Discord and Telegram. Empty when the member has none linked. Null in webhooks.

feedback_option
object | null
requis

The account's own cancel reason the member picked, as they saw it. null when the member picked a default category or gave no reason.

formatted_renewal_price
string | null
requis

The recurring renewal price for this membership, formatted with currency symbol and billing interval. Null if the membership is not recurring.

Exemple:

"$25.00 / month"

id
string
requis

The unique identifier for the membership.

Exemple:

"mem_xxxxxxxxxxxxxx"

initial_price_paid
string
requis

The amount the customer paid when first purchasing this membership, formatted with currency symbol.

Exemple:

"$25.00"

joined_at
string<date-time> | null
requis

The time the user first joined the company associated with this membership. As a Unix timestamp. Null if the member record does not exist.

Exemple:

"2023-12-01T05:00:00.401Z"

license_key
string | null
requis

The software license key associated with this membership. Only present if the product includes a Whop Software Licensing experience. Null otherwise.

Exemple:

"A1B2C3-D4E5F6-G7H8I9"

manage_url
string | null
requis

The URL where the customer can view and manage this membership, including cancellation and plan changes. Null if no member record exists.

Exemple:

"https://whop.com/billing/manage/mem_abc123"

member
object | null
requis

The member record linking the user to the company for this membership. Null if the member record has not been created yet.

metadata
object | null
requis

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.

payment_collection_paused
boolean
requis

Whether recurring payment collection for this membership is temporarily paused by the company.

plan
object
requis

The plan the customer purchased to create this membership.

product
object
requis

The product this membership grants access to.

promo_code
object | null
requis

The promotional code currently applied to this membership's billing. Null if no promo code is active.

renewal_period_end
string<date-time> | null
requis

The end of the current billing period for this recurring membership. As a Unix timestamp. Null if the membership is not recurring.

Exemple:

"2023-12-01T05:00:00.401Z"

renewal_period_start
string<date-time> | null
requis

The start of the current billing period for this recurring membership. As a Unix timestamp. Null if the membership is not recurring.

Exemple:

"2023-12-01T05:00:00.401Z"

status
enum<string>
requis

The current lifecycle status of the membership (e.g., active, trialing, past_due, canceled, expired, completed).

Options disponibles:
trialing,
active,
past_due,
completed,
canceled,
expired,
unresolved,
drafted,
canceling
updated_at
string<date-time>
requis

The datetime the membership was last updated.

Exemple:

"2023-12-01T05:00:00.401Z"

user
object | null
requis

The user who owns this membership. Null if the user account has been deleted.