Sign in
Memberships

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

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

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

Request body

OR

Example request

{
  "plan_id": "plan_xxxxxxxxxxxxxx",
  "user_id": "user_xxxxxxxxxxxxxx",
  "email": "marcus@shinetime.example"
}

Response

invitation accepted for delivery

invitation_sentboolean required

Example response

{
  "invitation_sent": true
}

Changes

Changed in 2 of the 41 revisions of this API.2