API Reference
List plans
List active plans for the zone.
GET /api/plans?companyRef={companyRef}Access : Public
Operator use case
When users open the “Buy a plan” tab, load only active plans for the selected zone.
Parameters
- companyRef (query, required)
Response body
The response is a JSON array. Returned plans are active and associated with the requested zone.
| Attribute | Type | Nullable | Description |
|---|---|---|---|
id | string (UUID) | No | Plan identifier. |
name | string | No | Display name. |
description | string | Yes | Plan description. |
price | number | No | Plan price. |
currency | string | Yes | Currency, usually XAF. |
durationHours | number | No | Duration in hours. |
downloadSpeedKbps | number | No | Download speed in Kbps. |
uploadSpeedKbps | number | No | Upload speed in Kbps. |
dataLimitMB | number | Yes | Data limit in MB. null means unlimited. |
quotaDataLimitMB | number | Yes | Data quota for period-based plans. |
quotaExceededAction | string | Yes | none or throttle. |
quotaExceededDownloadSpeedKbps | number | Yes | Download speed after quota exhaustion. |
quotaExceededUploadSpeedKbps | number | Yes | Upload speed after quota exhaustion. |
isActive | boolean | No | Whether the plan is active. |
isPopular | boolean | No | Popularity badge flag. |
type | string | No | Business plan type. |
badge | string | Yes | Custom marketing badge. |
isTrial | boolean | No | Whether this is a trial period. |
isGuestPurchaseEnabled | boolean | No | Whether guest purchase is allowed. |
isPromoCodeEnabled | boolean | No | Whether promo codes are allowed. |
isSmsNotificationEnabled | boolean | No | Whether SMS notification is enabled. |
freeOfferFrequency | string | Yes | Free-offer frequency, when applicable. |
simultaneousUsers | number | No | Allowed simultaneous users. |
reference | string | No | Public plan reference. |
features | object or array | Yes | Configured additional features. |
Example
[
{
"id": "plan_uuid",
"name": "2H Plan",
"price": 500,
"currency": "XAF",
"type": "time-based",
"durationHours": 2,
"isGuestPurchaseEnabled": true,
"isActive": true
}
]Status codes
- 200 OK
- 400 Bad Request (missing/invalid companyRef)