Skip to main content
GET
/
api
/
v1
/
businesses
/
{businessId}
/
stripe
/
payments
Error
A valid request URL is required to generate request examples
{}

Authorizations

​
Authorization
string
header
required

API key prefixed with sk-ak-. Pass as Authorization: Bearer sk-ak-...

Path Parameters

​
businessId
string<uuid>
required

The business ID

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
​
from
string<date-time>

Start date (ISO 8601)

​
to
string<date-time>

End date (ISO 8601)

​
status
string

Filter by payment status (e.g., succeeded, failed, refunded)

​
isRecurring
enum<string>

Filter recurring (subscription) payments only

Available options:
true,
false
​
stripeCustomerId
string

Filter by Stripe customer ID

​
productId
string

Filter by product ID

​
sort
enum<string>
default:-paymentDate

Sort field (prefix with - for descending)

Available options:
paymentDate,
-paymentDate,
amount,
-amount

Response

Paginated list of payments

The response is of type object.