User Membership

Server

List user memberships

GET

http://api.community-management.test/api

/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.

List user memberships › query Parameters

filter[user_id]

integer

filter[active]

boolean

filter[expired]

boolean

filter[expires_starting_at]

string · date-time

filter[expires_ending_at]

string · date-time

page[number]

integer · min: 1

page[size]

integer · min: 1 · max: 500

List user memberships › Headers

X-Api-Version

string

Optional 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

UserMembershipResource[] · required

current_page

integer · min: 1 · required

from

integer | null · min: 1 · required

last_page

integer · min: 1 · required

per_page

integer · min: 1 · required

to

integer | null · min: 1 · required

total

integer · min: 0 · required

GET/user_memberships

curl http://api.community-management.test/api/user_memberships \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1234,
      "user_id": 42,
      "status": "active",
      "will_auto_renew": true,
      "ends_at": "2026-12-31T23:59:59.000000Z",
      "renewed_at": "2026-01-01T00:00:00.000000Z",
      "created_at": "2025-06-15T14:30:00.000000Z",
      "membership_type": {
        "id": 0,
        "title": "title"
      },
      "plan": {
        "id": 0,
        "nickname": "nickname",
        "amount": 0,
        "interval": "interval"
      }
    }
  ],
  "current_page": 1,
  "from": 1,
  "last_page": 1,
  "per_page": 1,
  "to": 1,
  "total": 0
}

json

application/json

Get a user membership

GET

http://api.community-management.test/api

/user_memberships/{user_membership}

Returns a single held membership with its membership type and pricing plan.

Get a user membership › path Parameters

user_membership

string · required

Get a user membership › Headers

X-Api-Version

string

Optional 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

UserMembershipResource

id

integer · required

The unique identifier of the user membership.

Example: 1234

user_id

integer · required

The id of the member who holds this membership.

Example: 42

status

string · required

Current membership state. retrying means the last renewal payment failed and further attempts are scheduled.

Example: active

will_auto_renew

boolean · required

Whether the membership renews automatically at the end of the current period.

Example: true

ends_at

string | null · required

ISO 8601 timestamp of when the current membership period ends.

Example: 2026-12-31T23:59:59.000000Z

renewed_at

string | null · required

ISO 8601 timestamp of the most recent renewal, or null if the membership has never renewed.

Example: 2026-01-01T00:00:00.000000Z

created_at

string | null · required

ISO 8601 timestamp of when the membership was created.

Example: 2025-06-15T14:30:00.000000Z

object

The membership type this membership belongs to. Included when the relation is loaded, which both endpoints always do.

plan

object | null

The 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).

Membership Card Transaction

Communal Platform API

User Membership

Server

List user memberships

GET

http://api.community-management.test/api

/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.

List user memberships › query Parameters

filter[user_id]

integer

filter[active]

boolean

filter[expired]

boolean

filter[expires_starting_at]

string · date-time

filter[expires_ending_at]

string · date-time

page[number]

integer · min: 1

page[size]

integer · min: 1 · max: 500

List user memberships › Headers

X-Api-Version

string

Optional 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

UserMembershipResource[] · required

current_page

integer · min: 1 · required

from

integer | null · min: 1 · required

last_page

integer · min: 1 · required

per_page

integer · min: 1 · required

to

integer | null · min: 1 · required

total

integer · min: 0 · required

GET/user_memberships

curl http://api.community-management.test/api/user_memberships \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1234,
      "user_id": 42,
      "status": "active",
      "will_auto_renew": true,
      "ends_at": "2026-12-31T23:59:59.000000Z",
      "renewed_at": "2026-01-01T00:00:00.000000Z",
      "created_at": "2025-06-15T14:30:00.000000Z",
      "membership_type": {
        "id": 0,
        "title": "title"
      },
      "plan": {
        "id": 0,
        "nickname": "nickname",
        "amount": 0,
        "interval": "interval"
      }
    }
  ],
  "current_page": 1,
  "from": 1,
  "last_page": 1,
  "per_page": 1,
  "to": 1,
  "total": 0
}

json

application/json

Get a user membership

GET

http://api.community-management.test/api

/user_memberships/{user_membership}

Returns a single held membership with its membership type and pricing plan.

Get a user membership › path Parameters

user_membership

string · required

Get a user membership › Headers

X-Api-Version

string

Optional 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

UserMembershipResource

id

integer · required

The unique identifier of the user membership.

Example: 1234

user_id

integer · required

The id of the member who holds this membership.

Example: 42

status

string · required

Current membership state. retrying means the last renewal payment failed and further attempts are scheduled.

Example: active

will_auto_renew

boolean · required

Whether the membership renews automatically at the end of the current period.

Example: true

ends_at

string | null · required

ISO 8601 timestamp of when the current membership period ends.

Example: 2026-12-31T23:59:59.000000Z

renewed_at

string | null · required

ISO 8601 timestamp of the most recent renewal, or null if the membership has never renewed.

Example: 2026-01-01T00:00:00.000000Z

created_at

string | null · required

ISO 8601 timestamp of when the membership was created.

Example: 2025-06-15T14:30:00.000000Z

object

The membership type this membership belongs to. Included when the relation is loaded, which both endpoints always do.

plan

object | null

The 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).

Membership Card Transaction