Payments
List Payments
List recent payments for the merchant (default 10) or all payments for a specific customer. Includes invoice and plan context when available.
Authorization
bearerAuth AuthorizationBearer <token>
Use your secret API key as the bearer token
In: header
Query Parameters
customerId?string
When provided, returns all payments for this customer.
Match
^cus_[A-Za-z0-9]{22}$Response Body
application/json
application/json
curl -X GET "https://api.getlumen.dev/v1/payments"{
"payments": [
{
"id": "pay_7mHn2Qx9rP5aW3kD0",
"invoiceId": "inv_c9MBd7QfJH5s2r4aLvXK",
"paymentMethodId": "pm_4sD1Xk6Vn9QeZ0tL3",
"externalPaymentId": "pi_3NK6...",
"amountCents": 12900,
"currency": "USD",
"status": "succeeded",
"refundStatus": "none",
"refundedAmountCents": 0,
"customerInvoiceNumber": "LO4XGG-001",
"subscriptionId": "sub_int_mXa8QbHnC1sRf7L2gE",
"planId": "plan_int_o2V7qKfM8LxC9rTsA",
"planName": "Pro",
"createdAt": "2025-02-20T17:00:00.000Z"
}
]
}{
"error": "Failed to fetch payments"
}