Sign in

v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB
Subscriptions

Extend Subscription

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.

post/subscriptions/{subscription-id}/extend

Request body

idempotencyKeystring required

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

additionalSubscriptionIntervalCountinteger required

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.

customDataCustomData nullable

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

Example request

{
  "idempotencyKey": "6q5w4e7r8t9y",
  "additionalSubscriptionIntervalCount": 12
}

Response

Subscription extended successfully

subscriptionIdstring required

Unique Identification for the Subscription

merchantIdstring required

Thirteen character long identification provided to merchants by Moneris.

orderIdstring nullable required

Indicates the merchant-defined transaction identifer or order ID. Identifiers are unique for every Purchase, Pre-Authorization and Independent Refund transaction

Note: No two transactions of these types may have the same order ID. Field only accepts alphanumerical characters, dashes and underscores.

invoiceNumberstring nullable

Submits a unique value to identify a transaction that is logged by Moneris Solutions.

createdAtstring date-time required

Time at which the object was created

customerIdstring nullable

Unique Identification for the Customer

customerReferencestring nullable

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

modifiedAtstring date-time nullable

Time at which the object was modified

subscriptionType'RECURRING' required

Subscription Type.

  • RECURRING: Recurring Subscription.
callbackUrlstring nullable

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

subscriptionStatus'DECLINED' | 'DECLINED_RETRY' | 'PAUSED' | 'ACTIVE' | 'CANCELED' | 'COMPLETED' required

Subscription Status description.

customDataCustomData nullable

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

Example response

{
  "subscriptionId": "si0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "merchantId": "0123456789101",
  "orderId": "1q2w3e4r5t6t78",
  "invoiceNumber": "1a2s3d45v6",
  "createdAt": "2019-07-30T06:43:40.252Z",
  "customerId": "ci0105ARZ3NDEKTSV4RRFFQ69G5FAV",
  "customerReference": "911677-212",
  "modifiedAt": "2019-07-30T06:43:40.252Z",
  "subscriptionType": "RECURRING",
  "billingInformation": {
    "billingIntervalUnit": "WEEK",
    "billingIntervalFrequency": 2,
    "billingIntervalCount": 2,
    "billingAmount": {
      "amount": 2500,
      "currency": "CAD"
    },
    "billingStartDate": "2025-02-01",
    "nextBillingDate": "2025-02-14",
    "billingEndDate": "2025-02-28"
  },
  "callbackUrl": "https%3A%2F%2Fmerchant.example.com%2Fcallback%3ForderId%3D123",
  "paymentMethod": {
    "paymentMethodId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
    "merchantId": "0123456789101",
    "cardholderInformation": {
      "cardholderName": "John Doe",
      "companyName": "SP Ltd"
    },
    "contactDetails": {
      "phoneNumber": "+18663197450",
      "email": "moneris@moneris.com"
    },
    "billingAddress": {
      "unitNumber": "123A",
      "streetNumber": "3300",
      "streetName": "Bloor Street West",
      "city": "Toronto",
      "province": "ON",
      "postalCode": "M8X 2X2",
      "country": "CA"
    },
    "paymentMethodInformation": {
      "paymentMethodSource": "TEMPORARY_TOKEN",
      "cardInformation": {
        "bankIdentificationNumber": "123456",
        "lastFour": "1234",
        "expiryMonth": 1,
        "expiryYear": 2023,
        "cardBrand": "MASTERCARD",
        "cardType": "CREDIT",
        "cardFingerprint": "1Q2W3E4r5t6rfwewerwewrrw",
        "issuer": "RBC"
      },
      "paymentAccountReference": "11112222333344445555666677778"
    },
    "createdAt": "2019-07-30T06:43:40.252Z",
    "modifiedAt": "2019-07-30T06:43:40.252Z"
  },
  "subscriptionStatus": "ACTIVE",
  "oneTimeAmount": {
    "amount": 16000,
    "currency": "CAD"
  },
  "credentialOnFileResponse": {
    "originalAmount": {
      "amount": 15000,
      "currency": "CAD"
    },
    "issuerId": "A"
  },
  "payments": [
    {
      "paymentId": "pi0105ARZ3NDEKTSV4RRFFQ69G5FAV",
      "href": "/payments/pi0105ARZ3NDEKTSV4RRFFQ69G5FAV"
    }
  ]
}