Modifier un abonnement
https://api.mobupay.nc/api/v1/subscriptions/{id}Ce que fait cet appel
Suspend, reprend ou résilie un abonnement, rattache une carte, change le montant ou la date de fin. Une résiliation est définitive : l'échéancier ne reprend pas. Une échéance naît le jour où elle est due, au passage quotidien de 4 h 30 (heure de Nouméa) : un changement de montant s'applique aux échéances pas encore ouvertes, et une échéance déjà ouverte, même représentée après un refus, garde son montant.
Authorization: Bearer sk_test_XXXXLe pool est déduit du préfixe de la clé
Il n'y a pas d'interrupteur test et production sur cette page. sk_test_* ne traite aucun paiement réel, sk_live_* encaisse.
Paramètres
1 en-têteidstringRequispathCorps de la requête
application/jsonstatusstringOptionnel`paused` suspend l'abonnement : aucune échéance n'est ouverte ni prélevée. `active` le reprend, selon `resumePolicy` ; la cadence de nouvelle tentative des échéances restant à prélever repart du jour de la reprise.
paymentMethodIdstringOptionnelRattache une carte. Un abonnement en attente de mandat devient actif.
recurringInvoiceIdstringOptionnelRattache un modèle de facture récurrente, ou le détache avec `null` : les prélèvements continuent, l'émission s'arrête. Le total du modèle doit égaler le montant prélevé ; changer `amount` sur un abonnement déjà raccordé est soumis au même contrôle (409 `INVOICE_TEMPLATE_MISMATCH`).
amountintegerOptionnelNouveau montant, en unité mineure de la devise. Il s'applique aux échéances pas encore ouvertes : modifiez-le au plus tard la veille de l'échéance visée, heure de Nouméa. Refusé (409 `SUBSCRIPTION_PER_CYCLE`) sur un abonnement dont chaque échéance porte son propre montant.
endsOnstringOptionnelresumeOnstringOptionnelJour (AAAA-MM-JJ, heure de Nouméa) où le passage quotidien reprendra l'abonnement suspendu. Avec `status: "paused"`, ou seul sur un abonnement déjà suspendu pour déplacer la date ; `null` la retire. Doit être postérieur à aujourd'hui (400), et ne se pose que sur un abonnement suspendu (409 `SUBSCRIPTION_NOT_PAUSED`).
resumePolicystringOptionnel`skip` : les échéances tombées pendant la suspension ne sont pas prélevées. `bill` : chacune est prélevée à la reprise. `null` revient au réglage de votre espace marchand, à défaut `skip`.
Codes de retour
Abonnement mis à jour.
Date de reprise passée ou mal formée.
Introuvable.
Abonnement terminé, aucune carte rattachée, date de reprise sur un abonnement non suspendu, ou montant sur un abonnement à montants indépendants.
Langage
Cliquez sur Essayer pour lancer la requête et voir la réponse ici.