Subscription | ePay documentation

idstring

The ID of the subscription

Format:

uuid

Example:

"01929a94-5fce-7ccc-a7e4-7e9249133b39"

paymentMethodIdstring

Nullable

The ID of the associated payment method

Format:

uuid

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.

Match:

^[A-Z]{3}$

Example:

"DKK"

customerIdstring

The id of the merchant customer

Example:

"User159"

pointOfSaleIdstring

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

Format:

uuid

Example:

"0192473a-e381-705c-b61c-fc2ac9624afc"

referencestring

Nullable

The merchant reference for the subscription.

Example:

"reference-1"

descriptionstring

Nullable

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.

The current state of the subscription. See our <a href="/get-started/core-concepts">Core Concepts</a> 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.

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"

expiryDatestring

Nullable

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.

Format:

date

Example:

"2050-01-01"

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

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

periodstring

Required

The time unit of the frequency field

Possible values:

"DAY""WEEK""MONTH""YEAR"

Example:

"MONTH"

frequencyinteger

Required

The number of period's between each charge.

Range:

1 <= value <= 31

Example:

1

createdAtstring

The time of creation

Format:

date-time

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": "2019-08-24T14:15:22Z"}