The Review object

Attributes

id string Unique identifier for the object.
charge nullable string Expandable The charge associated with this review.
open boolean If true, the review needs action.
payment _ intent nullable string Expandable The PaymentIntent ID associated with this review, if one exists.
reason string The reason the review is currently open or closed. One of rule, manual, approved, refunded, refunded_as_fraud, disputed, redacted, canceled, payment_never_settled, or acknowledged.

More attributes

object string, value is "review"
billing _ zip nullable string
closed _ reason nullable enum
created timestamp
ip _ address nullable string
ip _ address _ location nullable object
livemode boolean
opened _ reason enum
refund _ signals nullable object Preview feature
session nullable object

The 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}

Retrieve a review

GET / v1 / reviews /:id

Retrieves a Review object.

Parameters

No parameters.

Returns

Returns a Review object if a valid identifier was provided.

Response

{ "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

GET / v1 / 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

created object
ending _ before string
limit integer
starting _ after string

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.

Response

{ "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 } ]}