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

인증

Authorization
string
header
필수

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

member:manage
member:email:read
member:basic:read

경로 매개변수

id
string
필수

The unique identifier of the membership to pause.

예시:

"mem_xxxxxxxxxxxxxx"

본문

application/json

Parameters for PauseMembership

resumes_at
string<date-time> | null

When the membership should automatically resume payment collection. If not provided, the membership stays paused until manually resumed.

예시:

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

void_payments
boolean | null

Whether to void any outstanding past-due payments on this membership, preventing future collection attempts.

응답

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
필수

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
필수

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

사용 가능한 옵션:
too_expensive,
switching,
missing_features,
technical_issues,
bad_experience,
unused,
other,
testing
cancelation_status
enum<string> | null
필수

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

사용 가능한 옵션:
won_back,
left,
canceling
canceled_at
string<date-time> | null
필수

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

예시:

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

cancellation_reason
string | null
필수

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

예시:

"I found a better alternative."

checkout_configuration_id
string | null
필수

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.

예시:

"ch_xxxxxxxxxxxxxxx"

company
object
필수

The company this membership belongs to.

created_at
string<date-time>
필수

The datetime the membership was created.

예시:

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

currency
enum<string> | null
필수

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

사용 가능한 옵션:
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[]
필수

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

external_accounts
object[] | null
필수

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
필수

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
필수

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

예시:

"$25.00 / month"

id
string
필수

The unique identifier for the membership.

예시:

"mem_xxxxxxxxxxxxxx"

initial_price_paid
string
필수

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

예시:

"$25.00"

joined_at
string<date-time> | null
필수

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

예시:

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

license_key
string | null
필수

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

예시:

"A1B2C3-D4E5F6-G7H8I9"

manage_url
string | null
필수

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

예시:

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

member
object | null
필수

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
필수

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
필수

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

plan
object
필수

The plan the customer purchased to create this membership.

product
object
필수

The product this membership grants access to.

promo_code
object | null
필수

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

renewal_period_end
string<date-time> | null
필수

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

예시:

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

renewal_period_start
string<date-time> | null
필수

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

예시:

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

status
enum<string>
필수

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

사용 가능한 옵션:
trialing,
active,
past_due,
completed,
canceled,
expired,
unresolved,
drafted,
canceling
updated_at
string<date-time>
필수

The datetime the membership was last updated.

예시:

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

user
object | null
필수

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