v1

latestOpenAPI 3.0.3Moneris2026-07-2454487645.8 KB

Subscriptions

List subscriptions

Returns a paginated list of subscriptions.

get/subscriptions

Query parameters

cursorstring

Example:d41d8cd98f00b204e9800998ecf8427e

Pagination cursor to return items located after it.

limitinteger

Example:10

Maximum number of items to return in the response.

created_fromstring date-time

Date & Time

Example:2019-07-30T06:43:40.252Z

Returns items created after the specified date, defaults to the current date starting from 12 AM.

created_tostring date-time

Date & Time

Example:2019-07-30T06:43:40.252Z

Returns items created before the specified date, up to one day earlier.

Defaults to current date and time, must be no more than 1 day later than created_from date.

Response

Paginated list of subscriptions.

selfstring uri-reference nullable

Pagination link pointing to the current page.

firststring uri-reference nullable

Pagination link pointing to the first page.

laststring uri-reference nullable

Pagination link pointing to the last page.

nextstring uri-reference nullable

Pagination link pointing to the next page.

previousstring uri-reference nullable

Pagination link pointing to the previous page.

Example response

{
  "data": [
    {
      "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"
        }
      ]
    }
  ]
}