Lopay Partner API
  1. Subscriptions
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
    • Create webhook subscription
      POST
    • Update existing webhook subscription
      PUT
    • Remove an existing webhook subscription
      DELETE
  • Merchants
    • List all merchants
      GET
    • Register a new 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
    • List all subscription plans
    • Get existing subscription plan
  • Subscriptions
    • Get existing subscription
      GET
  1. Subscriptions

Get existing subscription

Production Environment
https://api.lopay.com
Production Environment
https://api.lopay.com
GET
/api/1/partner/subscription/{id}
Subscriptions

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Path Params
id
string <uuid>
required
Subscription 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
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.lopay.com/api/1/partner/subscription/' \
--header 'x-merchant-id;' \
--header 'x-api-key;'

Responses

🟢200OK
application/json
OK response
Body
id
string <uuid>
required
subscriptionPlanId
string <uuid>
required
status
enum<string> 
required
Allowed values:
activecancelledpendingcompleted
reference
string  | null 
required
customerData
array [object {2}] 
required
type
enum<string> 
required
Allowed values:
namebusinessNamephoneNumberemailaddressLine1addressLine2addressTownaddressStateaddressPostCode
value
string 
required
link
string <uri>
required
latestInvoice
object  | null 
required
id
string <uuid>
required
subscriptionId
string <uuid> | null 
required
status
enum<string> 
required
Allowed values:
paidoutstanding
invoiceDate
string 
required
total
object 
required
taxes
array [object {3}] 
required
payment
object  | null 
required
latestPaymentAttempt
string  | null 
required
createdAt
string 
required
updatedAt
string 
required
cancelledAt
string  | null 
required
createdAt
string 
required
updatedAt
string 
required
Examples
{
    "id": "04033961-7c2d-4c3c-99f5-d1746c73ddb0",
    "subscriptionPlanId": "c9799996-f778-4eb3-9d0a-47bad3b11075",
    "status": "active",
    "reference": null,
    "customerData": [
        {
            "type": "name",
            "value": "John Smith"
        },
        {
            "type": "email",
            "value": "johnsmith@example.com"
        }
    ],
    "link": "https://lopay.app/00000/04033961-7c2d-4c3c-99f5-d1746c73ddb0",
    "latestInvoice": {
        "id": "79437e39-2576-4daa-9a2b-3e02dacb707c",
        "subscriptionId": "04033961-7c2d-4c3c-99f5-d1746c73ddb0",
        "status": "paid",
        "invoiceDate": "2025-05-14T23:00:00.000Z",
        "total": {
            "units": 100,
            "currencyCode": "GBP"
        },
        "taxes": [],
        "payment": {
            "id": "12bd0d11-fd9a-42cd-9c97-7f8744305b65",
            "type": "card",
            "cardDetails": {
                "country": "US",
                "lastFour": "4242",
                "type": "visa"
            },
            "taxes": [],
            "tip": {
                "units": 0,
                "currencyCode": "GBP"
            },
            "subtotal": {
                "units": 100,
                "currencyCode": "GBP"
            },
            "total": {
                "units": 100,
                "currencyCode": "GBP"
            },
            "createdAt": "2025-05-15T10:35:11.146Z",
            "updatedAt": "2025-05-15T10:35:11.146Z"
        },
        "latestPaymentAttempt": "2025-05-15T09:35:06.627Z",
        "createdAt": "2025-05-15T09:35:05.317Z",
        "updatedAt": "2025-05-15T09:35:14.360Z"
    },
    "cancelledAt": null,
    "createdAt": "2025-05-15T09:35:05.314Z",
    "updatedAt": "2025-05-15T09:35:14.319Z"
}
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Modified at 2025-06-04 16:00:26
Previous
Get existing subscription plan
Built with