Membership

Membership

A membership is the access grant linking a user to a Plan / Product — it represents an active, paused, or cancelled subscription or one-time access. The SDK supports listing, reading, updating, and a full set of lifecycle actions.

SDK access

$client->memberships // Matchable\Whop\Resource\MembershipResource

Endpoints

list(array $query = []): array

HTTP	GET memberships
Does	Lists memberships.
Parameters	$query — optional filters / pagination.
Returns	array

get(string $id): array

HTTP	GET memberships/{id}
Does	Retrieves a single membership by ID.
Parameters	$id — the membership ID.
Returns	array

update(string $id, array $data): array

HTTP	PATCH memberships/{id}
Does	Updates a membership's attributes.
Parameters	$id — the membership ID; $data — fields to change.
Returns	array

addFreeDays(string $id, array $data): array

HTTP	POST memberships/{id}/add-free-days
Does	Extends the membership by adding free days.
Parameters	$id — the membership ID; $data — e.g. number of days to add.
Returns	array

cancel(string $id, array $data = []): array

HTTP	POST memberships/{id}/cancel
Does	Cancels the membership.
Parameters	$id — the membership ID; $data — optional cancellation options (e.g. immediate vs. end of period).
Returns	array

pause(string $id, array $data = []): array

HTTP	POST memberships/{id}/pause
Does	Pauses the membership.
Parameters	$id — the membership ID; $data — optional pause options.
Returns	array

resume(string $id, array $data = []): array

HTTP	POST memberships/{id}/resume
Does	Resumes a paused membership.
Parameters	$id — the membership ID; $data — optional resume options.
Returns	array

uncancel(string $id): array

HTTP	POST memberships/{id}/uncancel
Does	Reverses a pending cancellation, keeping the membership active.
Parameters	$id — the membership ID.
Returns	array

Example

$membership = $client->memberships->get('mem_...');

// Give the member a week on the house, then schedule cancellation.
$client->memberships->addFreeDays('mem_...', ['days' => 7]);
$client->memberships->cancel('mem_...');

// Changed their mind.
$client->memberships->uncancel('mem_...');

Reference

Official Whop documentation: https://docs.whop.com