Chargement de vos clés API…

Modifier un abonnement

PATCHhttps://staging.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.

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.

Paramètres

1 en-tête

idstringRequispath

Corps de la requête

application/json

statusstringOptionnel

paymentMethodIdstringOptionnel

Rattache une carte. Un abonnement en attente de mandat devient actif.

recurringInvoiceIdstringOptionnel

Rattache 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`).

amountintegerOptionnel

endsOnstringOptionnel

Codes de retour

200

Abonnement mis à jour.

404

Introuvable.

409

Abonnement terminé, ou aucune carte rattachée.

Langage

Requête cURLpatchExemple

1curl --request PATCH \

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

3 --header 'authorization: Bearer sk_test_XXXX' \

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

5 --data '{ "status": "paused" }'

Réponse

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