Skip to main content
GET
List payments

Overview

Retrieve a paginated list of payments with optional filtering and sorting. Payments represent scheduled or completed billing transactions for subscriptions—they track when payments are due, their status, and when they were collected.

Payment Lifecycle

Common Use Cases

Accounts Receivable

Track pending payments and outstanding balances

Collection Dashboard

Monitor failed payments that need attention

Cash Flow Forecasting

Project upcoming revenue from scheduled payments

Customer Billing History

View payment history for specific customers

Filtering Payments

Response Fields

Key fields in each payment object:

Example: Get Outstanding Balance

Example: Upcoming Revenue Forecast

Authorizations

Authorization
string
header
required

API key obtained from FlexPortal dashboard

Headers

Tenant-ID
string
required

Your tenant identifier

Query Parameters

limit
string

Items per page (default: 50, max: 100)

startAfter
string

Cursor for pagination

status
string

Filter by status (pending, processing, paid, failed, cancelled)

customerId
string

Filter by customer ID

rentalId
string

Filter by rental ID

billingGroupId
string

Filter by billing group ID

dueDateFrom
string

Filter by due date from (ISO 8601)

dueDateTo
string

Filter by due date to (ISO 8601)

Response

200 - application/json

List of payments

success
enum<boolean>
required
Available options:
true
payments
object[]
required
count
number
required
hasMore
boolean
required
nextCursor
string | null
required