List Plans

Retrieve plans created in the environment selected by your secret key.

Endpoint

GET https://backendapi.sayswitchgroup.com/api/v1/plan

Request

curl --request GET \
  --url "https://backendapi.sayswitchgroup.com/api/v1/plan?per_page=20" \
  --header "Authorization: Bearer YOUR_SECRET_KEY" \
  --header "Accept: application/json"

Query Parameters

ParameterTypeRequiredDescription
per_pageintegerNoResults per page, from 1 to 100. Defaults to 20.
pageintegerNoPage number to retrieve.

Values below 1 are treated as 1, and values above 100 are treated as 100.

Response

{
  "status": true,
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 42,
        "business_id": 169,
        "plan_code": "PLN_4m8q1v2x7b9n3k6p5r0s",
        "name": "Email Monthly",
        "description": "Monthly access to the email service",
        "amount": "15000.00",
        "currency": "NGN",
        "interval": "monthly",
        "invoice_limit": 12,
        "status": "active",
        "domain": "test",
        "created_at": "2026-09-25T10:30:00.000000Z",
        "updated_at": "2026-09-25T10:30:00.000000Z"
      }
    ],
    "first_page_url": "https://backendapi.sayswitchgroup.com/api/v1/plan?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://backendapi.sayswitchgroup.com/api/v1/plan?page=1",
    "next_page_url": null,
    "path": "https://backendapi.sayswitchgroup.com/api/v1/plan",
    "per_page": 20,
    "prev_page_url": null,
    "to": 1,
    "total": 1
  }
}

The pagination object also includes a links array for building page navigation.