List Modules

GET

/admin/platform-billing/modules

GET

/admin/platform-billing/modules

1 curl -G https://https//https/admin/platform-billing/modules \
2      -H "Content-Type: application/json" \
3      -d search=analytics \
4      -d is_active=true \
5      -d is_free=false \
6      -d per_page=15

200Retrieved

1 {
2   "modules": [
3     {
4       "id": "mod_001",
5       "name": "Advanced Analytics",
6       "key": "adv_analytics",
7       "description": "Provides detailed analytics and reporting features.",
8       "is_active": true,
9       "is_free": false,
10       "price_per_month": 49.99,
11       "created_at": "2023-11-01T10:00:00Z"
12     },
13     {
14       "id": "mod_002",
15       "name": "Basic Reporting",
16       "key": "basic_reporting",
17       "description": "Offers basic reporting tools for small teams.",
18       "is_active": true,
19       "is_free": true,
20       "price_per_month": 0,
21       "created_at": "2022-06-15T08:30:00Z"
22     }
23   ],
24   "pagination": {
25     "current_page": 1,
26     "per_page": 15,
27     "total_pages": 2,
28     "total_items": 20
29   }
30 }

Query parameters

searchstringOptional

Optional: Search modules by name or key

is_activestringOptional

Optional: Filter by active status - boolean - true

is_freestringOptional

Optional: Filter by free status - boolean - true

per_pageintegerOptional

Optional: Results per page - default 15

Response

Successful response