List Plans

GET

/membership/plans

GET

/membership/plans

1 curl -G https://https//https/membership/plans \
2      -H "{{tenant_key_name}}: X-Tenant-ID" \
3      -H "Content-Type: application/json" \
4      -d is_active=1 \
5      -d duration_type=ongoing \
6      -d is_equipment_based=0 \
7      --data-urlencode "search=Premium Gold" \
8      -d per_page=15 \
9      -d page=1

200Retrieved

1 {
2   "plans": [
3     {
4       "id": "plan_987654321",
5       "name": "Premium Gold Membership",
6       "code": "PGM2024",
7       "description": "Access to all premium features including equipment rental and priority support.",
8       "duration_type": "ongoing",
9       "duration_months": null,
10       "price": 99.99,
11       "currency": "USD",
12       "is_active": true,
13       "is_equipment_based": false,
14       "created_at": "2024-01-10T09:00:00Z",
15       "updated_at": "2024-04-01T12:00:00Z"
16     },
17     {
18       "id": "plan_123456789",
19       "name": "Basic Fixed Membership",
20       "code": "BFM2024",
21       "description": "Fixed 6-month membership with limited access to equipment.",
22       "duration_type": "fixed",
23       "duration_months": 6,
24       "price": 49.99,
25       "currency": "USD",
26       "is_active": true,
27       "is_equipment_based": true,
28       "created_at": "2023-11-15T08:30:00Z",
29       "updated_at": "2024-03-20T10:15:00Z"
30     }
31   ],
32   "pagination": {
33     "current_page": 1,
34     "per_page": 15,
35     "total_pages": 2,
36     "total_items": 20
37   }
38 }

Query parameters

is_activeintegerOptional

Optional: Filter by active status - 0|1

duration_typestringOptional

Optional: Filter by duration type - ongoing|fixed

is_equipment_basedstringOptional

Optional: Filter by equipment-based plans - 0|1

searchstringOptional

Optional: Search by plan name or code

per_pageintegerOptional

Optional: Results per page - default 15

pageintegerOptional

Optional: Page number - default 1

Response

Successful response

Headers

Query parameters

Response