Schema2020-08-27object

review

Reviews can be used to supplement automated fraud detection with human expertise. Learn more about [Radar](/radar) and reviewing payments [here](https://stripe.com/docs/radar/reviews).

Source: openapi/spec3.json
Commit: d70de345383d
Active snapshot: da69df7e6e11

RadarReview

object

Reviews can be used to supplement automated fraud detection with human expertise. Learn more about [Radar](/radar) and reviewing payments [here](https://stripe.com/docs/radar/reviews).

billing_zip string

optionalnullable

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

maxLength:5000

charge

optionalnullable

The charge associated with this review.

closed_reason string

optionalnullable

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

Allowed: "approved""disputed""redacted""refunded""refunded_as_fraud"

created integer (unix-time)

required

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

id string

required

Unique identifier for the object.

maxLength:5000

ip_address string

optionalnullable

The IP address where the payment originated.

maxLength:5000

ip_address_location

optionalnullable

Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.

livemode boolean

required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

object string

required

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

Allowed: "review"

open boolean

required

If `true`, the review needs action.

opened_reason string

required

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

Allowed: "manual""rule"

payment_intent

optional

The PaymentIntent ID associated with this review, if one exists.

reason string

required

The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`.

maxLength:5000

session

optionalnullable

Information related to the browsing session of the user who initiated the payment.

Root JSON Schema

{"description":"Reviews can be used to supplement automated fraud detection with human expertise.\n\nLearn more about [Radar](/radar) and reviewing payments\n[here](https://stripe.com/docs/radar/reviews).","properties":{"billing_zip":{"description":"The ZIP or postal code of the card used, if applicable.","maxLength":5000,"nullable":true,"type":"string"},"charge":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/charge"}],"description":"The charge associated with this review.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/charge"}]}},"closed_reason":{"description":"The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`.","enum":["approved","disputed","redacted","refunded","refunded_as_fraud"],"nullable":true,"type":"string"},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"ip_address":{"description":"The IP address where the payment originated.","maxLength":5000,"nullable":true,"type":"string"},"ip_address_location":{"anyOf":[{"$ref":"#/components/schemas/radar_review_resource_location"}],"description":"Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.","nullable":true},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["review"],"type":"string"},"open":{"description":"If `true`, the review needs action.","type":"boolean"},"opened_reason":{"description":"The reason the review was opened. One of `rule` or `manual`.","enum":["manual","rule"],"type":"string"},"payment_intent":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/payment_intent"}],"description":"The PaymentIntent ID associated with this review, if one exists.","x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/payment_intent"}]}},"reason":{"description":"The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`.","maxLength":5000,"type":"string"},"session":{"anyOf":[{"$ref":"#/components/schemas/radar_review_resource_session"}],"description":"Information related to the browsing session of the user who initiated the payment.","nullable":true}},"required":["created","id","livemode","object","open","opened_reason","reason"],"title":"RadarReview","type":"object","x-expandableFields":["charge","ip_address_location","payment_intent","session"],"x-resourceId":"review"}