Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Payment Method Payment Methods API

7 actions 7 updates phrasing extends openapi/stripe-payment-methods-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 7

$.info
$.paths['/v1/payment_methods'].get
$.paths['/v1/payment_methods'].post
$.paths['/v1/payment_methods/{payment_method}'].get
$.paths['/v1/payment_methods/{payment_method}'].post
$.paths['/v1/payment_methods/{payment_method}/attach'].post
$.paths['/v1/payment_methods/{payment_method}/detach'].post

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 Payment Method Payment Methods API
  version: 1.0.0
extends: openapi/stripe-payment-methods-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: 6
- target: $.paths['/v1/payment_methods'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment methods
      effect: read
      questions:
      - How do I list the payment methods on my account, like cards or bank accounts?
      - Can I filter payment methods by type or by customer?
      instructions:
      - text: List payment methods of type {type}.
        slots:
          type: query.type
      - text: List payment methods for customer {customer}.
        slots:
          customer: query.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_methods'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a payment method
      effect: write
      questions:
      - How do I create a card or bank account payment method from my server?
      - Can I include the customer's billing details when creating a payment method?
      - Should I create payment methods directly or let a PaymentIntent do it?
      instructions:
      - text: Create a {type} payment method with billing details {billing_details}.
        slots:
          type: requestBody.type
          billing_details: requestBody.billing_details
      - text: Create a card payment method from {card}.
        slots:
          card: requestBody.card
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_methods/{payment_method}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a payment method
      effect: read
      questions:
      - How do I see the details of a single saved payment method, like its brand and expiry?
      - What billing details are stored on a payment method?
      instructions:
      - text: Get payment method {payment_method}.
        slots:
          payment_method: path.payment_method
      - text: Show me the card details on payment method {payment_method}.
        slots:
          payment_method: path.payment_method
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_methods/{payment_method}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a payment method
      effect: write
      questions:
      - How do I update the billing address or card expiry on a saved payment method?
      - Does a payment method have to be attached to a customer before I can update it?
      instructions:
      - text: Update billing details on payment method {payment_method} to {billing_details}.
        slots:
          payment_method: path.payment_method
          billing_details: requestBody.billing_details
      - text: Update the card expiry on payment method {payment_method} to {card}.
        slots:
          payment_method: path.payment_method
          card: requestBody.card
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_methods/{payment_method}/attach'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a payment method to a customer
      effect: write
      questions:
      - How do I attach a card to a customer so I can charge it again later?
      - Is attaching directly better than saving a payment method with a SetupIntent?
      instructions:
      - text: Attach payment method {payment_method} to customer {customer}.
        slots:
          payment_method: path.payment_method
          customer: requestBody.customer
      - text: Save {payment_method} on file for customer {customer}.
        slots:
          payment_method: path.payment_method
          customer: requestBody.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_methods/{payment_method}/detach'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a payment method from a customer
      effect: destructive
      questions:
      - How do I remove a saved card from a customer?
      - Can a detached payment method be reattached or used again?
      instructions:
      - text: Detach payment method {payment_method}.
        slots:
          payment_method: path.payment_method
      - text: Remove saved payment method {payment_method} from its customer.
        slots:
          payment_method: path.payment_method
      method: generated
      generated: '2026-09-26'