# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Checkout API
  version: 1.0.0
extends: openapi/stripe-checkout-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/checkout/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Checkout Sessions
      effect: read
      questions:
      - How do I list the checkout sessions my customers have started?
      - Can I find the checkout session behind a specific payment?
      - Can I list only completed or expired checkout sessions?
      instructions:
      - text: List my Checkout Sessions.
      - text: Find the Checkout Session for PaymentIntent {payment_intent}.
        slots:
          payment_intent: query.payment_intent
      - text: List Checkout Sessions with status {status} for customer {customer}.
        slots:
          status: query.status
          customer: query.customer
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checkout/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Checkout Session
      effect: write
      questions:
      - How do I send a customer to a hosted payment page?
      - Can I use hosted checkout for subscriptions as well as one-time payments?
      - Can customers enter promotion codes on the checkout page?
      instructions:
      - text: Create a Checkout Session in {mode} mode for {line_items} redirecting to {success_url}.
        slots:
          mode: requestBody.mode
          line_items: requestBody.line_items
          success_url: requestBody.success_url
      - text: Start a checkout for customer {customer} with items {line_items}.
        slots:
          customer: requestBody.customer
          line_items: requestBody.line_items
      - text: Create a checkout page for {customer_email} that expires at {expires_at}.
        slots:
          customer_email: requestBody.customer_email
          expires_at: requestBody.expires_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checkout/sessions/{session}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a Checkout Session
      effect: read
      questions:
      - How do I check whether a customer finished paying on the checkout page?
      - Can I look up a checkout session after the customer is redirected back?
      instructions:
      - text: Get Checkout Session {session}.
        slots:
          session: path.session
      - text: Show the payment status of checkout {session}.
        slots:
          session: path.session
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checkout/sessions/{session}/expire'].post
  update:
    x-apievangelist-phrasing:
      intent: Expire an open Checkout Session
      effect: destructive
      questions:
      - How do I stop a customer from completing an open checkout?
      - Can I expire a checkout session that's already complete?
      instructions:
      - text: Expire Checkout Session {session}.
        slots:
          session: path.session
      - text: Close checkout {session} so it can no longer be paid.
        slots:
          session: path.session
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/checkout/sessions/{session}/line_items'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Checkout Session's line items
      effect: read
      questions:
      - How do I see exactly what a customer bought in a checkout session?
      - Can I page through all the line items in a checkout?
      instructions:
      - text: List the line items in Checkout Session {session}.
        slots:
          session: path.session
      - text: Show {limit} items purchased in checkout {session}.
        slots:
          limit: query.limit
          session: path.session
      method: generated
      generated: '2026-09-26'