Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Coupons API

6 actions 6 updates phrasing extends openapi/stripe-coupons-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/coupons'].get
$.paths['/v1/coupons'].post
$.paths['/v1/coupons/{coupon}'].get
$.paths['/v1/coupons/{coupon}'].post
$.paths['/v1/coupons/{coupon}'].delete

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 Coupons API
  version: 1.0.0
extends: openapi/stripe-coupons-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/coupons'].get
  update:
    x-apievangelist-phrasing:
      intent: List coupons
      effect: read
      questions:
      - What coupons have I created?
      - Can I list coupons created in a certain date range?
      instructions:
      - text: List my coupons.
      - text: List coupons created in {created}.
        slots:
          created: query.created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/coupons'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a coupon
      effect: write
      questions:
      - How do I create a percentage-off discount?
      - Can a coupon apply for a set number of months?
      - Can I cap how many times a coupon is redeemed?
      instructions:
      - text: Create a {percent_off}% off coupon with duration {duration}.
        slots:
          percent_off: requestBody.percent_off
          duration: requestBody.duration
      - text: Create a coupon for {amount_off} {currency} off, duration {duration}.
        slots:
          amount_off: requestBody.amount_off
          currency: requestBody.currency
          duration: requestBody.duration
      - text: 'Create a {percent_off}% coupon lasting {duration_in_months} months, repeating: {duration}.'
        slots:
          percent_off: requestBody.percent_off
          duration_in_months: requestBody.duration_in_months
          duration: requestBody.duration
      - text: Create coupon {name} at {percent_off}% off, max {max_redemptions} uses, duration {duration}.
        slots:
          name: requestBody.name
          percent_off: requestBody.percent_off
          max_redemptions: requestBody.max_redemptions
          duration: requestBody.duration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/coupons/{coupon}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a coupon
      effect: read
      questions:
      - How do I check the terms of a coupon?
      - How many times has this coupon been redeemed?
      instructions:
      - text: Show coupon {coupon}.
        slots:
          coupon: path.coupon
      - text: Check the redemptions on coupon {coupon}.
        slots:
          coupon: path.coupon
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/coupons/{coupon}'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename or tag a coupon
      effect: write
      questions:
      - How do I rename a coupon?
      - Can I change a coupon's discount amount or duration after creating it?
      instructions:
      - text: Rename coupon {coupon} to {name}.
        slots:
          coupon: path.coupon
          name: requestBody.name
      - text: Set metadata {metadata} on coupon {coupon}.
        slots:
          metadata: requestBody.metadata
          coupon: path.coupon
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/coupons/{coupon}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a coupon
      effect: destructive
      questions:
      - How do I stop a coupon from being used by new customers?
      - Does deleting a coupon remove the discount from existing customers?
      instructions:
      - text: Delete coupon {coupon}.
        slots:
          coupon: path.coupon
      - text: Retire coupon {coupon} so no one new can redeem it.
        slots:
          coupon: path.coupon
      method: generated
      generated: '2026-09-26'