Reviews
Reviews can be used to supplement automated fraud detection with human expertise.
The Review object
Attributes
- idstring
Unique identifier for the object.
- chargenullable stringExpandable
The charge associated with this review.
- openboolean
If
true
, the review needs action. - payment_
intentnullable stringExpandable The PaymentIntent ID associated with this review, if one exists.
- reasonstring
The reason the review is currently open or closed. One of
rule
,manual
,approved
,refunded
,refunded_as_fraud
,disputed
, orredacted
.
More attributes
- objectstring
- billing_
zipnullable string - closed_
reasonnullable enum - createdtimestamp
- ip_
addressnullable string - ip_
address_ locationnullable hash - livemodeboolean
- opened_
reasonenum - sessionnullable hash
{
"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
}
Retrieve a review
Retrieves a Review
object.
Parameters
No parameters.
Returns
Returns a Review
object if a valid identifier was provided.
{
"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
}
List all open reviews
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
- createdhash
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of up to limit
reviews, starting after review starting_after
. 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
}
{...}
{...}
],
}
Approve a review
Approves a Review
object, closing it and removing it from the list of reviews.
Parameters
No parameters.
Returns
Returns the approved Review
object.
{
"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
}