Invite to a Membership
Sends an email inviting one recipient to join the account through a free variant. 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.
Authorizations
An Account API key, an App API key, an account access token, or an account-scoped user token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-10-06"
Body
- InviteMembershipByUser
- InviteMembershipByEmail
Free variant whose membership the recipient is invited to, prefixed plan_.
"plan_xxxxxxxxxxxxxx"
Recipient user ID, prefixed user_. Mutually exclusive with email.
"user_xxxxxxxxxxxxxx"
Recipient email address. Mutually exclusive with user_id.
"marcus@shinetime.example"
Response
invitation accepted for delivery
true

