# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Setup Setup Intents API
  version: 1.0.0
extends: openapi/stripe-setup-intents-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: 7
- target: $.paths['/v1/setup_intents'].get
  update:
    x-apievangelist-phrasing:
      intent: List SetupIntents
      effect: read
      questions:
      - How do I see all the attempts to save customers' payment details for later?
      - Can I list SetupIntents for one customer or one payment method?
      instructions:
      - text: List my recent SetupIntents.
      - text: List SetupIntents for customer {customer}.
        slots:
          customer: query.customer
      - text: List SetupIntents that used payment method {payment_method}.
        slots:
          payment_method: query.payment_method
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/setup_intents'].post
  update:
    x-apievangelist-phrasing:
      intent: Start saving a payment method for later
      effect: write
      questions:
      - How do I save a customer's card so I can charge them later without them present?
      - Can I create and confirm a SetupIntent in one call?
      - Can I choose whether the saved payment method is for on-session or off-session use?
      instructions:
      - text: Create a SetupIntent for customer {customer}.
        slots:
          customer: requestBody.customer
      - text: Create a SetupIntent for customer {customer} with usage {usage}.
        slots:
          customer: requestBody.customer
          usage: requestBody.usage
      - text: Create and confirm a SetupIntent for payment method {payment_method} with confirm set to {confirm}.
        slots:
          payment_method: requestBody.payment_method
          confirm: requestBody.confirm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/setup_intents/{intent}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a SetupIntent
      effect: read
      questions:
      - How do I check whether a customer finished saving their payment method?
      - Can I retrieve a SetupIntent from the browser using its client secret?
      instructions:
      - text: Get SetupIntent {intent}.
        slots:
          intent: path.intent
      - text: Fetch SetupIntent {intent} using client secret {client_secret}.
        slots:
          intent: path.intent
          client_secret: query.client_secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/setup_intents/{intent}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a SetupIntent
      effect: write
      questions:
      - Can I change the customer or payment method on a SetupIntent before confirming it?
      - How do I update the allowed payment method types on an existing SetupIntent?
      instructions:
      - text: Attach customer {customer} to SetupIntent {intent}.
        slots:
          customer: requestBody.customer
          intent: path.intent
      - text: Set payment method {payment_method} on SetupIntent {intent}.
        slots:
          payment_method: requestBody.payment_method
          intent: path.intent
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/setup_intents/{intent}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a SetupIntent
      effect: destructive
      questions:
      - How do I abandon saving a customer's payment method?
      - In which statuses can a SetupIntent still be cancelled?
      instructions:
      - text: Cancel SetupIntent {intent}.
        slots:
          intent: path.intent
      - text: Cancel SetupIntent {intent} with reason {cancellation_reason}.
        slots:
          intent: path.intent
          cancellation_reason: requestBody.cancellation_reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/setup_intents/{intent}/confirm'].post
  update:
    x-apievangelist-phrasing:
      intent: Confirm saving a payment method
      effect: write
      questions:
      - What do I call when the customer clicks Save on my payment details page?
      - Can I pass the payment method and return URL for redirect-based methods when confirming?
      instructions:
      - text: Confirm SetupIntent {intent}.
        slots:
          intent: path.intent
      - text: Confirm SetupIntent {intent} with payment method {payment_method} and return to {return_url}.
        slots:
          intent: path.intent
          payment_method: requestBody.payment_method
          return_url: requestBody.return_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/setup_intents/{intent}/verify_microdeposits'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify bank account microdeposits
      effect: write
      questions:
      - How do I verify a customer's bank account using the small test deposits?
      - Can I verify microdeposits with a descriptor code instead of the two amounts?
      instructions:
      - text: Verify microdeposits of {amounts} on SetupIntent {intent}.
        slots:
          amounts: requestBody.amounts
          intent: path.intent
      - text: Verify SetupIntent {intent} with descriptor code {descriptor_code}.
        slots:
          intent: path.intent
          descriptor_code: requestBody.descriptor_code
      method: generated
      generated: '2026-09-26'