Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Accounts Lists API

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

$.info
$.paths['/v1/accounts/{account}/people'].get
$.paths['/v1/accounts/{account}/persons'].get

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 Lists API
  version: 1.0.0
extends: openapi/stripe-lists-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: 2
- target: $.paths['/v1/accounts/{account}/people'].get
  update:
    x-apievangelist-phrasing:
      intent: List people on a connected account
      effect: read
      questions:
      - Who are the people tied to a connected account's business?
      - Can I list just the executives or directors of a connected account?
      instructions:
      - text: List the people on connected account {account}.
        slots:
          account: path.account
      - text: Show people on account {account} with relationship {relationship}.
        slots:
          account: path.account
          relationship: query.relationship
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}/persons'].get
  update:
    x-apievangelist-phrasing:
      intent: List persons on a connected account's legal entity
      effect: read
      questions:
      - How do I list the persons attached to a connected account's legal entity?
      - Can I filter a connected account's persons to only its owners?
      instructions:
      - text: List persons for the legal entity of account {account}.
        slots:
          account: path.account
      - text: Show up to {limit} persons on account {account} filtered by {relationship}.
        slots:
          limit: query.limit
          account: path.account
          relationship: query.relationship
      method: generated
      generated: '2026-09-26'