Skip to main content
GET
List Reviews

Authorizations

Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

open
boolean | null

Filter by review state. true returns only open reviews, false returns only closed. Omit to return both.

charge_id
string | null

Filter to reviews on a specific charge.

Example:

"fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

payment_intent_id
string | null

Filter to reviews on a specific payment intent.

Example:

"fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

client_reference_id
string | null

Filter by client_reference_id (matches your own identifier on the underlying checkout session, when present).

starting_after
string | null

Cursor for forward pagination — review id from a previous page.

Example:

"frv_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

ending_before
string | null

Cursor for backward pagination.

Example:

"frv_01J9XR8M3K7VZ8N2YB4WJ6T0RA"

limit
integer<int32> | null

Page size, between 1 and 100. Default 20.

Required range: 1 <= x <= 100
Example:

10

Response

An envelope wrapping a list of review objects.

An envelope wrapping a list of review objects.

reviews
object[]
required

The list of reviews.