Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Accounts Account Products API

7 actions 7 updates phrasing extends openapi/stripe-products-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 7

$.info
$.paths['/v1/products'].get
$.paths['/v1/products'].post
$.paths['/v1/products/search'].get
$.paths['/v1/products/{id}'].get
$.paths['/v1/products/{id}'].post
$.paths['/v1/products/{id}'].delete

OpenAPI Overlay

Raw ↑
# 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 Products API
  version: 1.0.0
extends: openapi/stripe-products-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: 6
- target: $.paths['/v1/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List products
      effect: read
      questions:
      - How do I see everything in my product catalog?
      - Can I list only active products?
      - Which of my products are shippable physical goods?
      instructions:
      - text: List my products.
      - text: List products where active is {active}.
        slots:
          active: query.active
      - text: Show products with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/products'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a product
      effect: write
      questions:
      - How do I add a new product to my catalog?
      - Can I create a product and its default price at the same time?
      instructions:
      - text: Create a product named {name}.
        slots:
          name: requestBody.name
      - text: Create product {name} with default price {default_price_data}.
        slots:
          name: requestBody.name
          default_price_data: requestBody.default_price_data
      - text: Add product {name} described as {description} with tax code {tax_code}.
        slots:
          name: requestBody.name
          description: requestBody.description
          tax_code: requestBody.tax_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/products/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search products
      effect: read
      questions:
      - How do I find products by name or metadata?
      - Will product search show a product I created a second ago?
      instructions:
      - text: Search products for {query}.
        slots:
          query: query.query
      - text: Find up to {limit} products matching {query}.
        slots:
          limit: query.limit
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/products/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product
      effect: read
      questions:
      - How do I look up the details of one product?
      - What's the default price on this product?
      instructions:
      - text: Show product {id}.
        slots:
          id: path.id
      - text: Get the details of product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/products/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a product
      effect: write
      questions:
      - How do I rename a product or change its description?
      - Can I archive a product so it can't be sold anymore?
      instructions:
      - text: Rename product {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set product {id} active to {active}.
        slots:
          id: path.id
          active: requestBody.active
      - text: Make {default_price} the default price of product {id}.
        slots:
          default_price: requestBody.default_price
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/products/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product
      effect: destructive
      questions:
      - How do I delete a product from my catalog?
      - Can I delete a product that still has prices attached?
      instructions:
      - text: Delete product {id}.
        slots:
          id: path.id
      - text: Permanently remove product {id} from my catalog.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'