Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Retrieve a review

Retrieves a Review object.

get/v1/reviews/{review}

Path parameters

reviewstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

billing_zipstring nullable

The ZIP or postal code of the card used, if applicable.

closed_reason'acknowledged' | 'approved' | 'canceled' | 'disputed' | 'payment_never_settled' | 'redacted' | 'refunded' | 'refunded_as_fraud' nullable

The reason the review was closed, or null if it has not yet been closed. One of approved, refunded, refunded_as_fraud, disputed, redacted, canceled, payment_never_settled, or acknowledged.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

idstring required

Unique identifier for the object.

ip_addressstring nullable

The IP address where the payment originated.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'review' required

String representing the object's type. Objects of the same type share the same value.

openboolean required

If true, the review needs action.

opened_reason'manual' | 'rule' required

The reason the review was opened. One of rule or manual.

reasonstring required

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.