SubscriptionsListResponse

pageinteger

The current pagination page

perPageinteger

The requested number of entries per page

lastPageinteger

The last page with entries

totalinteger

The total number of entries

firstPageUrlstring

URL for the first page

lastPageUrlstring

URL for the last page

nextPageUrlstringnullable

URL for the next page

previousPageUrlstringnullable

URL for the previous page

nextPageintegernullable

The page number for the next page. Null if no next page.

previousPageintegernullable

The page number for the previous page. Null if no previous page.

frominteger

The entry offset for the first entry in the page

tointeger

The entry offset for the last entry in the page

pathstring

The path for the pagination endpoint

items object[]

The page contents

Array [

subscription object

iduuid

The ID of the subscription

Example: 01929a94-5fce-7ccc-a7e4-7e9249133b39

paymentMethodIduuid

The ID of the associated payment method

Example: 01924756-d1f6-738d-8040-90d76cedf01f

currencystring

The currency of the original transaction which created the subscription. This is used as the default currency for new MIT transactions, if no currency is given.

Possible values: Value must match regular expression ^[A-Z]{3}$

Example: DKK

customerIdstring

The id of the merchant customer

Example: User159

pointOfSaleIduuid

The ID of the associated point of sale used during the creation of the subscription

Example: 0192473a-e381-705c-b61c-fc2ac9624afc

referencestring

The merchant reference for the subscription.

Example: reference-1

statestring

The current state of the subscription. See our Core Concepts page.

Possible values: [PENDING, ACTIVE, INVALID, DISABLED]

Example: ACTIVE

typestring

The type of subscription. SCHEDULED is used for fixed interval charges such as a monthly subscription fee. UNSCHEDULED is used for varying transaction intervals such as pay-as-you-go solutions such as parking or bike renting.

Possible values: [SCHEDULED, UNSCHEDULED]

Example: SCHEDULED

expiryDatedatenullable

The expiration date of the subscription. ePay does not enforce this expiration, but uses it in the processing of transactions which may improve approval rates.

Example: 2050-01-01

interval object

Interval configuration. It can only be present when type equal SCHEDULED. A frequency=2 and period=WEEK means one charge for every two weeks.

periodstringrequired

The time unit of the frequency field

Possible values: [DAY, WEEK, MONTH, YEAR]

Example: MONTH

frequencyintegerrequired

The number of period's between each charge.

Possible values: >= 1 and <= 31

Example: 1

createdAtdate-time

The time of creation

paymentMethod object

iduuid

The ID of the payment method

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

typePaymentMethodType (string)

The type of the payment method.

Possible values: [CARD, VIPPS_MOBILEPAY, MOBILEPAY_ONLINE, APPLE_PAY, GOOGLE_PAY, SWISH, VIABILL, ANYDAY]

Example: CARD

subTypestringnullable

The subtype of the payment method. For card based payments, this will contain the scheme of the card. Such as Visa or Mastercard

Example: Visa

customerIdstringnullable

The merchant customer id that created the payment method.

Example: User159

expirydatenullable

The expiration date of the associated payment method.
Although payment cards are specified by a month and year (MM/YY), this value is returned as a full date (YYYY-MM-DD) representing the last day of the expiration month. Example: "2030-05-31" for a card expiring in May 2030.

Example: 2024-07-29

createdAtdate-time

The time of creation

Example: 2024-07-29T15:51:28.071Z

displayTextstring

A cardholder friendly text to help the customer identify the card. For card based payments, this will contain a masked version of the card number.

Example: 40000000XXXX0003

]

SubscriptionsListResponse

{
  "page": 0,
  "perPage": 0,
  "lastPage": 0,
  "total": 0,
  "firstPageUrl": "string",
  "lastPageUrl": "string",
  "nextPageUrl": "string",
  "previousPageUrl": "string",
  "nextPage": 0,
  "previousPage": 0,
  "from": 0,
  "to": 0,
  "path": "string",
  "items": [
    {
      "subscription": {
        "id": "01929a94-5fce-7ccc-a7e4-7e9249133b39",
        "paymentMethodId": "01924756-d1f6-738d-8040-90d76cedf01f",
        "currency": "DKK",
        "customerId": "User159",
        "pointOfSaleId": "0192473a-e381-705c-b61c-fc2ac9624afc",
        "reference": "reference-1",
        "state": "ACTIVE",
        "type": "SCHEDULED",
        "expiryDate": "2050-01-01",
        "interval": {
          "period": "MONTH",
          "frequency": 1
        },
        "createdAt": "2024-07-29T15:51:28.071Z"
      },
      "paymentMethod": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "CARD",
        "subType": "Visa",
        "customerId": "User159",
        "expiry": "2024-07-29",
        "createdAt": "2024-07-29T15:51:28.071Z",
        "displayText": "40000000XXXX0003"
      }
    }
  ]
}