Subscribers

Base URL: https://your-domain.com/api/v1

Manage subscriber accounts. Supersedes the legacy /api/user endpoints. All require HTTP Basic Auth.

Activation is separate

Creating a subscriber here is a profile record only. To activate/renew (RADIUS + billing), use Activation.

Fetch subscribers

GET /api/v1/subscriber/list — With filters; enriches area/subarea/city.

Filter	Notes
user_id, username, mobile, phone, email, nic	Identity
package_id, salesperson_id, nas_id, static_ip, mac_address	Service
profile_status, connection_status, connection_type, sms_status, mac_lock	Status
limit, offset	Paging

• 200: JSON array of subscriber objects (isp_id, id, name, username, password, mobile_number, package_id, current_expiration_date, …, area_data). The portal_pass hash is not exposed.

cURL

curl -u "user:pass" "https://your-domain.com/api/v1/subscriber/list?package_id=5&limit=50"

Get subscriber

GET /api/v1/subscriber/get/{id} — Single subscriber. 404 if not found.

Create subscriber

POST /api/v1/subscriber/create

Required: isp_id, name, username, password, package_id, connection_type_id, salesperson_id, nas_id, nic_number, mobile_number

Optional: phone_number, email, address, city_id, area_id, subarea_id, latitude, longitude, box_number, box_address, uplink_port, fiber_code, fiber_color, switch_board, switch_port, backup_connection, electricity_socket, cable_type

Uniqueness is enforced on username, nic_number, mobile_number, phone_number, email.

• 200: { "success": "Subscriber Successfully Created.", "id": 1042 } · 400: validation

Update subscriber

POST /api/v1/subscriber/update — Keyed by username (username itself is not changed). Same fields as create. Unlike the legacy API, this does not reset status/connection/MAC-lock.

• 200: { "success": "Subscriber Successfully Updated." }

Usage & online status

GET /api/v1/subscriber/usage/{id} — Live session + data-quota snapshot.

• 200:

{
  "user_id": 1024, "username": "john123", "online": true,
  "session": { "ip": "10.0.0.5", "nas_ip": "10.0.0.1", "session_id": "…", "mac": "AA:BB:…",
               "start_time": "…", "last_update": "…" },
  "data_quota": { "enabled": false, "total_bytes": 0, "used_bytes": 0 }
}

When offline, online is false and session is null.

Notes

GET /api/v1/subscriber/notes/{id} — Global note + read-only staff notes.

{ "user_id": 1024, "global_note": "VIP customer", "staff_notes": [ { "id": 3, "note": "…", "added_by": 5 } ] }

POST /api/v1/subscriber/note — Set the global note. Params: user_id (required), note (required).

• 200: { "success": "Note Successfully Updated." }

Reset password

POST /api/v1/subscriber/reset_password — Params: user_id (required), new_password (required) (max 20). Updates the profile password and, for active subscribers, the RADIUS password. Call disconnect to force the session onto the new password.

• 200: { "success": "Password Successfully Updated." }

MAC binding

POST /api/v1/subscriber/mac_lock — Bind to a MAC. Params: user_id (required), mac_address (required).

POST /api/v1/subscriber/mac_unlock — Remove the binding. Params: user_id (required).

POST /api/v1/subscriber/change_mac — Replace the bound MAC. Params: user_id (required), mac_address (required).

• 200: { "success": "MAC Successfully Locked." } (or Unlocked / Updated)