Créer un abonnement
https://api.mobupay.nc/api/v1/subscriptionsCe que fait cet appel
Crée un abonnement : un montant fixe prélevé à intervalle régulier sur une carte enrôlée, sans que le client ait à intervenir. Le prélèvement part comme transaction initiée par le marchand. Pas de transfert de responsabilité : l'échéance part sans authentification, rattachée à l'enregistrement de la carte (UNSCHEDULED). Enregistrez la carte avec usage: "unscheduled" pour que son enregistrement déclare les prélèvements à venir. Si paymentMethodId est omis, l'abonnement reste en attente de mandat : envoyez au client un lien d'enregistrement de carte, puis rattachez-la par un PATCH.
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.
Corps de la requête
application/jsoncustomerIdstringRequisClient abonné (`cus_*`).
paymentMethodIdstringOptionnelCarte à prélever (`pm_*`). Omise, l'abonnement attend son mandat.
recurringInvoiceIdstringOptionnelModèle de facture récurrente (`rin_*`) à émettre à chaque échéance. Omis, l'abonnement prélève sans rien émettre. Le modèle rattaché sort du calendrier ordinaire des factures récurrentes : c'est l'abonnement qui commande son émission. Son total toutes taxes comprises, remise déduite, doit être ÉGAL à `amount` et dans la même devise, sans quoi la réponse est un 409 `INVOICE_TEMPLATE_MISMATCH` : un modèle plus cher produirait une facture partiellement payée, donc une relance envoyée à un client dont le prélèvement a réussi.
labelstringRequisCe que le client paie. Figure sur la facture quand le module Facturation est actif.
amountintegerRequisMontant de chaque échéance, en unité mineure de `currency`.
currencystringOptionnelDevise. Défaut XPF.
intervalUnitstringOptionnelDéfaut `month`.
intervalCountintegerOptionnelNombre d'unités entre deux échéances. Défaut 1.
dayOfMonthintegerOptionnelJour du mois, 1 à 31. `31` vaut « dernier jour » : février n'invente pas de 31.
startOnstringRequisPremière échéance, AAAA-MM-JJ.
endsOnstringOptionnelDernière échéance possible, AAAA-MM-JJ.
maxOccurrencesintegerOptionnelNombre d'échéances au plus.
retryScheduleobjectOptionnelCadence de nouvelle tentative après un refus, en jours depuis l'échéance. Absente : celle du produit, rendue dans la réponse.
resumePolicystringOptionnelCe que la reprise après une suspension fait des échéances tombées pendant la suspension : `skip`, elles ne sont pas prélevées ; `bill`, chacune est prélevée à la reprise. Absent : le réglage de votre espace marchand, à défaut `skip`. La réponse rend la valeur qui s'applique (`resumePolicy`) et sa source (`resumePolicySource`).
Codes de retour
Abonnement créé.
Client, carte ou modèle de facture introuvable.
Langage
Cliquez sur Essayer pour lancer la requête et voir la réponse ici.