Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Payment Links API

6 actions 6 updates phrasing extends openapi/stripe-payment-links-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_links'].get
$.paths['/v1/payment_links'].post
$.paths['/v1/payment_links/{payment_link}'].get
$.paths['/v1/payment_links/{payment_link}'].post
$.paths['/v1/payment_links/{payment_link}/line_items'].get

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 Links API
  version: 1.0.0
extends: openapi/stripe-payment-links-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_links'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment links
      effect: read
      questions:
      - How do I see all the payment links I've created?
      - Can I list only the payment links that are still active?
      instructions:
      - text: List my payment links.
      - text: List payment links where active is {active}.
        slots:
          active: query.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_links'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a payment link
      effect: write
      questions:
      - How do I create a shareable link customers can use to pay me?
      - Can a payment link let customers enter promotion codes?
      - Can I limit how many times a payment link can be used?
      instructions:
      - text: Create a payment link for {line_items}.
        slots:
          line_items: requestBody.line_items
      - text: 'Create a payment link for {line_items} that accepts promotion codes: {allow_promotion_codes}.'
        slots:
          line_items: requestBody.line_items
          allow_promotion_codes: requestBody.allow_promotion_codes
      - text: Create a payment link for {line_items} with restrictions {restrictions}.
        slots:
          line_items: requestBody.line_items
          restrictions: requestBody.restrictions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_links/{payment_link}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a payment link
      effect: read
      questions:
      - How do I look up the settings of one payment link?
      - Where do I find the URL for a payment link I already made?
      instructions:
      - text: Get payment link {payment_link}.
        slots:
          payment_link: path.payment_link
      - text: Show the details and URL of payment link {payment_link}.
        slots:
          payment_link: path.payment_link
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_links/{payment_link}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update or deactivate a payment link
      effect: write
      questions:
      - How do I turn off a payment link so nobody can use it?
      - Can I show a custom message when someone opens a deactivated payment link?
      instructions:
      - text: Set payment link {payment_link} active to {active}.
        slots:
          payment_link: path.payment_link
          active: requestBody.active
      - text: Deactivate payment link {payment_link} with the message {inactive_message}.
        slots:
          payment_link: path.payment_link
          inactive_message: requestBody.inactive_message
      - text: Update the line items on payment link {payment_link} to {line_items}.
        slots:
          payment_link: path.payment_link
          line_items: requestBody.line_items
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/payment_links/{payment_link}/line_items'].get
  update:
    x-apievangelist-phrasing:
      intent: List a payment link's line items
      effect: read
      questions:
      - How do I see which products a payment link sells?
      - Can I page through all the line items on a payment link?
      instructions:
      - text: List the line items on payment link {payment_link}.
        slots:
          payment_link: path.payment_link
      - text: Show {limit} products included in payment link {payment_link}.
        slots:
          limit: query.limit
          payment_link: path.payment_link
      method: generated
      generated: '2026-09-26'