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
    • 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
      POST
    • List all subscription plans
      GET
    • Get existing subscription plan
      GET
  • Subscriptions
    • Get existing subscription
  1. Subscription Plans

Create a new subscription plan

Production Environment
https://api.lopay.com
Production Environment
https://api.lopay.com
POST
/api/1/partner/subscription-plan
Subscription Plans
Creates a new subscription plan against the specified merchant.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
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.
Body Params application/json
description
string  | null 
optional
reference
string 
required
amount
object 
required
units
integer 
required
currencyCode
enum<string> 
required
Allowed values:
GBPUSDEURDKK
frequency
enum<string> 
required
Allowed values:
weeklymonthlyyearly
numberOfPayments
number  | null 
optional
dataCollection
array[string]
required
Allowed values:
namebusinessNamephoneNumberemailaddress
taxes
array [object {3}] 
required
name
string 
required
inclusive
boolean 
required
rate
string 
required
returnUrl
string <uri> | null 
optional
Optional. The URL that the payee is redirected to after completing a payment.
Examples
{
    "description": "Standard Plan",
    "reference": "PLAN#1",
    "amount": {
        "units": 1000,
        "currencyCode": "GBP"
    },
    "frequency": "weekly",
    "dataCollection": [
        "name",
        "email"
    ],
    "taxes": [
        {
            "name": "VAT (20%)",
            "inclusive": true,
            "rate": "20.0"
        }
    ]
}

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
curl --location --request POST 'https://api.lopay.com/api/1/partner/subscription-plan' \
--header 'x-merchant-id;' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "description": "Standard Plan",
    "reference": "PLAN#1",
    "amount": {
        "units": 1000,
        "currencyCode": "GBP"
    },
    "frequency": "weekly",
    "dataCollection": [
        "name",
        "email"
    ],
    "taxes": [
        {
            "name": "VAT (20%)",
            "inclusive": true,
            "rate": "20.0"
        }
    ]
}'

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": "bb9dd3d7-a832-40c0-842e-cb54e238225e",
    "amount": {
        "units": 1000,
        "currencyCode": "GBP"
    },
    "frequency": "weekly",
    "link": "https://lopay.app/00000/bb9dd3d7-a832-40c0-842e-cb54e238225e",
    "reference": "PLAN#1",
    "description": "Standard Plan",
    "status": "active",
    "dataCollection": [
        "name",
        "email"
    ],
    "taxes": [
        {
            "name": "VAT (20%)",
            "inclusive": true,
            "rate": "20.0",
            "amount": {
                "units": 200,
                "currencyCode": "GBP"
            }
        }
    ],
    "returnUrl": null,
    "createdAt": "2025-06-04T15:49:48.916Z",
    "updatedAt": "2025-06-04T15:49:48.916Z"
}
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🔴500Server Error
Modified at 2025-06-04 16:00:26
Previous
Temporarily store customer details
Next
List all subscription plans
Built with