Invite to a Membership

Sends an email inviting one recipient to join the account through a free plan. Identify the recipient by exactly one of user_id or email. The invitation is bound to that recipient; after signing in, accepting it immediately grants the membership without checkout. This Experimental endpoint is available only to accounts enabled for membership invitations.

POST /memberships/invite

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const response = await client.memberships.invite({
  plan_id: 'plan_xxxxxxxxxxxxxx',
  user_id: 'user_xxxxxxxxxxxxxx',
});

console.log(response.invitation_sent);

202

{
  "invitation_sent": true
}

Authorizations

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Idempotency-Key · string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255

Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date · string

Pins the request to a dated API version.

Example:

"2026-08-21"

Body

application/json

InviteMembershipByUser

InviteMembershipByEmail

plan_id · string · required

Free plan whose membership the recipient is invited to, prefixed plan_.

Example:

"plan_xxxxxxxxxxxxxx"

user_id · string · required

Recipient user ID, prefixed user_. Mutually exclusive with email.

Example:

"user_xxxxxxxxxxxxxx"

email · string<email>

Recipient email address. Mutually exclusive with user_id.

Example:

"[e-mail]"

Response

202

application/json

invitation accepted for delivery

invitation_sent · boolean · required

Example:

true