Mettre à jour l'abonnement

patch

https://api.sb.moneris.io/subscriptions/{subscription-id}

Demandes récentes

Connectez-vous pour voir l'historique complet des demandes

Heure	Statut	Agent utilisateur
Récupération des demandes récentes…

Loading…

Path Params

subscription-id

string

required

length between 30 and 30

^[A-Za-z]{2}\d{2}[A-Za-z0-9]{26}$

L’identifiant unique de l'abonnement

Body Params

Mettre à jour les détails de l'abonnement tels que le cycle de facturation de l'abonnement, le montant et le mode de paiement.

paymentMethod

object

Utilisez l’identifiant unique du mode de paiement existant.

totalSubscriptionIntervalCount

int32

1 to 99

Combien de paiements sont programmés dans la série. Les paiements liés au champ oneTimeAmount ne sont pas inclus dans le décompte initial.

subscriptionAmount

object

Le montant de l'abonnement. La valeur doit être en cents. Par conséquent, 10,59 $ doivent être envoyés sous la forme 1059

callbackUrl

string | null

URL-encodée, URL de rappel entièrement qualifiée qui reçoit la notification d'abonnement.
Remarque : La demande avec une URL qui n'est pas encodée en URL sera rejetée pour des raisons de sécurité.
Exemple (URL encodée) : https%3A%2F%2Fmerchant.example.com%2Fcallback%3ForderId%3D123

customerId

string

length between 30 and 30

^[A-Za-z]{2}\d{2}[A-Za-z0-9]{26}$

Identification unique du client

customerReference

string | null

Identification unique du client. Il peut s'agir d'un identifiant généré à partir d'un identifiant défini par le marchand.

customData

object | null

Le marchand peut envoyer des métadonnées personnalisées avec la transaction dans cet objet. Moneris fera écho à ces valeurs en réponse.

Headers

X-Merchant-Id

string

required

length between 13 and 13

Code d’identification de treize caractères.

Remarque : Ce code est fourni par Moneris et est nécessaire pour identifier le commerçant qui effectue la transaction.

Api-Version

string

required

Defaults to 2025-08-14

Version de l’API du point de terminaison.

Doit être fourni dans la section des en-têtes.

X-Correlation-Id

string

Corrèle une série de requêtes au sein d’un même flux.

Remarque : Cet identifiant est généré par Moneris avec chaque demande ou réponse, s’il n’existe pas.
Les commerçants doivent faire écho à la valeur avec chaque demande qui fait partie du flux d’appels.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Les détails de facturation des abonnements ont été traités avec succès.

400Mauvaise demande.

401Non autorisé. L’utilisateur ne dispose pas d’une clé API ou d’un jeton d’accès valide.

403Interdit. L’utilisateur n’est pas autorisé à accéder à la ressource demandée.

404Introuvable.

409La demande n’a pas pu être terminée en raison d’un conflit avec l’état de la ressource ou la clé d’idempotence existante.

422L’API ne peut pas effectuer l’action demandée en raison d’erreurs sémantiques ou de validation métier.

429Trop de requêtes

500Erreur inattendue.

503Service temporairement indisponible