Chargement de vos clés API…

Créer un abonnement

POSThttps://staging.mobupay.nc/api/v1/subscriptions

Ce 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. Le transfert de responsabilité s'applique si la carte a été enrôlée chez nous avec authentification, Mobupay la rejouant à chaque échéance. 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.

En-tête d'authentification

Authorization: Bearer sk_test_XXXX

Le 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/json

customerIdstringRequis

Client abonné (`cus_*`).

paymentMethodIdstringOptionnel

Carte à prélever (`pm_*`). Omise, l'abonnement attend son mandat.

recurringInvoiceIdstringOptionnel

Modè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.

labelstringRequis

Ce que le client paie. Figure sur la facture quand le module Facturation est actif.

amountintegerRequis

Montant de chaque échéance, en unité mineure de `currency`.

currencystringOptionnel

Devise. Défaut XPF.

intervalUnitstringOptionnel

Défaut `month`.

intervalCountintegerOptionnel

Nombre d'unités entre deux échéances. Défaut 1.

dayOfMonthintegerOptionnel

Jour du mois, 1 à 31. `31` vaut « dernier jour » : février n'invente pas de 31.

startOnstringRequis

Première échéance, AAAA-MM-JJ.

endsOnstringOptionnel

Dernière échéance possible, AAAA-MM-JJ.

maxOccurrencesintegerOptionnel

Nombre d'échéances au plus.

retryScheduleobjectOptionnel

Cadence de nouvelle tentative après un refus, en jours depuis l'échéance. Absente : celle du produit, rendue dans la réponse.

Codes de retour

201

Abonnement créé.

404

Client, carte ou modèle de facture introuvable.

Langage

Requête cURLpostExemple

1curl --request POST \

2 --url https://api.mobupay.nc/api/v1/subscriptions \

3 --header 'authorization: Bearer sk_test_XXXX' \

4 --header 'content-type: application/json' \

5 --data '{ "customerId": "cus_682c1csmypnq7m41", "paymentMethodId": "pm_jx9z707jtxlc4l9w", "label": "Formule Pro", "amount": 4500, "currency": "XPF", "intervalUnit": "month", "dayOfMonth": 1, "startOn": "2026-10-01" }'

Réponse

Cliquez sur Essayer pour lancer la requête et voir la réponse ici.