Create a new subscription plan

Production Environment

https://api.lopay.com

POST

/api/1/partner/subscription-plan

Creates a new subscription plan against the specified merchant.

Request

Authorization

Header Params

Body Params application/json

Examples

Create a subscription plan with VAT 20%Create fixed term subscription plan with specified redirect

{
    "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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Create a subscription plan with VAT 20%Create fixed term subscription plan with specified redirect

curl --location --request POST 'https://api.lopay.com/api/1/partner/subscription-plan' \
--header 'x-merchant-id;' \
--header 'Content-Type: application/json' \
--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

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-07-21T08:33:07.044Z",
    "updatedAt": "2025-07-21T08:33:07.044Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Modified at 2025-07-22 09:23:17

Temporarily store customer details

List all subscription plans