Skip to content
ReadyZone Docs
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.

AttributeTypeNullableDescription
idstring (UUID)NoPlan identifier.
namestringNoDisplay name.
descriptionstringYesPlan description.
pricenumberNoPlan price.
currencystringYesCurrency, usually XAF.
durationHoursnumberNoDuration in hours.
downloadSpeedKbpsnumberNoDownload speed in Kbps.
uploadSpeedKbpsnumberNoUpload speed in Kbps.
dataLimitMBnumberYesData limit in MB. null means unlimited.
quotaDataLimitMBnumberYesData quota for period-based plans.
quotaExceededActionstringYesnone or throttle.
quotaExceededDownloadSpeedKbpsnumberYesDownload speed after quota exhaustion.
quotaExceededUploadSpeedKbpsnumberYesUpload speed after quota exhaustion.
isActivebooleanNoWhether the plan is active.
isPopularbooleanNoPopularity badge flag.
typestringNoBusiness plan type.
badgestringYesCustom marketing badge.
isTrialbooleanNoWhether this is a trial period.
isGuestPurchaseEnabledbooleanNoWhether guest purchase is allowed.
isPromoCodeEnabledbooleanNoWhether promo codes are allowed.
isSmsNotificationEnabledbooleanNoWhether SMS notification is enabled.
freeOfferFrequencystringYesFree-offer frequency, when applicable.
simultaneousUsersnumberNoAllowed simultaneous users.
referencestringNoPublic plan reference.
featuresobject or arrayYesConfigured 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)

On this page