Sample - Stripe API
POST/v1/reviews/{review}/approve

Approve a review

Approves an open review, closes it, and removes it from the list of reviews. Provide review to identify the review and use the optional expand field to include additional response fields.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
reviewstringrequired
The identifier of the review to approve, up to 5000 characters.

Optional form-encoded review approval parameters.

expandarray<string>optional
Specifies which fields in the response should be expanded.

2 status codes
200Returns the approved review object with its updated closed state and closure reason.
billing_zipstringoptional
The ZIP or postal code of the card used, if applicable.
chargestringoptional
The charge associated with this review.
closed_reasonstringoptional
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`.
Allowed:acknowledgedapprovedcanceleddisputedpayment_never_settledredactedrefundedrefunded_as_fraud
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
idstringrequired
Unique identifier for the object.
ip_addressstringoptional
The IP address where the payment originated.
ip_address_locationobjectoptional
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.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:review
openbooleanrequired
If `true`, the review needs action.
opened_reasonstringrequired
The reason the review was opened. One of `rule` or `manual`.
Allowed:manualrule
payment_intentstringoptional
The PaymentIntent ID associated with this review, if one exists.
reasonstringrequired
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`.
sessionobjectoptional
Information related to the browsing session of the user who initiated the payment.
defaultError response.
errorobjectrequired

Error handling

review must identify the review to approve and can be at most 5000 characters. expand values must be strings no longer than 5000 characters.