Stripe · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Stripe Quotes API
11 actions
11 updates
phrasing
extends
openapi/stripe-quotes-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 11
$.info
$.paths['/v1/quotes'].get
$.paths['/v1/quotes'].post
$.paths['/v1/quotes/{quote}'].get
$.paths['/v1/quotes/{quote}'].post
$.paths['/v1/quotes/{quote}/accept'].post
$.paths['/v1/quotes/{quote}/cancel'].post
$.paths['/v1/quotes/{quote}/computed_upfront_line_items'].get
$.paths['/v1/quotes/{quote}/finalize'].post
$.paths['/v1/quotes/{quote}/line_items'].get
$.paths['/v1/quotes/{quote}/pdf'].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 Quotes API
version: 1.0.0
extends: openapi/stripe-quotes-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: 10
- target: $.paths['/v1/quotes'].get
update:
x-apievangelist-phrasing:
intent: List quotes
effect: read
questions:
- How do I see all the quotes I've created?
- Can I list only a customer's open or accepted quotes?
instructions:
- text: List my quotes.
- text: List quotes for customer {customer} with status {status}.
slots:
customer: query.customer
status: query.status
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/quotes'].post
update:
x-apievangelist-phrasing:
intent: Create a quote
effect: write
questions:
- How do I create a price quote for a customer?
- Can I set when a quote expires?
- Can I start a new quote by copying an existing one?
instructions:
- text: Create a quote for customer {customer} with line items {line_items}.
slots:
customer: requestBody.customer
line_items: requestBody.line_items
- text: Draft a quote for customer {customer} that expires at {expires_at}.
slots:
customer: requestBody.customer
expires_at: requestBody.expires_at
- text: Create a new quote based on quote {from_quote}.
slots:
from_quote: requestBody.from_quote
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/quotes/{quote}'].get
update:
x-apievangelist-phrasing:
intent: Retrieve a quote
effect: read
questions:
- How do I look up a single quote?
- Where can I check whether a customer has accepted a quote?
instructions:
- text: Get quote {quote}.
slots:
quote: path.quote
- text: Show me the status of quote {quote}.
slots:
quote: path.quote
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/quotes/{quote}'].post
update:
x-apievangelist-phrasing:
intent: Edit a quote
effect: write
questions:
- How do I change the line items on a draft quote?
- Can I update the header or footer text on a quote?
instructions:
- text: Update quote {quote} with line items {line_items}.
slots:
quote: path.quote
line_items: requestBody.line_items
- text: Change the header of quote {quote} to {header}.
slots:
quote: path.quote
header: requestBody.header
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/quotes/{quote}/accept'].post
update:
x-apievangelist-phrasing:
intent: Accept a quote
effect: write
questions:
- How do I record that a customer accepted a quote?
- What happens when a quote is accepted?
instructions:
- text: Accept quote {quote}.
slots:
quote: path.quote
- text: Mark quote {quote} as accepted by the customer.
slots:
quote: path.quote
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/quotes/{quote}/cancel'].post
update:
x-apievangelist-phrasing:
intent: Cancel a quote
effect: destructive
questions:
- How do I cancel a quote the customer won't be accepting?
- Can I withdraw a quote I already sent?
instructions:
- text: Cancel quote {quote}.
slots:
quote: path.quote
- text: Withdraw quote {quote} so it can no longer be accepted.
slots:
quote: path.quote
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/quotes/{quote}/computed_upfront_line_items'].get
update:
x-apievangelist-phrasing:
intent: List a quote's upfront line items
effect: read
questions:
- How do I see what a customer pays upfront when accepting a quote?
- Can I page through all the computed upfront charges on a quote?
instructions:
- text: List the upfront line items for quote {quote}.
slots:
quote: path.quote
- text: Show the first {limit} computed upfront charges on quote {quote}.
slots:
limit: query.limit
quote: path.quote
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/quotes/{quote}/finalize'].post
update:
x-apievangelist-phrasing:
intent: Finalize a quote
effect: write
questions:
- How do I finalize a quote so I can send it to the customer?
- Can I set an expiry date when I finalize a quote?
instructions:
- text: Finalize quote {quote}.
slots:
quote: path.quote
- text: Finalize quote {quote} to expire at {expires_at}.
slots:
quote: path.quote
expires_at: requestBody.expires_at
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/quotes/{quote}/line_items'].get
update:
x-apievangelist-phrasing:
intent: List a quote's line items
effect: read
questions:
- How do I get all the line items on a quote?
- What if a quote has more line items than come back with it?
instructions:
- text: List the line items on quote {quote}.
slots:
quote: path.quote
- text: Show {limit} line items from quote {quote}.
slots:
limit: query.limit
quote: path.quote
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/quotes/{quote}/pdf'].get
update:
x-apievangelist-phrasing:
intent: Download a quote as a PDF
effect: read
questions:
- How do I download a PDF of a quote to send to a customer?
- Can I get a PDF of a quote that hasn't been finalized?
instructions:
- text: Download the PDF for quote {quote}.
slots:
quote: path.quote
- text: Get a printable PDF of finalized quote {quote}.
slots:
quote: path.quote
method: generated
generated: '2026-09-26'