Stripe · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Stripe Climate API
16 actions
16 updates
phrasing
extends
openapi/stripe-climate-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 16
$.info
$.paths['/v1/climate/orders'].get
$.paths['/v1/climate/orders'].post
$.paths['/v1/climate/orders/{order}'].get
$.paths['/v1/climate/orders/{order}'].post
$.paths['/v1/climate/orders/{order}/cancel'].post
$.paths['/v1/climate/products'].get
$.paths['/v1/climate/products/{product}'].get
$.paths['/v1/climate/reservations'].get
$.paths['/v1/climate/reservations'].post
$.paths['/v1/climate/reservations/{order}'].get
$.paths['/v1/climate/reservations/{order}'].post
$.paths['/v1/climate/reservations/{order}/cancel'].post
$.paths['/v1/climate/reservations/{order}/confirm'].post
$.paths['/v1/climate/suppliers'].get
$.paths['/v1/climate/suppliers/{supplier}'].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 Climate API
version: 1.0.0
extends: openapi/stripe-climate-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: 15
- target: $.paths['/v1/climate/orders'].get
update:
x-apievangelist-phrasing:
intent: List carbon removal orders
effect: read
questions:
- How do I see all the carbon removal I've ordered?
- Which climate orders did I place most recently?
instructions:
- text: List my climate orders.
- text: Show my last {limit} carbon removal orders.
slots:
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/orders'].post
update:
x-apievangelist-phrasing:
intent: Buy carbon removal
effect: write
questions:
- How do I buy carbon removal for my business?
- Can I order by metric tons instead of a currency amount?
- When is payment for a climate order taken from my balance?
instructions:
- text: Order {metric_tons} metric tons of carbon removal from product {product}.
slots:
metric_tons: requestBody.metric_tons
product: requestBody.product
- text: Spend {amount} {currency} on carbon removal product {product}.
slots:
amount: requestBody.amount
currency: requestBody.currency
product: requestBody.product
- text: Buy {metric_tons} tons of product {product} on behalf of {beneficiary}.
slots:
metric_tons: requestBody.metric_tons
product: requestBody.product
beneficiary: requestBody.beneficiary
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/orders/{order}'].get
update:
x-apievangelist-phrasing:
intent: Get a carbon removal order
effect: read
questions:
- How do I check the status of a carbon removal order?
- Has my climate order been delivered yet?
instructions:
- text: Show climate order {order}.
slots:
order: path.order
- text: Check the delivery status of carbon removal order {order}.
slots:
order: path.order
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/orders/{order}'].post
update:
x-apievangelist-phrasing:
intent: Update a carbon removal order
effect: write
questions:
- How do I change who gets credit for a carbon removal order?
- Can I add my own metadata to a climate order?
instructions:
- text: Set the beneficiary of climate order {order} to {beneficiary}.
slots:
order: path.order
beneficiary: requestBody.beneficiary
- text: Add metadata {metadata} to climate order {order}.
slots:
metadata: requestBody.metadata
order: path.order
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/orders/{order}/cancel'].post
update:
x-apievangelist-phrasing:
intent: Cancel a carbon removal order
effect: destructive
questions:
- How do I cancel a carbon removal order?
- How long after ordering can I still cancel a climate order?
- Do I get fees back when I cancel a climate order?
instructions:
- text: Cancel climate order {order}.
slots:
order: path.order
- text: Cancel carbon removal order {order} and get the reservation refunded.
slots:
order: path.order
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/products'].get
update:
x-apievangelist-phrasing:
intent: List carbon removal products
effect: read
questions:
- What carbon removal products can I buy?
- Which climate products are available and what do they cost per ton?
instructions:
- text: List available climate products.
- text: Show the first {limit} carbon removal products.
slots:
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/products/{product}'].get
update:
x-apievangelist-phrasing:
intent: Get a carbon removal product
effect: read
questions:
- How do I see the price and availability of one carbon removal product?
- Which suppliers deliver a given climate product?
instructions:
- text: Show climate product {product}.
slots:
product: path.product
- text: Get pricing and suppliers for carbon removal product {product}.
slots:
product: path.product
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/reservations'].get
update:
x-apievangelist-phrasing:
intent: List carbon removal reservations
effect: read
questions:
- How do I see the carbon removal I've reserved but may not have confirmed?
- Which climate reservations did I create most recently?
instructions:
- text: List my climate reservations.
- text: Show my last {limit} carbon removal reservations.
slots:
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/reservations'].post
update:
x-apievangelist-phrasing:
intent: Reserve carbon removal
effect: write
questions:
- How do I reserve carbon removal before committing to buy it?
- Can I reserve a set number of metric tons of a climate product?
instructions:
- text: Reserve {metric_tons} metric tons of carbon removal product {product}.
slots:
metric_tons: requestBody.metric_tons
product: requestBody.product
- text: Reserve {amount} {currency} worth of climate product {product}.
slots:
amount: requestBody.amount
currency: requestBody.currency
product: requestBody.product
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/reservations/{order}'].get
update:
x-apievangelist-phrasing:
intent: Get a carbon removal reservation
effect: read
questions:
- How do I check a single carbon removal reservation?
- Is my climate reservation confirmed yet?
instructions:
- text: Show climate reservation {order}.
slots:
order: path.order
- text: Check whether carbon removal reservation {order} is confirmed.
slots:
order: path.order
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/reservations/{order}'].post
update:
x-apievangelist-phrasing:
intent: Update a carbon removal reservation
effect: write
questions:
- How do I change the beneficiary on a carbon removal reservation?
- Can I tag a climate reservation with my own metadata?
instructions:
- text: Set the beneficiary of climate reservation {order} to {beneficiary}.
slots:
order: path.order
beneficiary: requestBody.beneficiary
- text: Add metadata {metadata} to climate reservation {order}.
slots:
metadata: requestBody.metadata
order: path.order
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/reservations/{order}/cancel'].post
update:
x-apievangelist-phrasing:
intent: Cancel a carbon removal reservation
effect: destructive
questions:
- How do I cancel a carbon removal reservation?
- Is there a deadline for canceling a climate reservation?
instructions:
- text: Cancel climate reservation {order}.
slots:
order: path.order
- text: Release carbon removal reservation {order}.
slots:
order: path.order
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/reservations/{order}/confirm'].post
update:
x-apievangelist-phrasing:
intent: Confirm a carbon removal reservation
effect: write
questions:
- How do I turn a carbon removal reservation into a paid order?
- When are funds taken from my balance for a climate reservation?
instructions:
- text: Confirm climate reservation {order}.
slots:
order: path.order
- text: Pay for carbon removal reservation {order} from my balance.
slots:
order: path.order
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/suppliers'].get
update:
x-apievangelist-phrasing:
intent: List carbon removal suppliers
effect: read
questions:
- Who supplies the carbon removal I can buy?
- Which climate suppliers are available and where are they located?
instructions:
- text: List climate suppliers.
- text: Show the first {limit} carbon removal suppliers.
slots:
limit: query.limit
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/climate/suppliers/{supplier}'].get
update:
x-apievangelist-phrasing:
intent: Get a carbon removal supplier
effect: read
questions:
- How do I learn about one carbon removal supplier?
- What removal pathway does a climate supplier use?
instructions:
- text: Show climate supplier {supplier}.
slots:
supplier: path.supplier
- text: Get the details of carbon removal supplier {supplier}.
slots:
supplier: path.supplier
method: generated
generated: '2026-09-26'