Returns a list of Review
objects that have open
set to true
. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
No parameters.
More parameters
- createdobject
Only return reviews that were created during the given date interval.
- created.
gtinteger Minimum value to filter by (exclusive)
- created.
gteinteger Minimum value to filter by (inclusive)
- created.
ltinteger Maximum value to filter by (exclusive)
- created.
lteinteger Maximum value to filter by (inclusive)
- ending_
beforestring A cursor for use in pagination.
ending_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting withbefore obj_
, your subsequent call can includebar ending_
in order to fetch the previous page of the list.before=obj_ bar - limitinteger
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- starting_
afterstring A cursor for use in pagination.
starting_
is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending withafter obj_
, your subsequent call can includefoo starting_
in order to fetch the next page of the list.after=obj_ foo
Returns
A dictionary with a data
property that contains an array of up to limit
reviews, starting after review starting_
. Each entry in the array is a separate Review
object. If no more reviews are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/reviews", "has_more": false, "data": [ { "id": "prv_1NVyFt2eZvKYlo2CjubqF1xm", "object": "review", "billing_zip": null, "charge": null, "closed_reason": null, "created": 1689864901, "ip_address": null, "ip_address_location": null, "livemode": false, "open": true, "opened_reason": "rule", "payment_intent": "pi_3NVy8c2eZvKYlo2C055h7pkd", "reason": "rule", "session": null } ]}