Looking for ePay classic docs? Go to docs.epay.dk
ePay documentationDocsePay documentation

GetSubscriptionResponse

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
Match:
^[A-Z]{3}$
Example:
"DKK"
customerIdstring

The id of the merchant customer

Example:
"User159"
pointOfSaleIdstring
Format:
uuid
Example:
"0192473a-e381-705c-b61c-fc2ac9624afc"
referencestring
Nullable

The merchant reference for the subscription.

Example:
"reference-1"
descriptionstring
Nullable
statestring
Possible values:
"PENDING""ACTIVE""INVALID""DISABLED"
Example:
"ACTIVE"
typestring
Possible values:
"SCHEDULED""UNSCHEDULED"
Example:
"SCHEDULED"
expiryDatestring
Nullable
Format:
date
Example:
"2050-01-01"
createdAtstring

The time of creation

Format:
date-time
idstring

The ID of the payment method

Format:
uuid
Example:
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
typePaymentMethodType

The type of the payment method.

Possible values:
"CARD""VIPPS_MOBILEPAY""MOBILEPAY_ONLINE""APPLE_PAY""GOOGLE_PAY""SWISH""VIABILL""ANYDAY""KLARNA"
Example:
"CARD"
subTypestring
Nullable
Possible values:
"Visa""Mastercard""Maestro""Dankort""VisaDankort""Discover""UnionPay""Electron""Amex""JCB"
Example:
"Visa"
customerIdstring
Nullable

The merchant customer id that created the payment method.

Example:
"User159"
expirystring
Nullable
Format:
date
Example:
"2024-07-29"
createdAtstring

The time of creation

Format:
date-time
Example:
"2024-07-29T15:51:28.071Z"
displayTextstring
Example:
"40000000XXXX0003"
GetSubscriptionResponse
{  "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"  },  "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"  }}