Suspendre un abonnement

post

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

Suspend temporairement la facturation d'abonnement.
Lorsqu'une transaction est en attente, elle n'est pas facturée pour le montant d'abonnement.
Toutefois, le nombre de transactions d'abonnement restantes continue de diminuer pendant cette période.

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

idempotencyKey

string

required

length between 1 and 36

Identificateur unique requis pour le traitement des demandes idempotentes.

Remarque : Moneris encourage l’utilisation de la version 4 de l’UUID dans les API comme clé d’idempotence.

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

Langue

Identifiants

URL

Loading…

Réponse

Cliquez sur Essayer ! pour lancer une requête et voir la réponse ici ! Ou choisissez un exemple:

application/json

application/problem+json

*/*

200L'abonnement a été suspendu 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