---
title: "List subscriptions"
method: GET
path: "/subscriptions"
tags: ["Subscriptions"]
---

# List subscriptions

`GET /subscriptions`

Returns a paginated list of subscriptions.

## Query parameters

- `cursor` string
- `limit` integer
- `created_from` string, date-time — Date & Time
- `created_to` string, date-time — Date & Time

## Response `200`

Paginated list of subscriptions.

- SubscriptionList — Paginated List of subscriptions.
  - `data` Subscription[], required — List of subscriptions.
    - `subscriptionId` string, required — Unique Identification for the Subscription
    - `merchantId` string, required — Thirteen character long identification provided to merchants by Moneris.
    - `orderId` string, 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.
    - `invoiceNumber` string, nullable — Submits a unique value to identify a transaction that is logged by Moneris Solutions.
    - `createdAt` string, date-time, required — Time at which the object was created
    - `customerId` string, nullable — Unique Identification for the Customer
    - `customerReference` string, nullable — Unique Identification for the Customer. This can be an identifier generated from a merchant-defined identifier.
    - `modifiedAt` string, date-time, nullable — Time at which the object was modified
    - `subscriptionType` 'RECURRING', required — Subscription Type. - RECURRING: Recurring Subscription.
    - `billingInformation` BillingInformation, required — Subscriptions allows you to set up payments whereby Moneris automatically processes the transactions and bills customers on your behalf based on the billing cycle information you provide.
      - `billingIntervalUnit` 'DAY' | 'WEEK' | 'MONTH' | 'END_OF_MONTH', required — Controls whether the recurring series occurs on a: daily (`DAY`), weekly (`WEEK`), or monthly (`MONTH`) basis. To ensure regular schedules, use `END_OF_MONTH` for schedules occurring on the last day of each month.
      - `billingIntervalFrequency` integer, required — Number of interval units passing between subscribed payments. Frequencies higher than 1 cause the subscription to skip intervals, such as bi-weekly (2 weeks) or annual subscriptions (12 months).
      - `billingIntervalCount` integer, required — How many payments are scheduled in the series. Payments related to the oneTimeAmount field are not included in the initial count.
      - `billingAmount` object, required — The amount of the subscription transaction. The value must be in cents. Therefore $10.59 must be sent as 1059
        - `amount` integer, required — Amount
        - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217
      - `billingStartDate` string, date, required — Date of the first future subscription billing transaction. This value must be a date in the future.
      - `nextBillingDate` string, date, nullable — Date on which the next payment will occur
      - `billingEndDate` string, date, nullable — Date on which the subscription will end.
    - `callbackUrl` string, 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
    - `paymentMethod` PaymentMethod, required — Payment method response object
      - `paymentMethodId` string, required — Unique Identifier of the payment method.
      - `merchantId` string, required — Thirteen character long identification provided to merchants by Moneris.
      - `cardholderInformation` CardholderInformation, nullable — Information about the holder of the card.
        - `cardholderName` string, required — Cardholder name
        - `companyName` string, nullable — Identifies the associated company name
      - `contactDetails` ContactDetails, nullable — Contact details
        - `phoneNumber` string, nullable — Phone number.
        - `email` string, email, nullable — Contains the customer's email address. For standard email protocols, visit: https://www.rfc-editor.org/rfc/rfc5322
      - `billingAddress` object, nullable — The postal address including street, town/city, province, and postal code. Optionally an unit number can be provided.
        - `unitNumber` string, nullable — Unit number
        - `streetNumber` string, nullable — Street number
        - `streetName` string, nullable — Street name
        - `city` string, nullable — Identifies the city.
        - `province` string, iso-3166-2, nullable — Province or state ISO 3166-2 code
        - `postalCode` string, nullable — Postal or zip code
        - `country` string, iso-3166, nullable — Provides the two letter country code according the ISO 3166-1 alpha-2 standard. For a complete list of country codes, visit: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
      - `paymentMethodInformation` CardPaymentMethodInformation, required — Details about the card used in the payment method.
        - `paymentMethodType` 'CARD', required — The type of Payment Method being used. It can be: - Card.
        - `paymentMethodSource` 'CARD' | 'TEMPORARY_TOKEN' | 'PERMANENT_TOKEN' | 'APPLE_PAY_ENCRYPTED' | 'APPLE_PAY_DECRYPTED' | 'GOOGLE_PAY_ENCRYPTED' | 'GOOGLE_PAY_DECRYPTED', required — The source of Payment Method being used. It can be: - The Id of a Payment Method already created. - Permanent Token. - Temporary Token. - Card. - E-Wallet.
        - `cardInformation` CardInformation, required — Information about the card being used for the transaction
          - `bankIdentificationNumber` string, nullable — **BIN**: Bank Identification Number Consists of the first six to eight digits of the Primary Account Number (PAN) and identifies the relevant payment network and the specific payment issuing institution.
          - `lastFour` string, nullable — Last 4 digits of the card.
          - `expiryMonth` integer — Card expiration month. Format must be MM
          - `expiryYear` integer — Displays the card expiration year. Accepted format: YYYY
          - `cardBrand` 'MASTERCARD' | 'VISA' | 'AMERICAN_EXPRESS' | 'JCB' | 'DISCOVER' | 'INTERAC' | 'UNIONPAY' | 'GIFT_MONERIS' | 'GIFT_DATACANDY' | 'GIFT_GIVEX' | 'null', nullable — Displays the card brand name associated with the card type.
          - `cardType` 'CREDIT' | 'DEBIT' | 'DOMESTIC_DEBIT' | 'PREPAID_RELOADABLE' | 'PREPAID_NON_RELOADABLE' | 'UNKNOWN' | 'GIFT' | 'LOYALTY' | 'FLEET' | 'CORPORATE', nullable — Specifies the intended card use; i.e. debit or credit.
          - `cardFingerprint` string, nullable — Unique card identifier. Fingerprinting randomly assigns identfiers for cards that share the same Primary Account Number (PAN) to easily identify when multiple payments methods are attached to the same underlying card, and assists merchants identify individual customers across various channels; i.e. loyalty programs.
          - `issuer` string, nullable — Card issuer.
        - `paymentAccountReference` string, nullable — Used to link Primary Account Number (PAN) based transactions and transactions on associated payment tokens without using the PAN as the linking mechanism.
        - `storePaymentMethod` 'DO_NOT_STORE' | 'CARDHOLDER_INITIATED' | 'MERCHANT_INITIATED', required — Store this payment method created through this payment for future use. - DO_NOT_STORE: Payment method will not be stored. - CARDHOLDER_INITIATED: Payment method to be stored and can only re-used with cardholder's consent. Limited to store, pre-authorisation, and card validations." - MERCHANT_INITIATED: Payment method to be stored and can be reused without the cardholder's consent. For example, subscriptions.
      - `createdAt` string, date-time, required — Time at which the object was created
      - `modifiedAt` string, date-time, nullable — Time at which the object was modified
      - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.
    - `subscriptionStatus` 'DECLINED' | 'DECLINED_RETRY' | 'PAUSED' | 'ACTIVE' | 'CANCELED' | 'COMPLETED', required — Subscription Status description.
    - `oneTimeAmount` object, nullable — The amount for the first subscription transaction. The value must be in cents. Therefore $10.59 must be sent as 1059
      - `amount` integer, required — Amount
      - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217
    - `credentialOnFileResponse` CredentialOnFileResponse, nullable — Contains fields related to the Credential on File (CoF)
      - `originalAmount` OriginalAmount, nullable — Original amount for the first transaction in the series. Note: The value must be in cents. Therefore $10.59 must be sent as 1059
        - `amount` integer, required — Amount
        - `currency` string, iso-4217, required — Provides the three letter currency code according the ISO 4217 standard. For a complete list of currency codes, visit: https://en.wikipedia.org/wiki/ISO_4217
      - `issuerId` string, nullable — Displays a unique identifier for the card holder's stored credentials. This information is returned from the card brand when processing a Credential on File transaction.
    - `customData` CustomData, nullable — Merchant can send custom meta data with the transaction in this object. Moneris will echo these values back in response.
    - `payments` PaymentReference[] — List of payments
      - `paymentId` string, required — Unique Identification for the Payment
      - `href` string, uri-reference, nullable — Payment Reference URL
  - `self` string, uri-reference, nullable — Pagination link pointing to the current page.
  - `first` string, uri-reference, nullable — Pagination link pointing to the first page.
  - `last` string, uri-reference, nullable — Pagination link pointing to the last page.
  - `next` string, uri-reference, nullable — Pagination link pointing to the next page.
  - `previous` string, uri-reference, nullable — Pagination link pointing to the previous page.

## Other responses

- `400` — Bad Request.
- `401` — Not authorized. The user does not have a valid API Key or Access Token.
- `403` — Forbidden. The user does not have permission to access the requested resource.
- `429` — Too Many Requests
- `500` — Unexpected error.
- `503` — Service Temporarily Unavailable

---

[API](https://skmtc.net/moneris/apis/moneris-api.md) · [All operations](https://skmtc.net/moneris/apis/moneris-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneris/moneris-api/revisions/edefcc925b74/schema)