Skip to main content
GET
Get top payment customers

Authorizations

api_key
string
header
required

Personal API key.

Path Parameters

app_id
string
required

ID of the Base44 app.

Query Parameters

start_date
string<date-time> | null

Start of the window as an ISO 8601 timestamp. Send with end_date. Defaults to the period window.

end_date
string<date-time> | null

End of the window as an ISO 8601 timestamp. Send with start_date. Defaults to now when using period.

period
enum<string>
default:30d

Fallback window. Either 7d, 30d, or 90d. Defaults to 30d. Used unless both dates are supplied.

Available options:
7d,
30d,
90d
order_by
enum<string>
default:amount

Ranking metric. Either amount or transactions. Defaults to amount. Highest values come first.

Available options:
amount,
transactions
limit
integer
default:5

Maximum customers to return, from 1 through 10. Defaults to 5.

Required range: 1 <= x <= 10
currencies
string | null

Comma-separated currency codes, for example usd,eur. Defaults to no currency filter. Use one currency when comparing amounts.

Response

Successful Response

Response with top customers list.

customers
TopCustomer · object[]
required

Customers ranked by the requested metric, highest first. Empty when no matching payments are found.

Example: