Reviews

Reviews can be used to supplement automated fraud detection with human expertise.

Learn more about Radar and reviewing payments here.

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, or redacted.

More attributes

  • objectstring

  • billing_zipnullable string

  • closed_reasonnullable enum

  • createdtimestamp

  • ip_addressnullable string

  • ip_address_locationnullable map

  • livemodeboolean

  • opened_reasonenum

  • sessionnullable map

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

Retrieves a Review object.

Parameters

No parameters.

Returns

Returns a Review object if a valid identifier was provided.

GET /v1/reviews/:id
stripe.Key = "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc"
params := &stripe.ReviewParams{};
result, err := review.Get("prv_1NVyFt2eZvKYlo2CjubqF1xm", params);
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

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

  • createdmap

  • 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.

GET /v1/reviews
stripe.Key = "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc"
params := &stripe.ReviewListParams{};
params.Limit = stripe.Int64(3)
result := review.List(params);
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
}
{...}
{...}
],
}

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.

POST /v1/reviews/:id/approve
stripe.Key = "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc"
params := &stripe.ReviewApproveParams{};
result, err := review.Approve("prv_1NVyFt2eZvKYlo2CjubqF1xm", params);
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
}
Stripe Shell
Test mode
Welcome to the Stripe Shell! Stripe Shell is a browser-based shell with the Stripe CLI pre-installed. Log in to your Stripe account and press Control + Backtick (`) on your keyboard to start managing your Stripe resources in test mode. - View supported Stripe commands: - Find webhook events: - Listen for webhook events: - Call Stripe APIs: stripe [api resource] [operation] (e.g., )
The Stripe Shell is best experienced on desktop.
$