Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Link Linked Accounts API

6 actions 6 updates phrasing extends openapi/stripe-linked-accounts-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 6

$.info

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

$.paths['/v1/linked_accounts/{account}'].get

$.paths['/v1/linked_accounts/{account}/disconnect'].post

$.paths['/v1/linked_accounts/{account}/owners'].get

$.paths['/v1/linked_accounts/{account}/refresh'].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 Link Linked Accounts API
  version: 1.0.0
extends: openapi/stripe-linked-accounts-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: 5
- target: $.paths['/v1/linked_accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List linked financial accounts
      effect: read
      questions:
      - Which bank accounts have my customers linked through Financial Connections?
      - Can I list only the accounts linked in one session?
      - How do I find the linked accounts that belong to one customer?
      instructions:
      - text: List my linked financial accounts.
      - text: List accounts linked during session {session}.
        slots:
          session: query.session
      - text: Show linked accounts belonging to account holder {account_holder}.
        slots:
          account_holder: query.account_holder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/linked_accounts/{account}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a linked financial account
      effect: read
      questions:
      - How do I look up the details of one linked bank account?
      - Is my access to a linked account still active?
      instructions:
      - text: Show linked account {account}.
        slots:
          account: path.account
      - text: Get the institution and status of linked account {account}.
        slots:
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/linked_accounts/{account}/disconnect'].post
  update:
    x-apievangelist-phrasing:
      intent: Disconnect a linked financial account
      effect: destructive
      questions:
      - How do I give up my access to a customer's linked bank account?
      - Can I still read balances after disconnecting a linked account?
      instructions:
      - text: Disconnect linked account {account}.
        slots:
          account: path.account
      - text: Revoke my access to linked bank account {account}.
        slots:
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/linked_accounts/{account}/owners'].get
  update:
    x-apievangelist-phrasing:
      intent: List owners of a linked financial account
      effect: read
      questions:
      - How do I see who owns a linked bank account?
      - Can I verify the account holder names on a linked account?
      instructions:
      - text: List owners of linked account {account} from ownership {ownership}.
        slots:
          account: path.account
          ownership: query.ownership
      - text: Show up to {limit} owners of account {account} for ownership record {ownership}.
        slots:
          limit: query.limit
          account: path.account
          ownership: query.ownership
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/linked_accounts/{account}/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh data on a linked financial account
      effect: write
      questions:
      - How do I get fresh balance or ownership data for a linked account?
      - Can I choose which data to refresh on a linked account?
      instructions:
      - text: Refresh {features} on linked account {account}.
        slots:
          features: requestBody.features
          account: path.account
      - text: Pull the latest {features} data for linked bank account {account}.
        slots:
          features: requestBody.features
          account: path.account
      method: generated
      generated: '2026-09-26'