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.
| Attribut | Type | Nullable | Description |
|---|---|---|---|
id | string (UUID) | Non | Identifiant du forfait. |
name | string | Non | Nom affiché. |
description | string | Oui | Description du forfait. |
price | number | Non | Prix du forfait. |
currency | string | Oui | Devise, généralement XAF. |
durationHours | number | Non | Durée en heures. |
downloadSpeedKbps | number | Non | Débit descendant en Kbps. |
uploadSpeedKbps | number | Non | Débit montant en Kbps. |
dataLimitMB | number | Oui | Limite de données en MB. null signifie illimité. |
quotaDataLimitMB | number | Oui | Quota de données du forfait period-based. |
quotaExceededAction | string | Oui | none ou throttle. |
quotaExceededDownloadSpeedKbps | number | Oui | Débit descendant après dépassement. |
quotaExceededUploadSpeedKbps | number | Oui | Débit montant après dépassement. |
isActive | boolean | Non | Indique si le forfait est actif. |
isPopular | boolean | Non | Badge de popularité. |
type | string | Non | Type métier du forfait. |
badge | string | Oui | Badge marketing personnalisé. |
isTrial | boolean | Non | Indique une période d’essai. |
isGuestPurchaseEnabled | boolean | Non | Autorise l’achat invité. |
isPromoCodeEnabled | boolean | Non | Autorise les codes promo. |
isSmsNotificationEnabled | boolean | Non | Autorise l’envoi de notification SMS. |
freeOfferFrequency | string | Oui | Fréquence de l’offre gratuite, si applicable. |
simultaneousUsers | number | Non | Nombre d’utilisateurs simultanés autorisés. |
reference | string | Non | Référence publique du forfait. |
features | object ou array | Oui | Fonctionnalité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)