Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Accounts Account Forwarding API

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

$.info

$.paths['/v1/forwarding/requests'].get

$.paths['/v1/forwarding/requests'].post

$.paths['/v1/forwarding/requests/{id}'].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 Accounts Account Forwarding API
  version: 1.0.0
extends: openapi/stripe-forwarding-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: 3
- target: $.paths['/v1/forwarding/requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List forwarded card requests
      effect: read
      questions:
      - How do I see the requests where I've forwarded card details to another endpoint?
      - Can I page through my forwarding request history?
      instructions:
      - text: List my forwarding requests.
      - text: Show the latest {limit} forwarding requests.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/forwarding/requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Forward saved card details to a destination URL
      effect: write
      questions:
      - How do I send a stored card's details to another endpoint without touching raw card data?
      - Which card fields can be inserted into a forwarded request?
      instructions:
      - text: Forward payment method {payment_method} to {url} replacing {replacements}.
        slots:
          payment_method: requestBody.payment_method
          url: requestBody.url
          replacements: requestBody.replacements
      - text: Send request {request} to {url} with {replacements} filled from payment method {payment_method}.
        slots:
          request: requestBody.request
          url: requestBody.url
          replacements: requestBody.replacements
          payment_method: requestBody.payment_method
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/forwarding/requests/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a forwarding request
      effect: read
      questions:
      - How do I see what came back from a forwarded card request?
      - Can I look up one forwarding request by its ID?
      instructions:
      - text: Show forwarding request {id}.
        slots:
          id: path.id
      - text: Get the destination response for forwarding request {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'