Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Accounts Account Shipping Rates API

5 actions 5 updates phrasing extends openapi/stripe-shipping-rates-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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/v1/shipping_rates'].get

$.paths['/v1/shipping_rates'].post

$.paths['/v1/shipping_rates/{shipping_rate_token}'].get

$.paths['/v1/shipping_rates/{shipping_rate_token}'].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 Accounts Account Shipping Rates API
  version: 1.0.0
extends: openapi/stripe-shipping-rates-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: 4
- target: $.paths['/v1/shipping_rates'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping rates
      effect: read
      questions:
      - Which shipping options have I set up for checkout?
      - Can I list only active shipping rates in one currency?
      instructions:
      - text: List my shipping rates.
      - text: List shipping rates in {currency}.
        slots:
          currency: query.currency
      - text: Show shipping rates where active is {active}.
        slots:
          active: query.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/shipping_rates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shipping rate
      effect: write
      questions:
      - How do I add a flat-rate shipping option to checkout?
      - Can I show customers an estimated delivery time for a shipping option?
      - Can shipping be priced tax-inclusive?
      instructions:
      - text: Create a shipping rate called {display_name} costing {fixed_amount}.
        slots:
          display_name: requestBody.display_name
          fixed_amount: requestBody.fixed_amount
      - text: Add shipping option {display_name} at {fixed_amount} with delivery estimate {delivery_estimate}.
        slots:
          display_name: requestBody.display_name
          fixed_amount: requestBody.fixed_amount
          delivery_estimate: requestBody.delivery_estimate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/shipping_rates/{shipping_rate_token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipping rate
      effect: read
      questions:
      - How do I look up the cost and name of one shipping rate?
      - Is a given shipping rate still active?
      instructions:
      - text: Show shipping rate {shipping_rate_token}.
        slots:
          shipping_rate_token: path.shipping_rate_token
      - text: Get the amount and delivery estimate of shipping rate {shipping_rate_token}.
        slots:
          shipping_rate_token: path.shipping_rate_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/shipping_rates/{shipping_rate_token}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update or archive a shipping rate
      effect: write
      questions:
      - How do I retire a shipping option so it's no longer offered?
      - Can I change whether a shipping rate includes tax?
      instructions:
      - text: Set shipping rate {shipping_rate_token} active to {active}.
        slots:
          shipping_rate_token: path.shipping_rate_token
          active: requestBody.active
      - text: Change the tax behavior of shipping rate {shipping_rate_token} to {tax_behavior}.
        slots:
          shipping_rate_token: path.shipping_rate_token
          tax_behavior: requestBody.tax_behavior
      method: generated
      generated: '2026-09-26'