Stripe · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Stripe Applications API
12 actions
12 updates
phrasing
extends
openapi/stripe-applications-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/application_fees'].get
$.paths['/v1/application_fees/{fee}/refunds/{id}'].get
$.paths['/v1/application_fees/{fee}/refunds/{id}'].post
$.paths['/v1/application_fees/{id}'].get
$.paths['/v1/application_fees/{id}/refund'].post
$.paths['/v1/application_fees/{id}/refunds'].get
$.paths['/v1/application_fees/{id}/refunds'].post
$.paths['/v1/apps/secrets'].get
$.paths['/v1/apps/secrets'].post
$.paths['/v1/apps/secrets/delete'].post
$.paths['/v1/apps/secrets/find'].get
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 Applications API
version: 1.0.0
extends: openapi/stripe-applications-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/application_fees'].get
update:
x-apievangelist-phrasing:
intent: List collected application fees
effect: read
questions:
- How much have I collected in platform application fees?
- Can I find the application fee taken on one specific charge?
- How do I list application fees created in a date range?
instructions:
- text: List my recent application fees.
- text: Show the application fee collected on charge {charge}.
slots:
charge: query.charge
- text: List application fees created {created}, up to {limit} results.
slots:
created: query.created
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/application_fees/{fee}/refunds/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one refund of an application fee
effect: read
questions:
- How do I look up a specific refund made on an application fee?
- Can I see an older application fee refund beyond the ten most recent?
instructions:
- text: Show refund {id} on application fee {fee}.
slots:
id: path.id
fee: path.fee
- text: Get the details of application fee refund {id} for fee {fee}.
slots:
id: path.id
fee: path.fee
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/application_fees/{fee}/refunds/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update an application fee refund's metadata
effect: write
questions:
- How do I tag an application fee refund with my own metadata?
- What can I change on an application fee refund after it's made?
instructions:
- text: Set metadata {metadata} on refund {id} of application fee {fee}.
slots:
metadata: requestBody.metadata
id: path.id
fee: path.fee
- text: Update the metadata on application fee refund {id}, fee {fee}.
slots:
id: path.id
fee: path.fee
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/application_fees/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an application fee
effect: read
questions:
- How do I look up the details of one application fee?
- Has a particular application fee been refunded?
instructions:
- text: Show application fee {id}.
slots:
id: path.id
- text: Get the amount and refund status of application fee {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/application_fees/{id}/refund'].post
update:
x-apievangelist-phrasing:
intent: Refund an application fee (legacy endpoint)
effect: write
questions:
- Is there an older endpoint for refunding an application fee?
- Can I refund only part of an application fee with the legacy refund call?
instructions:
- text: Refund application fee {id} using the legacy refund call.
slots:
id: path.id
- text: Refund {amount} of application fee {id} with the legacy endpoint.
slots:
amount: requestBody.amount
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/application_fees/{id}/refunds'].get
update:
x-apievangelist-phrasing:
intent: List refunds of an application fee
effect: read
questions:
- How do I see every refund made against an application fee?
- Can I page through more than the ten most recent refunds on a fee?
instructions:
- text: List refunds on application fee {id}.
slots:
id: path.id
- text: Show up to {limit} refunds for application fee {id}.
slots:
limit: query.limit
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/application_fees/{id}/refunds'].post
update:
x-apievangelist-phrasing:
intent: Refund an application fee
effect: write
questions:
- How do I give back an application fee I collected from a connected account?
- Can I partially refund an application fee?
- Where do refunded application fee funds go?
instructions:
- text: Refund application fee {id} in full.
slots:
id: path.id
- text: Refund {amount} of application fee {id}.
slots:
amount: requestBody.amount
id: path.id
- text: Refund application fee {id} and tag it with metadata {metadata}.
slots:
id: path.id
metadata: requestBody.metadata
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/secrets'].get
update:
x-apievangelist-phrasing:
intent: List secrets in an app's secret store
effect: read
questions:
- How do I see which secrets my app has stored?
- Can I list secrets for just one scope, like a single user?
instructions:
- text: List the secrets stored in scope {scope}.
slots:
scope: query.scope
- text: Show up to {limit} app secrets in scope {scope}.
slots:
limit: query.limit
scope: query.scope
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/secrets'].post
update:
x-apievangelist-phrasing:
intent: Create or replace an app secret
effect: write
questions:
- How do I store an API key or token securely for my app?
- Can I set an app secret to expire automatically?
instructions:
- text: Store secret {name} with value {payload} in scope {scope}.
slots:
name: requestBody.name
payload: requestBody.payload
scope: requestBody.scope
- text: Save secret {name} in scope {scope} and expire it at {expires_at}.
slots:
name: requestBody.name
scope: requestBody.scope
expires_at: requestBody.expires_at
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/secrets/delete'].post
update:
x-apievangelist-phrasing:
intent: Delete an app secret
effect: destructive
questions:
- How do I remove a secret my app no longer needs?
- Do I need the scope as well as the name to delete an app secret?
instructions:
- text: Delete secret {name} from scope {scope}.
slots:
name: requestBody.name
scope: requestBody.scope
- text: Remove the app secret called {name} in scope {scope} from the store.
slots:
name: requestBody.name
scope: requestBody.scope
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/apps/secrets/find'].get
update:
x-apievangelist-phrasing:
intent: Find an app secret by name
effect: read
questions:
- How do I read back a secret my app stored earlier?
- Can I look up an app secret by its name and scope?
instructions:
- text: Find secret {name} in scope {scope}.
slots:
name: query.name
scope: query.scope
- text: Fetch the stored value of app secret {name} for scope {scope}.
slots:
name: query.name
scope: query.scope
method: generated
generated: '2026-09-26'