Aller au contenu
ReadyZone Docs
Référence API

Liste des forfaits

Lister les forfaits actifs de la zone.

GET /api/plans?companyRef={companyRef}

Accès : Public

Cas d'usage opérateur

Quand l'utilisateur ouvre l'onglet “Acheter un forfait”, le portail charge uniquement les forfaits actifs de la zone.

Paramètres

  • companyRef (query, obligatoire)

Corps de réponse

La réponse est un tableau JSON. Les forfaits retournés sont actifs et associés à la zone demandée.

AttributTypeNullableDescription
idstring (UUID)NonIdentifiant du forfait.
namestringNonNom affiché.
descriptionstringOuiDescription du forfait.
pricenumberNonPrix du forfait.
currencystringOuiDevise, généralement XAF.
durationHoursnumberNonDurée en heures.
downloadSpeedKbpsnumberNonDébit descendant en Kbps.
uploadSpeedKbpsnumberNonDébit montant en Kbps.
dataLimitMBnumberOuiLimite de données en MB. null signifie illimité.
quotaDataLimitMBnumberOuiQuota de données du forfait period-based.
quotaExceededActionstringOuinone ou throttle.
quotaExceededDownloadSpeedKbpsnumberOuiDébit descendant après dépassement.
quotaExceededUploadSpeedKbpsnumberOuiDébit montant après dépassement.
isActivebooleanNonIndique si le forfait est actif.
isPopularbooleanNonBadge de popularité.
typestringNonType métier du forfait.
badgestringOuiBadge marketing personnalisé.
isTrialbooleanNonIndique une période d’essai.
isGuestPurchaseEnabledbooleanNonAutorise l’achat invité.
isPromoCodeEnabledbooleanNonAutorise les codes promo.
isSmsNotificationEnabledbooleanNonAutorise l’envoi de notification SMS.
freeOfferFrequencystringOuiFréquence de l’offre gratuite, si applicable.
simultaneousUsersnumberNonNombre d’utilisateurs simultanés autorisés.
referencestringNonRéférence publique du forfait.
featuresobject ou arrayOuiFonctionnalités complémentaires configurées.

Exemple

[
  {
    "id": "plan_uuid",
    "name": "Forfait 2H",
    "price": 500,
    "currency": "XAF",
    "type": "time-based",
    "durationHours": 2,
    "isGuestPurchaseEnabled": true,
    "isActive": true
  }
]

Codes de statut

  • 200 OK
  • 400 Bad Request (companyRef manquant/invalide)

Sur cette page