Membership activated

Headers

webhook-signature

string

required

The signature of the webhook request with the webhook version prepended

Example:

"v1,BASE64ENCODEDSIGNATURE"

webhook-timestamp

string

required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:

"1727606400"

Body

application/json

string

required

A unique ID for every single webhook request

Example:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

api_version

string

required

The API version for this webhook

Allowed value: "v1"

Example:

"v1"

timestamp

string<date-time>

required

The timestamp in ISO 8601 format that the webhook was sent at on the server

Example:

"2025-01-01T00:00:00.000Z"

type

string

required

The webhook event type

Allowed value: "membership.activated"

Example:

"membership.activated"

data

object

required

A membership represents a purchase between a User and a Company for a specific Product.

Show child attributes

data.id

string

required

The ID of the membership

Example:

"mem_xxxxxxxxxxxxxx"

data.status

enum<string>

required

The status of the membership.

Available options:

trialing,

active,

past_due,

completed,

canceled,

expired,

unresolved,

drafted

data.created_at

string<date-time>

required

The timestamp, in seconds, that this Membership was created at.

Example:

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

data.updated_at

string<date-time>

required

A timestamp of when the membership was last updated

Example:

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

data.manage_url

string | null

required

The URL for the customer to manage their membership.

data.member

object

required

The Member that this Membership belongs to.

Show child attributes

data.member.id

string

required

The ID of the member

Example:

"mber_xxxxxxxxxxxxx"

data.user

object

required

The user this membership belongs to

Show child attributes

data.user.id

string

required

The internal ID of the user.

Example:

"user_xxxxxxxxxxxxx"

data.user.username

string

required

The username of the user from their Whop account.

Example:

"johndoe42"

data.user.name

string | null

required

The name of the user from their Whop account.

Example:

"John Doe"

data.renewal_period_start

string<date-time> | null

required

The timestamp in seconds at which the current billing cycle for this subscription start. Only applies for memberships that have a renewal plan.

Example:

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

data.renewal_period_end

string<date-time> | null

required

The timestamp in seconds at which the current billing cycle for this subscription ends. Only applies for memberships that have a renewal plan.

Example:

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

data.cancel_at_period_end

boolean

required

Whether this Membership is set to cancel at the end of the current billing cycle. Only applies for memberships that have a renewal plan.

data.cancellation_reason

string | null

required

The reason that the member canceled the membership (filled out by the member).

data.canceled_at

string<date-time> | null

required

The epoch timestamp of when the customer initiated a cancellation.

Example:

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

data.currency

enum<string> | null

required

The currency the membership is in.

Available options:

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

data.company

object

required

The Company this Membership belongs to.

Show child attributes

data.company.id

string

required

The ID (tag) of the company.

Example:

"biz_xxxxxxxxxxxxxx"

data.company.title

string

required

The title of the company.

data.plan

object

required

The Plan this Membership is for.

Show child attributes

data.plan.id

string

required

The internal ID of the plan.

Example:

"plan_xxxxxxxxxxxxx"

The Promo Code that is currently applied to this Membership.

Show child attributes

The ID of the promo.

Example:

"promo_xxxxxxxxxxxx"

data.product

object

required

The Product this Membership grants access to.

Show child attributes

data.product.id

string

required

The internal ID of the public product.

Example:

"prod_xxxxxxxxxxxxx"

data.product.title

string

required

The title of the product. Use for Whop 4.0.

data.license_key

string | null

required

The license key for this Membership. This is only present if the membership grants access to an instance of the Whop Software app.

data.metadata

object

required

A JSON object used to store software licensing information. Ex. HWID

data.payment_collection_paused

boolean

required

Whether the membership's payments are currently paused.

Response

200

Return a 200 status to indicate that the data was received successfully

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Membership activated

Headers

Body

Response