# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Promotion Codes API
  version: 1.0.0
extends: openapi/stripe-promotion-codes-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/promotion_codes'].get
  update:
    x-apievangelist-phrasing:
      intent: List promotion codes
      effect: read
      questions:
      - What promotion codes do I have running?
      - Can I look up a promotion code by the code customers type in?
      - Which promotion codes point to a given coupon?
      instructions:
      - text: List my promotion codes.
      - text: Find the promotion code {code}.
        slots:
          code: query.code
      - text: List promotion codes for coupon {coupon}.
        slots:
          coupon: query.coupon
      - text: List promotion codes where active is {active}.
        slots:
          active: query.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/promotion_codes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a promotion code
      effect: write
      questions:
      - How do I create a code customers can type at checkout?
      - Can I limit a promotion code to one customer?
      - Can a promotion code expire on a set date?
      instructions:
      - text: Create promotion code {code} for coupon {coupon}.
        slots:
          code: requestBody.code
          coupon: requestBody.coupon
      - text: Create a code for coupon {coupon} that only customer {customer} can use.
        slots:
          coupon: requestBody.coupon
          customer: requestBody.customer
      - text: Create code {code} on coupon {coupon}, expiring {expires_at}, max {max_redemptions} uses.
        slots:
          code: requestBody.code
          coupon: requestBody.coupon
          expires_at: requestBody.expires_at
          max_redemptions: requestBody.max_redemptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/promotion_codes/{promotion_code}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a promotion code
      effect: read
      questions:
      - How do I see a promotion code's restrictions and redemptions?
      - Is this promotion code still active?
      instructions:
      - text: Show promotion code {promotion_code}.
        slots:
          promotion_code: path.promotion_code
      - text: Check how often promotion code {promotion_code} has been redeemed.
        slots:
          promotion_code: path.promotion_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/promotion_codes/{promotion_code}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a promotion code
      effect: write
      questions:
      - How do I deactivate a promotion code?
      - What can I change on a promotion code after creating it?
      instructions:
      - text: Set promotion code {promotion_code} active to {active}.
        slots:
          promotion_code: path.promotion_code
          active: requestBody.active
      - text: Change the restrictions on promotion code {promotion_code} to {restrictions}.
        slots:
          promotion_code: path.promotion_code
          restrictions: requestBody.restrictions
      method: generated
      generated: '2026-09-26'