Loading…
Retrieves a list of subscriptions for a specific gym, with filtering and pagination options.
| Permission | Description |
|---|---|
gym_subscriptions.view | View subscriptions for your own gyms |
gym_subscriptions.view_any | View subscriptions for any gym |
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| gym-id |
| int |
| Yes |
| ID of the gym |
| 123 |
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| page | int | No | Page number for pagination | 1 |
| user_name | string | No | Search by subscriber's name, email, username, or phone | "john" |
| user_id | string | No | User ID(s), comma-separated | "10,20" |
| gym_plan_id | string | No | Plan ID(s), comma-separated | "1,2,3" |
| expires_at_from | string | No | Filter: subscriptions expiring after this date | "2025-01-01" |
| expires_at_to | string | No | Filter: subscriptions expiring before this date | "2025-12-31" |
GET /api/v1/gyms/123/subscriptions/manage?user_name=john&gym_plan_id=1&page=1
Authorization: Bearer {token}
Returns a paginated list of gym subscription resources.
{
"data": [ { /* gym subscription resource */ }, ... ],
"links": { /* pagination data */ },
"meta": { /* pagination data */ }
}
For a full schema, see Gym Subscription Resource and Pagination Data.
| Status | Description | Reference |
|---|---|---|
| 404 | Not found (invalid gym or plan) | |
| 401 | Unauthorized | Authentication error |
| 403 | Forbidden (no permission) | Permission error |