Get existing subscription plan

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Path Params

id

string <uuid>

required

Subscription plan ID (UUID)

Header Params

x-merchant-id

string <uuid>

Merchant ID

required

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

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.lopay.com/api/1/partner/subscription-plan/' \
--header 'x-merchant-id;' \
--header 'x-api-key;'

Responses

🟢200OK

application/json

OK response

Body

id

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

units

integer

required

currencyCode

enum<string>

required

Allowed values:

GBPUSDEURDKK

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

name

string

required

inclusive

boolean

required

amount

object

required

returnUrl

string <uri> | null

required

createdAt

string

required

updatedAt

string

required

Example

{
    "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"
}

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error