Skip to main content

Subscription

iduuid

The ID of the subscription

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

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
referencestringnullable

The merchant reference for the subscription.

Example: reference-1
descriptionstringnullable

An optional description which can be assigned to the subscription. Can be used to help human operators to link or understand which subscription it is.

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 objectnullable

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

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",
  "description": "string",
  "state": "ACTIVE",
  "type": "SCHEDULED",
  "expiryDate": "2050-01-01",
  "interval": {
    "period": "MONTH",
    "frequency": 1
  },
  "createdAt": "2024-07-29T15:51:28.071Z"
}