Stripe · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Stripe Prices API
6 actions
6 updates
phrasing
extends
openapi/stripe-prices-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 6
$.info
$.paths['/v1/prices'].get
$.paths['/v1/prices'].post
$.paths['/v1/prices/search'].get
$.paths['/v1/prices/{price}'].get
$.paths['/v1/prices/{price}'].post
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 Prices API
version: 1.0.0
extends: openapi/stripe-prices-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: 5
- target: $.paths['/v1/prices'].get
update:
x-apievangelist-phrasing:
intent: List prices
effect: read
questions:
- How do I see all the prices I've set up for my products?
- Can I list only monthly recurring prices, or only one-time prices?
- How do I find prices I've archived?
instructions:
- text: List my active prices.
- text: List the prices for product {product}.
slots:
product: query.product
- text: Show {type} prices in {currency}.
slots:
type: query.type
currency: query.currency
- text: Find the price with lookup key {lookup_keys}.
slots:
lookup_keys: query.lookup_keys
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/prices'].post
update:
x-apievangelist-phrasing:
intent: Create a price for a product
effect: write
questions:
- How do I add a monthly subscription price to a product?
- Can I set up tiered or volume pricing?
- Can I create a product and its price in one step?
- Can I let customers choose how much to pay?
instructions:
- text: Create a price of {unit_amount} {currency} for product {product}.
slots:
unit_amount: requestBody.unit_amount
currency: requestBody.currency
product: requestBody.product
- text: Create a recurring {unit_amount} {currency} price on {product} billed {recurring}.
slots:
unit_amount: requestBody.unit_amount
currency: requestBody.currency
product: requestBody.product
recurring: requestBody.recurring
- text: Add a {currency} price for {product} with lookup key {lookup_key}.
slots:
currency: requestBody.currency
product: requestBody.product
lookup_key: requestBody.lookup_key
- text: Create a tiered {currency} price on {product} using {tiers_mode} tiers {tiers}.
slots:
currency: requestBody.currency
product: requestBody.product
tiers_mode: requestBody.tiers_mode
tiers: requestBody.tiers
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/prices/search'].get
update:
x-apievangelist-phrasing:
intent: Search prices with a query
effect: read
questions:
- How do I search my prices by metadata or amount?
- Is a price I just created immediately searchable?
instructions:
- text: Search prices matching {query}.
slots:
query: query.query
- text: Find up to {limit} prices where {query}.
slots:
limit: query.limit
query: query.query
- text: Get page {page} of price search results for {query}.
slots:
page: query.page
query: query.query
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/prices/{price}'].get
update:
x-apievangelist-phrasing:
intent: Get a price
effect: read
questions:
- How do I look up one price's amount and billing interval?
- Is a given price still active for new purchases?
instructions:
- text: Show price {price}.
slots:
price: path.price
- text: Get the amount and interval of price {price}.
slots:
price: path.price
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/prices/{price}'].post
update:
x-apievangelist-phrasing:
intent: Update or archive a price
effect: write
questions:
- How do I stop a price from being used for new purchases?
- Can I change the amount on an existing price?
- How do I move a lookup key from an old price to a new one?
instructions:
- text: Archive price {price} by setting active to {active}.
slots:
price: path.price
active: requestBody.active
- text: Rename price {price} internally to {nickname}.
slots:
price: path.price
nickname: requestBody.nickname
- text: Give price {price} the lookup key {lookup_key} and take it from any other price.
slots:
price: path.price
lookup_key: requestBody.lookup_key
method: generated
generated: '2026-09-26'