Lopay Partner API
  1. Subscription Plans
Lopay Partner API
  • Introduction
  • Environments
  • Authentication
  • Webhooks
  • Terminal ordering
  • Reporting
  • Errors
  • Getting started
  • Payment Links
    • List all payment links
      GET
    • Create a new payment link
      POST
    • Get existing payment link
      GET
    • Update existing payment link
      PATCH
    • Revoke an existing payment link
      DELETE
    • Send a payment link via email and/or SMS
      POST
  • Webhook subscriptions
    • Get login link for Lopay Partner Webhook Portal
      GET
    • List webhook subscriptions
      GET
    • Remove an existing webhook subscription
      DELETE
    • Create webhook subscription
      POST
    • Update existing webhook subscription
      PUT
  • Merchants
    • List all merchants
      GET
    • Register a new merchant
      POST
    • Connect to a merchant
      POST
    • Get merchant details
      GET
    • Update merchant bank details for receiving payouts.
      PUT
    • Get merchant onboarding link
      GET
    • Create account session with permissions for the specified embedded components.
      POST
    • Get list of available hardware for given merchant to purchase
      GET
    • Order terminal hardware for the specified merchant.
      POST
  • Marketing Deeplinks
    • List all affiliate marketing deeplinks.
    • Create a new affiliate marketing deeplink.
  • Reports
    • List all statement activity
  • Customers
    • Temporarily store customer details
  • Subscription Plans
    • Create a new subscription plan
      POST
    • List all subscription plans
      GET
    • Get existing subscription plan
      GET
  • Subscriptions
    • Get existing subscription
  1. Subscription Plans

List all subscription plans

Production Environment
https://api.lopay.com
Production Environment
https://api.lopay.com
GET
/api/1/partner/subscription-plan

Request

Authorization
or
Query Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.lopay.com/api/1/partner/subscription-plan'

Responses

🟢200OK
application/json
OK response
Body

Examples
{
    "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
Modified at 2025-07-22 09:23:17
Previous
Create a new subscription plan
Next
Get existing subscription plan
Built with