Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Payment Method Payment Method Domains API

6 actions 6 updates phrasing extends openapi/stripe-payment-method-domains-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/payment_method_domains'].get

$.paths['/v1/payment_method_domains'].post

$.paths['/v1/payment_method_domains/{payment_method_domain}'].get

$.paths['/v1/payment_method_domains/{payment_method_domain}'].post

$.paths['/v1/payment_method_domains/{payment_method_domain}/validate'].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 Payment Method Payment Method Domains API
  version: 1.0.0
extends: openapi/stripe-payment-method-domains-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/payment_method_domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment method domains
      effect: read
      questions:
      - Which domains have I registered to show wallet payment methods?
      - Can I filter my registered payment method domains by domain name?
      - Which of my payment method domains are disabled?
      instructions:
      - text: List my payment method domains.
      - text: Find the payment method domain for {domain_name}.
        slots:
          domain_name: query.domain_name
      - text: List payment method domains where enabled is {enabled}.
        slots:
          enabled: query.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_method_domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a domain for payment methods
      effect: write
      questions:
      - How do I register my checkout domain so wallet buttons show up?
      - Can I add a domain but leave it disabled for now?
      instructions:
      - text: Register {domain_name} as a payment method domain.
        slots:
          domain_name: requestBody.domain_name
      - text: Add payment method domain {domain_name} with enabled set to {enabled}.
        slots:
          domain_name: requestBody.domain_name
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_method_domains/{payment_method_domain}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a payment method domain
      effect: read
      questions:
      - How do I see which payment methods are available on a registered domain?
      - Is my domain verified for every wallet payment method?
      instructions:
      - text: Show payment method domain {payment_method_domain}.
        slots:
          payment_method_domain: path.payment_method_domain
      - text: Check the verification status of domain {payment_method_domain}.
        slots:
          payment_method_domain: path.payment_method_domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_method_domains/{payment_method_domain}'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable or disable a payment method domain
      effect: write
      questions:
      - How do I stop showing payment methods on one of my domains?
      - Can I turn a payment method domain back on?
      instructions:
      - text: Set enabled to {enabled} on payment method domain {payment_method_domain}.
        slots:
          enabled: requestBody.enabled
          payment_method_domain: path.payment_method_domain
      - text: Disable payment method domain {payment_method_domain}.
        slots:
          payment_method_domain: path.payment_method_domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_method_domains/{payment_method_domain}/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-verify a payment method domain
      effect: write
      questions:
      - How do I retry domain verification after fixing the setup?
      - Why isn't a wallet payment method active on my domain yet?
      instructions:
      - text: Validate payment method domain {payment_method_domain} again.
        slots:
          payment_method_domain: path.payment_method_domain
      - text: Re-run verification for domain {payment_method_domain}.
        slots:
          payment_method_domain: path.payment_method_domain
      method: generated
      generated: '2026-09-26'