Résilier un abonnement
Résilier un abonnement
Aperçu
Résilier un abonnement
Résilie un abonnement actif immédiatement ou en fin de période (cancel_at_period_end).
Quand l’utiliser
Utilisez pour arrêter la facturation récurrente à la fin de période ou immédiatement selon votre flux.
Voir aussi
Récupérer un abonnement · 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
POST /subscriptions/{id}/cancel
URLs de base :
https://sandbox.api.lomi.africahttps://api.lomi.africa
Requête
Paramètres d’URL
| Nom | Obligatoire | Schéma | Description |
|---|---|---|---|
id | Oui | - | UUID de l’abonnement |
Paramètres de requête
Aucun paramètre de requête.
Corps de la requête
Corps JSON.
Schéma: object
| Champ | Obligatoire | Type | Description |
|---|---|---|---|
cancel_at_period_end | Non | boolean | - |
cancellation_reason | Non | string | - |
Exemple de corps :
{
"cancel_at_period_end": true,
"cancellation_reason": "string"
}Réponses
| Statut | Description |
|---|---|
200 | Abonnement résilié avec succès |
401 | Clé API invalide ou manquante |
404 | Abonnement introuvable ou accès refusé |
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 POST "https://sandbox.api.lomi.africa/subscriptions/value/cancel" \
-H "X-API-KEY: $LOMI_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{"cancel_at_period_end":true,"cancellation_reason":"string"}'OpenAPI
- operationId:
SubscriptionsController_cancel - Operation:
POST /subscriptions/{id}/cancel
Schémas complets et Try it : référence API.