GetSubscriptionResponse
The ID of the subscription
uuid"01929a94-5fce-7ccc-a7e4-7e9249133b39"The ID of the associated payment method
uuid"01924756-d1f6-738d-8040-90d76cedf01f"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.
^[A-Z]{3}$"DKK"The id of the merchant customer
"User159"The ID of the associated point of sale used during the creation of the subscription
uuid"0192473a-e381-705c-b61c-fc2ac9624afc"The merchant reference for the subscription.
"reference-1"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.
The current state of the subscription. See our Core Concepts page.
"PENDING""ACTIVE""INVALID""DISABLED""ACTIVE"Reason for the current state. Is currently only present for subscriptions reaching the DISABLED state.
If a cardholder closes a subscription from a wallet app, such as VippsMobilePay, the reason will be CLOSED_BY_CARDHOLDER.
"CLOSED_BY_MERCHANT_API""CLOSED_BY_MERCHANT_BACKOFFICE""CLOSED_BY_CARDHOLDER""CLOSED_BY_EPAY""CLOSED_BY_CARDHOLDER"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.
"SCHEDULED""UNSCHEDULED""SCHEDULED"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.
date"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.
The time unit of the frequency field
"DAY""WEEK""MONTH""YEAR""MONTH"The number of period's between each charge.
1 <= value <= 311The time of creation
date-timeThe ID of the payment method
uuid"3fa85f64-5717-4562-b3fc-2c963f66afa6"The type of the payment method.
"CARD""VIPPS_MOBILEPAY""MOBILEPAY_ONLINE""APPLE_PAY""GOOGLE_PAY""SWISH""VIABILL""ANYDAY""KLARNA""CARD"The sub type of the associated payment method. For card based payments, this will contain the name of the scheme, such as Visa or Mastercard. The card scheme name formatted with a uppercase starting character. For non-card based payments the field vary depending on the requirements of the payment method.
"Visa""Mastercard""Maestro""Dankort""VisaDankort""Discover""UnionPay""Electron""Amex""JCB""Visa"The merchant customer id that created the payment method.
"User159"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.
date"2024-07-29"The time of creation
date-time"2024-07-29T15:51:28.071Z"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.
"40000000XXXX0003"{ "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", "statusReason": "CLOSED_BY_CARDHOLDER", "type": "SCHEDULED", "expiryDate": "2050-01-01", "interval": { "period": "MONTH", "frequency": 1 }, "createdAt": "2019-08-24T14:15:22Z" }, "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" }}