Stripe · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Stripe Radar API
12 actions
12 updates
phrasing
extends
openapi/stripe-radar-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Stripe's API. It is a proposal applied on top of the contract, not a document Stripe publishes.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/v1/radar/early_fraud_warnings'].get
$.paths['/v1/radar/early_fraud_warnings/{early_fraud_warning}'].get
$.paths['/v1/radar/value_list_items'].get
$.paths['/v1/radar/value_list_items'].post
$.paths['/v1/radar/value_list_items/{item}'].get
$.paths['/v1/radar/value_list_items/{item}'].delete
$.paths['/v1/radar/value_lists'].get
$.paths['/v1/radar/value_lists'].post
$.paths['/v1/radar/value_lists/{value_list}'].get
$.paths['/v1/radar/value_lists/{value_list}'].post
$.paths['/v1/radar/value_lists/{value_list}'].delete
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Stripe Radar API
version: 1.0.0
extends: openapi/stripe-radar-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 11
- target: $.paths['/v1/radar/early_fraud_warnings'].get
update:
x-apievangelist-phrasing:
intent: List early fraud warnings
effect: read
questions:
- How do I see which payments card issuers have flagged as likely fraud?
- Can I check whether a specific charge or PaymentIntent got an early fraud warning?
instructions:
- text: List my early fraud warnings.
- text: Show early fraud warnings for charge {charge}.
slots:
charge: query.charge
- text: Show early fraud warnings for PaymentIntent {payment_intent}.
slots:
payment_intent: query.payment_intent
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/radar/early_fraud_warnings/{early_fraud_warning}'].get
update:
x-apievangelist-phrasing:
intent: Look up an early fraud warning
effect: read
questions:
- How do I see the details of one early fraud warning?
- What fraud type did the issuer report on a particular warning?
instructions:
- text: Get early fraud warning {early_fraud_warning}.
slots:
early_fraud_warning: path.early_fraud_warning
- text: Show me fraud warning {early_fraud_warning}.
slots:
early_fraud_warning: path.early_fraud_warning
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/radar/value_list_items'].get
update:
x-apievangelist-phrasing:
intent: List entries in a fraud value list
effect: read
questions:
- How do I see every email, card or IP on one of my block or allow lists?
- Can I check whether a specific value is already on a list?
instructions:
- text: List the items in value list {value_list}.
slots:
value_list: query.value_list
- text: Check whether {value} is in value list {value_list}.
slots:
value: query.value
value_list: query.value_list
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/radar/value_list_items'].post
update:
x-apievangelist-phrasing:
intent: Add an entry to a fraud value list
effect: write
questions:
- How do I block a suspicious email address or card fingerprint?
- How do I add a trusted customer to an allow list used by my fraud rules?
instructions:
- text: Add {value} to value list {value_list}.
slots:
value: requestBody.value
value_list: requestBody.value_list
- text: Block {value} by adding it to list {value_list}.
slots:
value: requestBody.value
value_list: requestBody.value_list
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/radar/value_list_items/{item}'].get
update:
x-apievangelist-phrasing:
intent: Look up a fraud value list entry
effect: read
questions:
- How do I see the details of a single entry on a block or allow list?
- When was a particular value added to my fraud list?
instructions:
- text: Get value list item {item}.
slots:
item: path.item
- text: Show me list entry {item}.
slots:
item: path.item
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/radar/value_list_items/{item}'].delete
update:
x-apievangelist-phrasing:
intent: Remove an entry from a fraud value list
effect: destructive
questions:
- How do I unblock a value that I added to a block list by mistake?
- Can I remove a single entry from a list without deleting the whole list?
instructions:
- text: Delete value list item {item}.
slots:
item: path.item
- text: Remove entry {item} from its value list.
slots:
item: path.item
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/radar/value_lists'].get
update:
x-apievangelist-phrasing:
intent: List fraud value lists
effect: read
questions:
- How do I see all the block and allow lists I've created for my fraud rules?
- Can I find which lists contain a particular value?
instructions:
- text: List all my Radar value lists.
- text: Find the value list with alias {alias}.
slots:
alias: query.alias
- text: List the value lists that contain {contains}.
slots:
contains: query.contains
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/radar/value_lists'].post
update:
x-apievangelist-phrasing:
intent: Create a fraud value list
effect: write
questions:
- How do I create a list of blocked emails or IP addresses to use in fraud rules?
- What kinds of values can a Radar list hold, like card fingerprints or countries?
instructions:
- text: Create a value list named {name} with alias {alias} for {item_type} values.
slots:
name: requestBody.name
alias: requestBody.alias
item_type: requestBody.item_type
- text: Create a block list called {name} with alias {alias}.
slots:
name: requestBody.name
alias: requestBody.alias
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/radar/value_lists/{value_list}'].get
update:
x-apievangelist-phrasing:
intent: Look up a fraud value list
effect: read
questions:
- How do I view one of my fraud lists and the entries in it?
- What alias and item type does a particular value list use?
instructions:
- text: Get value list {value_list}.
slots:
value_list: path.value_list
- text: Show me Radar list {value_list}.
slots:
value_list: path.value_list
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/radar/value_lists/{value_list}'].post
update:
x-apievangelist-phrasing:
intent: Rename or update a fraud value list
effect: write
questions:
- How do I rename a fraud list or change the alias my rules use?
- Can I change what type of values a list holds after creating it?
instructions:
- text: Rename value list {value_list} to {name}.
slots:
value_list: path.value_list
name: requestBody.name
- text: Change the alias of list {value_list} to {alias}.
slots:
value_list: path.value_list
alias: requestBody.alias
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/radar/value_lists/{value_list}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a fraud value list
effect: destructive
questions:
- How do I delete a block or allow list along with all its entries?
- Why can't I delete a value list that my fraud rules still reference?
instructions:
- text: Delete value list {value_list}.
slots:
value_list: path.value_list
- text: Remove Radar list {value_list} and all of its entries.
slots:
value_list: path.value_list
method: generated
generated: '2026-09-26'