List Plans
Retrieve plans created by your business.
-H "x-api-key: your_secret_key"GET {{host}}/v1/plansQuery Parameters
| Field | Data Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page to retrieve. Defaults to 1. |
| limit | integer | No | Records per page. Maximum is 100. |
| order | string | No | ASC or DESC. Defaults to DESC. |
| sort | string | No | Field to sort by. Defaults to createdAt. |
| query | string | No | Search by plan name. |
| status | boolean | No | Filter by active status. |
| startDate | string | No | Start date filter. |
| endDate | string | No | End date filter. |
{
"status": true,
"message": "Success",
"code": 200,
"data": {
"page": 1,
"limit": 100,
"total": 1,
"pageCount": 1,
"hasPreviousPage": false,
"hasNextPage": false,
"data": [
{
"id": "4c4a6413-3f0f-4bc6-97d8-c8f1a8516361",
"name": "Starter",
"description": "Monthly starter subscription",
"interval": "monthly",
"amount": 5000,
"code": "PLN_abc123",
"mode": "live",
"isActive": true,
"createdAt": "2026-05-20T10:15:00.000Z"
}
]
}
}Updated about 24 hours ago
