Lister les abonnements
Lister les abonnements
Aperçu
Lister les abonnements
Renvoie tous les abonnements de l'organisation du marchand authentifié. Les abonnements sont créés automatiquement lorsque les clients effectuent des paiements récurrents.
Quand l’utiliser
Utilisez cet endpoint quand vous devez exécuter GET /subscriptions (Lister les abonnements).
Authentification
Les routes marchandes nécessitent une clé API dans l’en-tête X-API-KEY (voir Vue d’ensemble). Utilisez une clé test avec https://sandbox.api.lomi.africa et une clé live avec https://api.lomi.africa.
Endpoint
GET /subscriptions
URLs de base :
https://sandbox.api.lomi.africahttps://api.lomi.africa
Requête
Paramètres d’URL
Pas d’autre paramètre dans l’URL.
Paramètres de requête
| Nom | Emplacement | Obligatoire | Schéma | Description |
|---|---|---|---|---|
pageSize | query | Non | - | Nombre d'éléments par page |
page | query | Non | - | Numéro de page |
Réponses
| Statut | Description |
|---|---|
200 | Liste des abonnements |
401 | Clé API invalide ou manquante |
Erreurs
Les erreurs suivent un format JSON standard. 401 : clé manquante ou invalide. 404 : ressource introuvable. 429 : trop de requêtes. Pour les créations, envoyez une clé d’idempotence si votre flux le permet.
Exemple
curl -sS -X GET "https://sandbox.api.lomi.africa/subscriptions?status=value&customer_id=value" \
-H "X-API-KEY: $LOMI_SECRET_KEY"OpenAPI
- operationId:
SubscriptionsController_findAll - Operation:
GET /subscriptions
Schémas complets et Try it : référence API.