ApiPayment links
Create a new payment link (creates real LNURL-pay link on LNbits)
POST
bearerX-API-Version?stringAPI version for header-based versioning
Default
"1"Value in
"1""2"application/json- body
description*stringPayment link description
type*stringPayment type
Value in
"fixed""flexible"amount?numberFixed amount in satoshis (required if type is fixed)
minAmount?numberMinimum amount in satoshis (if type is flexible)
maxAmount?numberMaximum amount in satoshis (if type is flexible)
collectEmail*booleanCollect customer email
Default
falsecollectName*booleanCollect customer name
Default
falseexpiresAt?stringExpiration date (ISO 8601)
projectId?stringAssociated project ID (optional for quick links)
providerId?stringProvider ID to use for payments (optional - falls back to default/platform)
isQuickLink?booleanWhether this is a quick link (personal use, no project)
Default
falsecommentChars?numberAllow comments on the payment page (max comment chars)
Payment link created successfully
curl -X POST 'http://localhost:3001/api/v1/payment-links' \ -H 'Content-Type: application/json' \ -d '{ "description": "Premium Subscription - Monthly", "type": "fixed", "collectEmail": false, "collectName": false}'Example Response201
Empty