Lopay Partner API
    Lopay Partner API
    • Introduction
    • Environments
    • Authentication
    • Webhooks
    • Terminal ordering
    • Reporting
    • Errors
    • Getting started
    • Payments
    • Payment Links
      • List all payment links
      • Create a new payment link
      • Get existing payment link
      • Update existing payment link
      • Revoke an existing payment link
      • Send a payment link via email and/or SMS
    • Webhook subscriptions
      • Get login link for Lopay Partner Webhook Portal
      • List webhook subscriptions
      • Remove an existing webhook subscription
      • Create webhook subscription
      • Update existing webhook subscription
    • Merchants
      • List all merchants
      • Register a new merchant
      • Connect to a merchant
      • Get merchant balance
      • Get merchant details
      • Update merchant bank details for receiving payouts.
      • Get merchant onboarding link
      • Create account session with permissions for the specified embedded components.
      • Get list of available hardware for given merchant to purchase
      • Order terminal hardware for the specified merchant.
    • 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
    • Payments
      • Get existing payment
      • Refunds a payment
    • Schemas
      • Schemas
      • PartnerPayment
      • PartnerMerchant
      • WebhookSubscription
      • Subscription
      • Invoice
      • CreateSubscriptionPlan
      • SubscriptionPlan
      • WebhookSubscriptionListItem
      • PartnerApiError
      • RegisterMerchant
      • WebhookSubscriptionNoSecret
      • WebhookPortalLink
      • CreateWebhookSubscription
      • UpdatePaymentLink
      • SendPartnerPaymentLink
      • CreatePaymentLink
      • PaymentLink
      • PartnerMerchantBalanceBreakdown
      • RefundPartnerPayment

    SubscriptionPlan

    {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
        "status": "active",
        "deactivatedAt": "string",
        "dataCollection": [
            "name"
        ],
        "amount": {
            "units": 0,
            "currencyCode": "GBP"
        },
        "frequency": "weekly",
        "numberOfPayments": 0,
        "reference": "string",
        "description": "string",
        "link": "http://example.com",
        "taxes": [
            {
                "name": "string",
                "inclusive": true,
                "amount": {
                    "units": 0,
                    "currencyCode": "GBP"
                }
            }
        ],
        "returnUrl": "http://example.com",
        "createdAt": "string",
        "updatedAt": "string"
    }
    Built with