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

List Subscriptions

OpenAPI Spec

Test this endpoint live

Open the same request directly in API Explorer.

Open in API Explorer

Server URL

GET
/public/api/v1/subscriptions

Retrieve a paginated list of subscriptions. Query parameters page and perPage can be used to control pagination, and the available filters can be combined to narrow the results.

When running import scripts against this endpoint, we strongly recommend setting a fixed createdBefore filter to avoid missing data caused by new subscriptions created on the account during the import.

Authorization

BearerAuth
headerAuthorizationBearer <token>

Query Parameters

pageinteger

Page number.

Default:
1
perPageinteger

Number of items per page.

Range:
value <= 500
Default:
25
createdBeforestring

Only include subscriptions created at or before this timestamp (inclusive).

Format:
date-time
Example:
"2026-04-01T15:04:05Z"
createdAfterstring

Only include subscriptions created at or after this timestamp (inclusive).

Format:
date-time
Example:
"2026-04-01T00:00:00Z"
customerIdstring

Only include subscriptions associated with the provided customer id.

Authenticated customer IDs only

Use the authenticated customer's unique, stable customerId. Shared guest IDs can let customers use another person's stored cards; guest is explicitly blocked. For guest checkout, omit customerId or set it to null.

Example:
"User159"
referencestring

Only include subscriptions that match the provided reference string exactly.

Example:
"subscription-1"
currencystring

Only include subscriptions with the provided ISO 4217 currency code.

Example:
"DKK"
statestring

Only include subscriptions with the provided subscription state.

Example:
"ACTIVE"
Value in:
  • "PENDING"
  • "ACTIVE"
  • "INVALID"
  • "DISABLED"
paymentMethodIdstring

Only include subscriptions associated with the provided payment method id.

Format:
uuid
Example:
"019ad8a2-18c6-7a72-bf20-2768be84eb42"
pointOfSaleIdstring

Only include subscriptions created for the provided point of sale id.

Format:
uuid
Example:
"019ad8a2-18c6-7a72-bf20-2768be84eb42"
typestring

Only include subscriptions with the provided subscription type.

Example:
"SCHEDULED"
Value in:
  • "SCHEDULED"
  • "UNSCHEDULED"

Response Body

application/json

application/json

application/json

application/json

curl -X GET 'https://payments.epay.eu/public/api/v1/subscriptions'
{  "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",        "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",        "accountUpdatesEnabled": false      }    }  ]}