Stripe: Retrieve a review

← Reviews operations · Get started

Operation stripe.getreviewsreview

Provider route: GET /v1/reviews/{review}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["reviews"]["getReviewsReview"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.reviews.getReviewsReview(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.reviews.get_reviews_review(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.review	string	Required within parent	Maximum length: 5000
query	object	Optional	Additional keys: not allowed
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Approve a review — response body

Referenced models: Approve a review — response body

Schemas

703 more schemas are linked from the tables above, on the schema pages.

Approve a review — response body

Field	Type	Presence	Description and constraints
$	object	Root	Reviews can be used to supplement automated fraud detection with human expertise. Learn more about [Radar](/radar) and reviewing payments [here](https://docs.stripe.com/radar/reviews).
billing_zip	JSON	Optional
billing_zip (anyOf 1)	string	Alternative	The ZIP or postal code of the card used, if applicable. Maximum length: 5000
billing_zip (anyOf 2)	null	Alternative
charge	JSON	Optional
charge (anyOf 1)	JSON	Alternative	The charge associated with this review.
charge (anyOf 1) (anyOf 1)	string	Alternative	Maximum length: 5000
charge (anyOf 1) (anyOf 2)	Model	Alternative	Expand Create a charge — response body
charge (anyOf 2)	null	Alternative
closed_reason	JSON	Optional
closed_reason (anyOf 1)	string	Alternative	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`. Known values: acknowledged, approved, canceled, disputed, payment_never_settled, redacted, refunded, refunded_as_fraud
closed_reason (anyOf 2)	null	Alternative
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
ip_address	JSON	Optional
ip_address (anyOf 1)	string	Alternative	The IP address where the payment originated. Maximum length: 5000
ip_address (anyOf 2)	null	Alternative
ip_address_location	JSON	Optional
ip_address_location (anyOf 1)	JSON	Alternative	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.
ip_address_location (anyOf 1) (anyOf 1)	Model	Alternative	Expand Approve a review — response body — ip address location value city, country, latitude, longitude, region
ip_address_location (anyOf 2)	null	Alternative
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: review
open	boolean	Required within parent	If `true`, the review needs action.
opened_reason	string	Required within parent	The reason the review was opened. One of `rule` or `manual`. Known values: manual, rule
payment_intent	JSON	Optional	The PaymentIntent ID associated with this review, if one exists.
payment_intent (anyOf 1)	string	Alternative	Maximum length: 5000
payment_intent (anyOf 2)	Model	Alternative	Expand Cancel a Payment Intent — response body
reason	string	Required within parent	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`. Maximum length: 5000
session	JSON	Optional
session (anyOf 1)	JSON	Alternative	Information related to the browsing session of the user who initiated the payment.
session (anyOf 1) (anyOf 1)	Model	Alternative	Expand Approve a review — response body — session value browser, device, platform, version
session (anyOf 2)	null	Alternative

Referenced models: Create a charge — response body, Cancel a Payment Intent — response body, Approve a review — response body — ip address location value city, country, latitude, longitude, region, Approve a review — response body — session value browser, device, platform, version

Approve a review — response body — ip address location value city, country, latitude, longitude, region

Field	Type	Presence	Description and constraints
$	object	Root
city	JSON	Optional
city (anyOf 1)	string	Alternative	The city where the payment originated. Maximum length: 5000
city (anyOf 2)	null	Alternative
country	JSON	Optional
country (anyOf 1)	string	Alternative	Two-letter ISO code representing the country where the payment originated. Maximum length: 5000
country (anyOf 2)	null	Alternative
latitude	JSON	Optional
latitude (anyOf 1)	JSON	Alternative
latitude (anyOf 1) (anyOf 1)	number	Alternative	The geographic latitude where the payment originated.
latitude (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
latitude (anyOf 2)	null	Alternative
longitude	JSON	Optional
longitude (anyOf 1)	JSON	Alternative
longitude (anyOf 1) (anyOf 1)	number	Alternative	The geographic longitude where the payment originated.
longitude (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
longitude (anyOf 2)	null	Alternative
region	JSON	Optional
region (anyOf 1)	string	Alternative	The state/county/province/region where the payment originated. Maximum length: 5000
region (anyOf 2)	null	Alternative

Approve a review — response body — session value browser, device, platform, version

Field	Type	Presence	Description and constraints
$	object	Root
browser	JSON	Optional
browser (anyOf 1)	string	Alternative	The browser used in this browser session (e.g., `Chrome`). Maximum length: 5000
browser (anyOf 2)	null	Alternative
device	JSON	Optional
device (anyOf 1)	string	Alternative	Information about the device used for the browser session (e.g., `Samsung SM-G930T`). Maximum length: 5000
device (anyOf 2)	null	Alternative
platform	JSON	Optional
platform (anyOf 1)	string	Alternative	The platform for the browser session (e.g., `Macintosh`). Maximum length: 5000
platform (anyOf 2)	null	Alternative
version	JSON	Optional
version (anyOf 1)	string	Alternative	The version for the browser session (e.g., `61.0.3163.100`). Maximum length: 5000
version (anyOf 2)	null	Alternative

PostApplicationFeesIdRefund — response body — application / object: application

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the application. Maximum length: 5000
name (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: application

Create a charge — response body — billing details

Field	Type	Presence	Description and constraints
$	object	Root
address	JSON	Optional
address (anyOf 1)	JSON	Alternative	Billing address.
address (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a Location — response body — address
address (anyOf 2)	null	Alternative
email	JSON	Optional
email (anyOf 1)	string	Alternative	Email address. Maximum length: 5000
email (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	Full name. Maximum length: 5000
name (anyOf 2)	null	Alternative
phone	JSON	Optional
phone (anyOf 1)	string	Alternative	Billing phone number (including extension). Maximum length: 5000
phone (anyOf 2)	null	Alternative
tax_id	JSON	Optional
tax_id (anyOf 1)	string	Alternative	Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers. Maximum length: 5000
tax_id (anyOf 2)	null	Alternative

Referenced models: Create a Location — response body — address

Create a charge — response body — fraud details Information on fraud assessments for the charge stripe report, user report

Field	Type	Presence	Description and constraints
$	object	Root
stripe_report	string	Optional	Assessments from Stripe. If set, the value is `fraudulent`. Maximum length: 5000
user_report	string	Optional	Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. Maximum length: 5000

Policy, approvals and errors

SDK function policy ID: stripe.getreviewsreview. Catalog operation: GetReviewsReview. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source