Recurring PaymentsPlansGet Plan Details

Get Plan Details

Retrieve one plan by its numeric ID or plan_code.

Endpoint

GET https://backendapi.sayswitchgroup.com/api/v1/plan/{id_or_code}

{id_or_code} accepts either a numeric plan ID, such as 42, or a plan code beginning with PLN_.

Request

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

Response

{
  "status": true,
  "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"
  }
}

Plan Not Found

If the plan does not belong to your account and environment, or does not exist, the API returns HTTP 404.

{
  "status": false,
  "message": "Plan not found."
}