Extend Subscription

post

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

Adds the given number of subscription transactions to the current (remaining) number.

This can be used if a customer decides to extend a membership/subscription.
However, because this must be a positive number, it cannot be used to decrease the current number of subscription transactions.
For that, use 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

Adds the given number of subscription transactions to the current (remaining) number. This can be used if a customer decides to extend a membership/subscription. However, because this must be a positive number, it cannot be used to decrease the current number of subscription transactions.

idempotencyKey

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

additionalSubscriptionIntervalCount

int32

required

1 to 99

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 extended successfully

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