Skip to main content
POST
Add free days membership
Required permissions:
  • member:manage
  • member:email:read
  • member:basic:read

Yetkilendirmeler

Authorization
string
header
gerekli

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

Yol Parametreleri

id
string
gerekli

The unique identifier of the membership.

Örnek:

"mem_xxxxxxxxxxxxxx"

Gövde

application/json

Parameters for AddFreeDaysToMembership

free_days
integer
gerekli

The number of free days to add (1-1095). Extends the billing period, expiration date, or Stripe trial depending on plan type.

Örnek:

42

Yanıt

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
gerekli

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
gerekli

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

Mevcut seçenekler:
too_expensive,
switching,
missing_features,
technical_issues,
bad_experience,
unused,
other,
testing
cancelation_status
enum<string> | null
gerekli

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

Mevcut seçenekler:
won_back,
left,
canceling
canceled_at
string<date-time> | null
gerekli

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

Örnek:

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

cancellation_reason
string | null
gerekli

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

Örnek:

"I found a better alternative."

checkout_configuration_id
string | null
gerekli

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.

Örnek:

"ch_xxxxxxxxxxxxxxx"

company
object
gerekli

The company this membership belongs to.

created_at
string<date-time>
gerekli

The datetime the membership was created.

Örnek:

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

currency
enum<string> | null
gerekli

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

Mevcut seçenekler:
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[]
gerekli

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

external_accounts
object[] | null
gerekli

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
gerekli

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
gerekli

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

Örnek:

"$25.00 / month"

id
string
gerekli

The unique identifier for the membership.

Örnek:

"mem_xxxxxxxxxxxxxx"

initial_price_paid
string
gerekli

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

Örnek:

"$25.00"

joined_at
string<date-time> | null
gerekli

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

Örnek:

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

license_key
string | null
gerekli

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

Örnek:

"A1B2C3-D4E5F6-G7H8I9"

manage_url
string | null
gerekli

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

Örnek:

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

member
object | null
gerekli

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
gerekli

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
gerekli

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

plan
object
gerekli

The plan the customer purchased to create this membership.

product
object
gerekli

The product this membership grants access to.

promo_code
object | null
gerekli

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

renewal_period_end
string<date-time> | null
gerekli

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

Örnek:

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

renewal_period_start
string<date-time> | null
gerekli

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

Örnek:

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

status
enum<string>
gerekli

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

Mevcut seçenekler:
trialing,
active,
past_due,
completed,
canceled,
expired,
unresolved,
drafted,
canceling
updated_at
string<date-time>
gerekli

The datetime the membership was last updated.

Örnek:

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

user
object | null
gerekli

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