Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Accounts Account API

17 actions 17 updates phrasing extends openapi/stripe-account-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 17 · first 16 shown; the file carries all of them

$.info
$.paths['/v1/account'].get
$.paths['/v1/account_links'].post
$.paths['/v1/account_sessions'].post
$.paths['/v1/accounts'].post
$.paths['/v1/accounts/{account}'].get
$.paths['/v1/accounts/{account}'].post
$.paths['/v1/accounts/{account}'].delete
$.paths['/v1/accounts/{account}/bank_accounts'].post
$.paths['/v1/accounts/{account}/bank_accounts/{id}'].get
$.paths['/v1/accounts/{account}/bank_accounts/{id}'].post
$.paths['/v1/accounts/{account}/bank_accounts/{id}'].delete
$.paths['/v1/accounts/{account}/external_accounts'].post
$.paths['/v1/accounts/{account}/external_accounts/{id}'].get
$.paths['/v1/accounts/{account}/external_accounts/{id}'].post
$.paths['/v1/accounts/{account}/external_accounts/{id}'].delete

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 Account API
  version: 1.0.0
extends: openapi/stripe-account-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: 16
- target: $.paths['/v1/account'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my own account details
      effect: read
      questions:
      - How do I check the details of my own Stripe account through the API?
      - Is my account enabled to take live charges and receive payouts?
      instructions:
      - text: Show my account details.
      - text: Check the current requirements on my own account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/account_links'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an onboarding link for a connected account
      effect: write
      questions:
      - How do I send a connected account user through hosted onboarding?
      - Can I reuse an account onboarding link more than once?
      instructions:
      - text: Create an onboarding link for a connected account.
      - text: Generate a single-use URL that takes my user through Connect onboarding.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/account_sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a session for embedded account components
      effect: write
      questions:
      - How do I give my front end client-side access for a connected account?
      - What does an account session token let my platform's UI do?
      instructions:
      - text: Create an account session for my front end.
      - text: Issue a single-use client-side token for a connected account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a connected account
      effect: write
      questions:
      - How do I create accounts for the sellers or users on my platform?
      - Can I prefill business details so onboarding skips those questions?
      instructions:
      - text: Create a new connected account.
      - text: Open a connected account for a new seller on my platform.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connected account
      effect: read
      questions:
      - How do I look up one of my connected accounts?
      - Is a given connected account able to receive payouts yet?
      instructions:
      - text: Show connected account {account}.
        slots:
          account: path.account
      - text: Check the outstanding requirements on connected account {account}.
        slots:
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a connected account
      effect: write
      questions:
      - How do I change information on a connected account?
      - Which connected account details can I still edit after onboarding has started?
      instructions:
      - text: Update connected account {account}.
        slots:
          account: path.account
      - text: Save changes to the business details on account {account}.
        slots:
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a connected account
      effect: destructive
      questions:
      - How do I delete a connected account I manage?
      - Can I delete a live connected account that still has a balance?
      instructions:
      - text: Delete connected account {account}.
        slots:
          account: path.account
      - text: Remove the connected account {account} from my platform.
        slots:
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}/bank_accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a bank account to a connected account
      effect: write
      questions:
      - How do I add a bank account for payouts to a connected account?
      - Can a connected account have more than one bank account on file?
      instructions:
      - text: Add a bank account to connected account {account}.
        slots:
          account: path.account
      - text: Attach a new payout bank account to account {account}.
        slots:
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}/bank_accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connected account's bank account
      effect: read
      questions:
      - How do I look up a bank account on a connected account?
      - Which bank account is the default for payouts on a connected account?
      instructions:
      - text: Show bank account {id} on connected account {account}.
        slots:
          id: path.id
          account: path.account
      - text: Get the details of bank account {id} for account {account}.
        slots:
          id: path.id
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}/bank_accounts/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a connected account's bank account
      effect: write
      questions:
      - How do I change the account holder name on a connected account's bank account?
      - Can I re-enable a disabled bank account on a connected account?
      instructions:
      - text: Update bank account {id} on connected account {account}.
        slots:
          id: path.id
          account: path.account
      - text: Re-enable disabled bank account {id} for account {account}.
        slots:
          id: path.id
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}/bank_accounts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a bank account from a connected account
      effect: destructive
      questions:
      - How do I remove an old bank account from a connected account?
      - Can I delete a bank account a connected account no longer uses?
      instructions:
      - text: Delete bank account {id} from connected account {account}.
        slots:
          id: path.id
          account: path.account
      - text: Remove bank account {id} so account {account} stops using it.
        slots:
          id: path.id
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}/external_accounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a payout destination to a connected account
      effect: write
      questions:
      - How do I add an external account where a connected account receives payouts?
      - Can I add a debit card or bank as a connected account's payout destination?
      instructions:
      - text: Add an external payout account to connected account {account}.
        slots:
          account: path.account
      - text: Create a new payout destination for account {account}.
        slots:
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}/external_accounts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connected account's payout destination
      effect: read
      questions:
      - How do I look up an external account attached to a connected account?
      - Where are a connected account's payouts being sent?
      instructions:
      - text: Show external account {id} on connected account {account}.
        slots:
          id: path.id
          account: path.account
      - text: Get payout destination {id} for account {account}.
        slots:
          id: path.id
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}/external_accounts/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a connected account's payout destination
      effect: write
      questions:
      - How do I make an external account the default payout destination for its currency?
      - What can I change on a connected account's external account?
      instructions:
      - text: Update external account {id} on connected account {account}.
        slots:
          id: path.id
          account: path.account
      - text: Set payout destination {id} as the default for account {account}.
        slots:
          id: path.id
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}/external_accounts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a payout destination from a connected account
      effect: destructive
      questions:
      - How do I delete an external account from a connected account?
      - Can I stop payouts going to an old external account?
      instructions:
      - text: Delete external account {id} from connected account {account}.
        slots:
          id: path.id
          account: path.account
      - text: Remove payout destination {id} from account {account}.
        slots:
          id: path.id
          account: path.account
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/accounts/{account}/reject'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a suspicious connected account
      effect: destructive
      questions:
      - How do I flag a connected account as suspicious or fraudulent?
      - Can I reject a live connected account that still holds a balance?
      instructions:
      - text: Reject connected account {account}.
        slots:
          account: path.account
      - text: Flag account {account} as suspicious and shut it down.
        slots:
          account: path.account
      method: generated
      generated: '2026-09-26'