List Plans

Retrieve plans created by your business.

-H "x-api-key: your_secret_key"
GET {{host}}/v1/plans

Query Parameters

FieldData TypeRequiredDescription
pageintegerNoPage to retrieve. Defaults to 1.
limitintegerNoRecords per page. Maximum is 100.
orderstringNoASC or DESC. Defaults to DESC.
sortstringNoField to sort by. Defaults to createdAt.
querystringNoSearch by plan name.
statusbooleanNoFilter by active status.
startDatestringNoStart date filter.
endDatestringNoEnd 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"
      }
    ]
  }
}