Premium Groups

Premium groups allow a subscription owner to invite and manage members of a shared premium subscription.

Premium Group Member Object

Represents an owner, member, or pending invite in a premium group.

Premium Group Member Structure

Field	Type	Description
user	user object	The user represented by the membership record
member_type	integer	The type of member
accepted_at	?ISO8601 timestamp	When the member accepted the invite

Premium Group Member Type

Value	Name	Description
1	PRIMARY	The owner of the premium group
2	MEMBER	A member or invited user of the premium group

A MEMBER record with a null accepted_at value represents a pending invite.

Premium Group Membership Objecct

Represents the current user's premium group membership.

Premium Group Membership Structure

Field	Type	Description
subscription_id	snowflake	The ID of the premium group subscription
member_type	integer	The type of member
subscription_status	integer	The status of the subscription
current_period_end	ISO8601 timestamp	When the current subscription period ends

Example Premium Group Membership

{
  "subscription_id": "1422548914485198869",
  "member_type": 2,
  "subscription_status": 1,
  "current_period_end": "2026-09-12T14:22:31.450000+00:00"
}

Eligible Premium Group Users Object

Represents one page of users that may or may not be eligible for an invite.

Eligible Premium Group Users Structure

Field	Type	Description
users	array[user object]	The users eligible for an invite
ineligible_users?	array[user object]	The users that are not eligible for an invite
next_index	integer	The index to use to retrieve the next page

Premium Group Invite Object

Represents an invitation to join a premium group.

Premium Group Invite Structure

Field	Type	Description
id	snowflake	The ID of the premium group invite
user_id	snowflake	The ID of the invited user
subscription	snowflake	The ID of the premium group subscription
accepted_at	?ISO8601 timestamp	When the invite was accepted
removed_at	?ISO8601 timestamp	When the invite was revoked or otherwise removed

Endpoints

List Eligible Premium Group Users

GET/users/@me/billing/subscriptions/{subscription.id}/eligible-users

Returns an eligible premium group users object.

Query String Params

Field	Type	Description
index?	integer	The pagination index
limit?	integer	The maximum number of users to return (default 10)
search_query?	string	The text used to filter users
include_ineligible?	boolean	Whether to include users that are not eligible for an invite