GuidesAPI ReferenceChangelog
Log In
API Reference
  1. Moneris API
  2. Subscriptions

Pause Subscription

post
https://api.sb.moneris.io/subscriptions//pause

Temporarily pauses subscription billing.
While a transaction is on hold, it is not billed for the subscription amount.
However, the number of remaining recurs continues to be decremented during that time.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 30 and 30
^[A-Za-z]{2}\d{2}[A-Za-z0-9]{26}$

The unique identifier of the subscription

Body Params
string
required
length between 1 and 36

A Unique Identifier that is required for handling idempotent requests.

Note: Moneris encourages the use of UUID Version 4 in APIs as an idempotency key."

customData
object | null

Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.

Headers
string
required
length between 13 and 13

Thirteen character identification code.

Note: This code is provided by Moneris and is required to identify the Merchant executing the transaction."

string
required
Defaults to 2025-08-14

The endpoint's API Version.

Must be provided through the headers section.

string

Correlates a series of requests within the same flow.

Note: This ID is generated by Moneris with every request or response, if it doesn't exist.
Merchants are to echo back the value with every request that is part of the call flow."

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json
*/*

Updated 3 months ago

Did this page help you?