Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Pay Apple API

5 actions 5 updates phrasing extends openapi/stripe-apple-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 5

$.info

$.paths['/v1/apple_pay/domains'].get

$.paths['/v1/apple_pay/domains'].post

$.paths['/v1/apple_pay/domains/{domain}'].get

$.paths['/v1/apple_pay/domains/{domain}'].delete

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 Pay Apple API
  version: 1.0.0
extends: openapi/stripe-apple-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: 4
- target: $.paths['/v1/apple_pay/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered Apple Pay domains
      effect: read
      questions:
      - How do I see which of my websites are registered for Apple Pay?
      - Can I search my registered wallet-payment domains by domain name?
      instructions:
      - text: List my registered Apple Pay domains.
      - text: Search my registered Apple Pay domains for {domain_name}.
        slots:
          domain_name: query.domain_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/apple_pay/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a domain for Apple Pay
      effect: write
      questions:
      - How do I enable Apple Pay on my website's domain?
      - What do I need to register a new site for Apple Pay?
      instructions:
      - text: Register {domain_name} for Apple Pay.
        slots:
          domain_name: requestBody.domain_name
      - text: Add the domain {domain_name} to my Apple Pay domains.
        slots:
          domain_name: requestBody.domain_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/apple_pay/domains/{domain}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an Apple Pay domain
      effect: read
      questions:
      - How do I look up one registered Apple Pay domain?
      - Can I get the details of a specific Apple Pay domain registration?
      instructions:
      - text: Get Apple Pay domain {domain}.
        slots:
          domain: path.domain
      - text: Show the registration record for Apple Pay domain {domain}.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/apple_pay/domains/{domain}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unregister an Apple Pay domain
      effect: destructive
      questions:
      - How do I stop accepting Apple Pay on a website I no longer run?
      - Can I remove a domain from my Apple Pay registrations?
      instructions:
      - text: Delete Apple Pay domain {domain}.
        slots:
          domain: path.domain
      - text: Unregister {domain} from Apple Pay.
        slots:
          domain: path.domain
      method: generated
      generated: '2026-09-26'