Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Accounts Person API

5 actions 5 updates phrasing extends openapi/stripe-person-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/accounts/{account}/people/{person}'].get

$.paths['/v1/accounts/{account}/people/{person}'].post

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

$.paths['/v1/accounts/{account}/persons/{person}'].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 Person API
  version: 1.0.0
extends: openapi/stripe-person-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/accounts/{account}/people/{person}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a person on a connected account
      effect: read
      questions:
      - How do I look up an owner or representative on a connected account?
      - Where can I see the details of one person tied to a connected account?
      instructions:
      - text: Get person {person} on connected account {account}.
        slots:
          account: path.account
          person: path.person
      - text: Show the details of person {person} linked to account {account}.
        slots:
          account: path.account
          person: path.person
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}/people/{person}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a person on a connected account
      effect: write
      questions:
      - How do I update a representative's details on a connected account?
      - Can I correct information about an owner of a connected account?
      instructions:
      - text: Update person {person} on connected account {account}.
        slots:
          account: path.account
          person: path.person
      - text: Edit the record for person {person} belonging to account {account}.
        slots:
          account: path.account
          person: path.person
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}/persons/{person}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a person via the persons path
      effect: read
      questions:
      - Is there another path to fetch a person on a connected account?
      - How do I read one person's record under an account's persons list?
      instructions:
      - text: Retrieve person {person} from the persons list of account {account}.
        slots:
          account: path.account
          person: path.person
      - text: Look up account {account}'s person {person} via the persons endpoint.
        slots:
          account: path.account
          person: path.person
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}/persons/{person}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a person via the persons path
      effect: write
      questions:
      - Can I update a person through the account's persons list instead?
      - How do I modify a person record using the persons endpoint?
      instructions:
      - text: Modify person {person} in the persons list of account {account}.
        slots:
          account: path.account
          person: path.person
      - text: Save changes to account {account}'s person {person} via the persons endpoint.
        slots:
          account: path.account
          person: path.person
      method: generated
      generated: '2026-09-26'