Plan

Plan

A plan defines the pricing and billing terms for a Product — for example a recurring subscription price or a one-time charge. Customers check out against a plan, which then produces a Membership. The SDK supports full CRUD on plans.

SDK access

$client->plans // Matchable\Whop\Resource\PlanResource

Endpoints

create(array $data): array

HTTP	POST plans
Does	Creates a new plan.
Parameters	$data — plan attributes (e.g. product ID, price, currency, billing period).
Returns	array

list(array $query = []): array

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

get(string $id): array

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

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

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

delete(string $id): array

HTTP	DELETE plans/{id}
Does	Deletes a plan.
Parameters	$id — the plan ID.
Returns	array

Example

$plan = $client->plans->create([
    'product_id' => 'prod_...',
    'amount' => 1999,
    'currency' => 'usd',
    'billing_period' => 'monthly',
]);

$client->plans->update($plan['id'], ['amount' => 2499]);

Reference

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