Members

Overview

Manage the members (seats) of a membership-type subscription. The subscription owner can list current members, invite new members by email, and remove members to free up seats. Each member is pending until the invitee claims their seat, then active.

API Endpoints

MethodEndpointDescription
GET/api/v1/sdk/subscriptions/{id}/members/listList
POST/api/v1/sdk/subscriptions/{id}/members/inviteInvite
DELETE/api/v1/sdk/subscriptions/{id}/members/{member_id}Remove

Important Behaviors

  • Protected — the subscription must be a membership owned by the authenticated customer, otherwise the request returns 400 Invalid subscription provided.
  • Inviting beyond the plan’s seat capacity, or re-inviting an existing member, fails validation.