Fetch subscriptions list

Fetch saved subscription list of all Merchant's active clients subscriptions.

Subscription plan has to be added and saved beforehand. Within a single subscription plan, one product can be included (one plan, one product). There can be multiple plans for the same product. The plans can differ by some parameters such as trial period, fee charge day, activation fee, amount, currency, interval count or interval unit etc.

Request

Query Params

itemsPerPage

string

optional

Limit of results

Default:

Match pattern:

^[1-9][0-9]*$

page

string

optional

Page of results

Default:

Match pattern:

^[1-9][0-9]*$

direction

enum<string>

optional

Direction of order

Allowed values:

ascdesc

Default:

asc

sortBy

enum<string>

optional

column sorting

Allowed values:

idmerchantIdshopIdterminalIdcreatedAtupdatedAt

Default:

createdAt

Header Params

request-id

string

required

A unique identifier generated by requesting client

>= 38 characters<= 1024 characters

Example:

|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.

Match pattern:

^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$

Responses

🟢200OK

application/json

Body

data

array[object (Subscription) {21}]

required

deletedAt

string

optional

Match pattern:

d{4}-[01]d-[0-3]dT[0-2]d:[0-5]d:[0-5]d.d+Z?

string <uuid>

required

planId

string <uuid>

required

merchantId

string

required

shopId

string

required

terminalId

string

required

customerId

string <uuid>

required

externalId

string

optional

<= 128 characters

paymentSource

enum<string>

required

Allowed values:

PCL_PAYSAFECARD_WALLETPCL_BOACOMPRA_MULTIBANCOPCL_PBL_IDEABANKPCL_PBL_SANTANDERPCL_SOFORTPCL_BOACOMPRA_REDPAGOSPCL_PAYPALPCL_PBL_BSPCL_PAYSAFECASHPCL_TRUSTLYPCL_WECHATPCL_BITBAY_WITHDRAWALPCL_G2APAY_CARDPCL_DRAGONPCL_PBL_BSLUTUTOWPCL_PBL_ORANGEPCL_PIS_BNP_PARIBAS_PLPCL_PBL_MTRANSFERPCL_DPAY_BSPCL_APPLEPAYPCL_PBL_BSKRAKOWSKIPCL_DRAGON_EXPRESSPCL_PBL_BNPPARIBASPCL_BOACOMPRA_RAPIPAGOPCL_PBL_BOSPCL_DRAGON_STANDARDPCL_TWISTO_CZPCL_PBL_BSSZTUMPCL_PBZPCL_BOACOMPRA_BOLETOPCL_PBL_CREDITAGRICOLEPCL_BANCONTACTPCL_PBL_CITIPCL_PBL_PEKAO24PCL_PBL_INGPCL_PAYSAFECARD_PINCODEPCL_BLIKPCL_BOACOMPRA_VISAPCL_BOACOMPRA_MCPCL_PBL_SKOKPCL_PBL_EUROBANKPCL_PBL_BSRUMIAPCL_PBL_GETINPCL_PBL_NESTPCL_PBL_PLUSPCL_IDEALPCL_TWISTO_PLPCL_PIS_ALIOR_PLPCL_PBL_BSBIALARAWSKAPCL_PBL_POCZTOWYPCL_BANKTRANSFERPCL_PBL_INTELIGOPCL_NEOSURFPCL_PBL_BZWBKPCL_BOACOMPRA_PAYPALPCL_PBL_ALIORPCL_BOACOMPRA_PSEPCL_PBL_MILLENNIUMPCL_CARDPCL_PIS_PKO_PLPCL_BLIK_REDIRECTPCL_PBL_TOYOTABANKPCL_UPIPCL_BOACOMPRA_REDCOMPRAPCL_PBL_NOBLEPCL_PIS_SANTANDER_PLPCL_PBL_BSTORUNPCL_KLARNAPCL_BOACOMPRA_EFECTYPCL_PIS_MBANK_PLPCL_PBL_IPKOPCL_BOACOMPRA_PAGOFACILPCL_PBL_BS_BRODNICAPCL_PIS_ING_PLPCL_NETELLER_WALLETPCL_BOACOMPRA_PAGOEFECTIVOPCL_SKRILL_RAPIDPCL_PBL_NOWY_BFGPCL_G2APAY_IDEALPCL_PIS_MILLENIUM_PLPCL_PBL_PBSPCL_PBL_NEOBANKPCL_GOOGLEPAYPCL_GIROPAYPCL_BOACOMPRA_PIXPCL_WEBMONEYPCL_SKRILL_WALLETPCL_PBL_TMOBILEPCL_PIS_PEKAO_PL

paymentSourceId

string <uuid>

required

firstTransactionId

string <uuid>

required

startDate

string

required

Match pattern:

d{4}-[01]d-[0-3]dT[0-2]d:[0-5]d:[0-5]d.d+Z?

endDate

string

optional

Match pattern:

d{4}-[01]d-[0-3]dT[0-2]d:[0-5]d:[0-5]d.d+Z?

nextChargeDate

string

required

Match pattern:

d{4}-[01]d-[0-3]dT[0-2]d:[0-5]d:[0-5]d.d+Z?

nextChargeAttemptDate

string

optional

Match pattern:

d{4}-[01]d-[0-3]dT[0-2]d:[0-5]d:[0-5]d.d+Z?

remainingCount

number

optional

cancelReason

string

optional

status

enum<string>

required

Allowed values:

trialactivecharge_attemptcanceledcompletedpaused

string

required

createdAt

required

updatedAt

required

Meta

required

itemsPerPage

string

optional

Default:

Match pattern:

^[1-9][0-9]*$

page

string

optional

Default:

Match pattern:

^[1-9][0-9]*$

direction

enum<string>

optional

Allowed values:

ascdesc

Default:

asc

sortBy

enum<string>

optional

Allowed value:

createdAt

Default:

createdAt

Example

{
    "data": [
        {
            "deletedAt": "string",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",
            "merchantId": "string",
            "shopId": "string",
            "terminalId": "string",
            "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
            "externalId": "string",
            "paymentSource": "PCL_PAYSAFECARD_WALLET",
            "paymentSourceId": "83d09719-d931-4e04-8537-1570b69d71f4",
            "firstTransactionId": "03056aca-c5f2-4f6b-a174-27e4af663155",
            "startDate": "string",
            "endDate": "string",
            "nextChargeDate": "string",
            "nextChargeAttemptDate": "string",
            "remainingCount": 0,
            "cancelReason": "string",
            "status": "trial",
            "email": "string",
            "createdAt": "2019-08-24",
            "updatedAt": "2019-08-24"
        }
    ],
    "meta": {
        "itemsPerPage": "10",
        "page": "1",
        "direction": "asc",
        "sortBy": "createdAt"
    }
}

🟠404Not Found

Fetch subscriptions list

Request

Request samples

Responses