Update Subscription

patch

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

Update Subscription

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

subscription-id

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

Update Subscription details such as the subscription billing cycle, amount, and payment method.

paymentMethod

object

Use existing unique payment method identifier.

totalSubscriptionIntervalCount

int32

1 to 99

How many payments are scheduled in the series. Payments related to the oneTimeAmount field are not included in the initial count.

subscriptionAmount

object

The amount of the subscription transaction. The value must be in cents. Therefore $10.59 must be sent as 1059

callbackUrl

string | null

URL-encoded, fully qualified callback URL that receives subscription notification.

Note: Request with URL that is not URL-encoded will be rejected for security reasons.

Example (URL-encoded): 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}$

Unique Identification for the Customer

customerReference

string | null

Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.

customData

object | null

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

Headers

X-Merchant-Id

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."

Api-Version

string

required

Defaults to 2025-08-14

The endpoint's API Version.

Must be provided through the headers section.

X-Correlation-Id

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

200Subscription billing details successfully updated.

400Bad Request.

401Not authorized. The user does not have a valid API Key or Access Token.

403Forbidden. The user does not have permission to access the requested resource.

404Not Found.

409Request could not be completed due to a conflict with resource state or existing idempotency key.

422The API cannot complete the requested action due to semantic or business validation errors.

429Too Many Requests

500Unexpected error.

503Service Temporarily Unavailable