List all subscription plans

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

offsetId

string <uuid>

optional

Optional. ID of the last subscription plan in current response.

Example:

c689b77a-d47d-4d02-b037-6f49509f759b

pageSize

number

optional

Optional - default 20. Number of subscription plans to return.

<= 100> 0

Example:

status[]

array[string]

optional

Optional. By default, all subscription plans will show.

Allowed values:

activedeactivatedcancelled

Example:

["active"]

Header Params

x-merchant-id

string <uuid>

Merchant ID

optional

If acting on behalf of a merchant, you will need to specify their merchant ID.

Responses

🟢200OK

application/json

OK response

Body

offsetId

string <uuid> | null

optional

pageSize

number

required

count

number

required

data

array [object {15}]

required

string <uuid>

required

merchantId

string <uuid>

required

status

enum<string>

required

Allowed values:

activedeactivatedcancelled

deactivatedAt

string | null

required

dataCollection

array[string]

required

Allowed values:

namebusinessNamephoneNumberemailaddress

amount

object

required

frequency

enum<string>

required

Allowed values:

weeklymonthlyyearly

numberOfPayments

number | null

required

reference

string

required

description

string | null

required

link

string <uri>

required

taxes

array [object {3}]

required

returnUrl

string <uri> | null

required

createdAt

string

required

updatedAt

string

required

Examples

No offsetIdWith offsetId

{
    "pageSize": 2,
    "count": 3,
    "data": [
        {
            "id": "05d8c867-c21f-4c7d-a028-cbb04fe77ec1",
            "merchantId": "580b7a17-35c1-4936-81cd-25a4766d8885",
            "status": "active",
            "deactivatedAt": null,
            "dataCollection": [
                "name",
                "email"
            ],
            "amount": {
                "units": 1000,
                "currencyCode": "GBP"
            },
            "frequency": "weekly",
            "numberOfPayments": null,
            "reference": "PLAN#1",
            "description": "Standard Plan",
            "link": "https://lopay.app/00000/05d8c867-c21f-4c7d-a028-cbb04fe77ec1",
            "taxes": [],
            "returnUrl": null,
            "createdAt": "2025-06-02T10:59:51.708Z",
            "updatedAt": "2025-06-02T10:59:51.708Z"
        },
        {
            "id": "c9799996-f778-4eb3-9d0a-47bad3b11075",
            "merchantId": "580b7a17-35c1-4936-81cd-25a4766d8885",
            "status": "active",
            "deactivatedAt": null,
            "dataCollection": [],
            "amount": {
                "units": 100,
                "currencyCode": "GBP"
            },
            "frequency": "monthly",
            "numberOfPayments": 12,
            "reference": "Test payment",
            "description": null,
            "link": "https://lopay.app/00000/c9799996-f778-4eb3-9d0a-47bad3b11075",
            "taxes": [],
            "returnUrl": "http://google.co.uk",
            "createdAt": "2025-05-15T09:30:43.615Z",
            "updatedAt": "2025-05-15T09:30:43.787Z"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Request

Request samples

Responses