API Evangelist conversational phrasing for Stripe Financial Connections API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Financial Connections API
  version: 1.0.0
extends: openapi/stripe-financial-connections-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: 11
- target: $.paths['/v1/financial_connections/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List linked bank accounts
      effect: read
      questions:
      - How do I see all the bank accounts my customers have linked?
      - Can I list only the linked accounts from one customer or one authorization session?
      instructions:
      - text: List linked Financial Connections accounts.
      - text: List linked accounts for account holder {account_holder}.
        slots:
          account_holder: query.account_holder
      - text: List the accounts linked in session {session}.
        slots:
          session: query.session
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/financial_connections/accounts/{account}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a linked bank account
      effect: read
      questions:
      - How do I see the details of one bank account a customer linked?
      - What information is available for a single Financial Connections account?
      instructions:
      - text: Get linked account {account}.
        slots:
          account: path.account
      - text: Show me the details of Financial Connections account {account}.
        slots:
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/financial_connections/accounts/{account}/disconnect'].post
  update:
    x-apievangelist-phrasing:
      intent: Disconnect a linked bank account
      effect: destructive
      questions:
      - How do I stop accessing a customer's linked bank account?
      - What happens to balance and transaction data after I disconnect an account?
      instructions:
      - text: Disconnect linked account {account}.
        slots:
          account: path.account
      - text: Revoke my access to Financial Connections account {account}.
        slots:
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/financial_connections/accounts/{account}/owners'].get
  update:
    x-apievangelist-phrasing:
      intent: List owners of a linked bank account
      effect: read
      questions:
      - How do I find out who owns a bank account a customer linked?
      - Can I verify the account holder names on a linked account?
      instructions:
      - text: List the owners of account {account} from ownership {ownership}.
        slots:
          account: path.account
          ownership: query.ownership
      - text: Show who owns linked account {account} using ownership record {ownership}.
        slots:
          account: path.account
          ownership: query.ownership
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/financial_connections/accounts/{account}/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh data on a linked bank account
      effect: write
      questions:
      - How do I pull the latest balance for a customer's linked bank account?
      - Can I refresh ownership or transaction data on demand?
      instructions:
      - text: Refresh {features} on linked account {account}.
        slots:
          features: requestBody.features
          account: path.account
      - text: Fetch the latest balance for account {account}.
        slots:
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/financial_connections/accounts/{account}/subscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to ongoing account data refreshes
      effect: write
      questions:
      - How do I keep a linked bank account's transactions updated automatically?
      - Can I subscribe to periodic refreshes instead of refreshing manually?
      instructions:
      - text: Subscribe account {account} to periodic {features} refreshes.
        slots:
          account: path.account
          features: requestBody.features
      - text: Keep transactions on linked account {account} refreshing automatically.
        slots:
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/financial_connections/accounts/{account}/unsubscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop ongoing account data refreshes
      effect: write
      questions:
      - How do I stop automatic transaction refreshes on a linked bank account?
      - Can I unsubscribe from periodic refreshes without disconnecting the account?
      instructions:
      - text: Unsubscribe account {account} from {features} refreshes.
        slots:
          account: path.account
          features: requestBody.features
      - text: Stop periodic refreshes on linked account {account}.
        slots:
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/financial_connections/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bank account linking session
      effect: write
      questions:
      - How do I let a customer securely link their bank account?
      - Can I choose which data permissions, like balances or transactions, to request when linking?
      - Can I limit linking to certain account types with filters?
      instructions:
      - text: Create a linking session for {account_holder} requesting {permissions}.
        slots:
          account_holder: requestBody.account_holder
          permissions: requestBody.permissions
      - text: Start a bank linking session for {account_holder} that returns to {return_url}.
        slots:
          account_holder: requestBody.account_holder
          return_url: requestBody.return_url
      - text: Create a session for {account_holder}, prefetching {prefetch}.
        slots:
          account_holder: requestBody.account_holder
          prefetch: requestBody.prefetch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/financial_connections/sessions/{session}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a bank linking session
      effect: read
      questions:
      - How do I see which accounts a customer linked during a session?
      - What's in a Financial Connections session after the customer finishes the flow?
      instructions:
      - text: Get Financial Connections session {session}.
        slots:
          session: path.session
      - text: Show me the accounts linked in session {session}.
        slots:
          session: path.session
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/financial_connections/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactions on a linked bank account
      effect: read
      questions:
      - How do I read a customer's bank transactions from their linked account?
      - Can I filter linked-account transactions by the date they happened?
      - Can I get only the transactions from a specific refresh?
      instructions:
      - text: List transactions for linked account {account}.
        slots:
          account: query.account
      - text: List transactions on account {account} transacted in {transacted_at}.
        slots:
          account: query.account
          transacted_at: query.transacted_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/financial_connections/transactions/{transaction}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a linked-account transaction
      effect: read
      questions:
      - How do I get the details of one bank transaction from a linked account?
      - What fields does a single Financial Connections transaction include?
      instructions:
      - text: Get Financial Connections transaction {transaction}.
        slots:
          transaction: path.transaction
      - text: Show me bank transaction {transaction}.
        slots:
          transaction: path.transaction
      method: generated
      generated: '2026-09-26'