User Membership
List user memberships
Returns a paginated list of the memberships members hold, including the membership type and pricing plan each one is on. Filter by member, active/expired state, or expiry date range.
query Parameters
filter[user_id]filter[active]filter[expired]filter[expires_starting_at]filter[expires_ending_at]page[number]page[size]Headers
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
List user memberships › Responses
Paginated set of UserMembershipResource
current_pagefromlast_pageper_pagetototalAssign a membership to a member
Gives an existing member a membership of the given type at no charge.
When the type has more than one active plan, plan_id is required.
A payment the member already made outside Communal is recorded only
when payment_method and amount_paid are supplied. Unlike
membership_cards/send, this never creates a member or cancels other
memberships.
Nothing is emailed unless send_email is true. When it is, the member
gets up to two emails: a "Membership Assigned" email naming the
membership and plan, sent right away, and about a minute later their
membership card. When the organization doesn't use membership cards,
or the type has no card, the type's membership form PDF is sent
instead, if it has one. No receipt is attached, even when a payment
is recorded. data.emailed echoes the send_email value.
Headers
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
Assign a membership to a member › Request Body
user_idmembership_type_idplan_idpayment_methodamount_paidpurchase_datesend_emailEmail the member about the assignment. When true, they get a "Membership Assigned" email right away and, about a minute later, their membership card (or the type's membership form PDF when cards are off or the type has no card). Defaults to false, which sends nothing.
Assign a membership to a member › Responses
statusmessageGet a user membership
Returns a single held membership with its membership type and pricing plan.
path Parameters
user_membershipHeaders
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
Get a user membership › Responses
UserMembershipResource
idThe unique identifier of the user membership.
user_idThe id of the member who holds this membership.
statusCurrent membership state. retrying means the last renewal
payment failed and further attempts are scheduled.
will_auto_renewWhether the membership renews automatically at the end of the current period.
ends_atISO 8601 timestamp of when the current membership period ends.
renewed_atISO 8601 timestamp of the most recent renewal, or null if the membership has never renewed.
created_atISO 8601 timestamp of when the membership was created.
The membership type this membership belongs to. Included when the relation is loaded, which both endpoints always do.
planThe pricing plan the membership is billed on. Included when the
relation is loaded, which both endpoints always do. amount is
in the smallest currency unit (e.g. cents).