Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Disputes API

5 actions 5 updates phrasing extends openapi/stripe-disputes-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/disputes'].get
$.paths['/v1/disputes/{dispute}'].get
$.paths['/v1/disputes/{dispute}'].post
$.paths['/v1/disputes/{dispute}/close'].post

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 Disputes API
  version: 1.0.0
extends: openapi/stripe-disputes-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/disputes'].get
  update:
    x-apievangelist-phrasing:
      intent: List disputes
      effect: read
      questions:
      - How do I see all chargebacks against my account?
      - Can I find disputes for a specific charge or PaymentIntent?
      - Which disputes were opened in the last month?
      instructions:
      - text: List my disputes.
      - text: List disputes on charge {charge}.
        slots:
          charge: query.charge
      - text: List disputes for PaymentIntent {payment_intent}.
        slots:
          payment_intent: query.payment_intent
      - text: Show disputes created in {created}.
        slots:
          created: query.created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/disputes/{dispute}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dispute
      effect: read
      questions:
      - How do I check the status and deadline of a dispute?
      - What evidence have I already added to this dispute?
      instructions:
      - text: Show dispute {dispute}.
        slots:
          dispute: path.dispute
      - text: Check the evidence deadline for dispute {dispute}.
        slots:
          dispute: path.dispute
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/disputes/{dispute}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or submit dispute evidence
      effect: write
      questions:
      - How do I fight a chargeback with evidence?
      - Can I save evidence as a draft before submitting it?
      instructions:
      - text: Add evidence {evidence} to dispute {dispute}.
        slots:
          evidence: requestBody.evidence
          dispute: path.dispute
      - text: 'Submit evidence {evidence} on dispute {dispute} now: {submit}.'
        slots:
          evidence: requestBody.evidence
          dispute: path.dispute
          submit: requestBody.submit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/disputes/{dispute}/close'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a dispute
      effect: destructive
      questions:
      - How do I concede a dispute I have no evidence for?
      - Does closing a dispute mean I accept it as lost?
      instructions:
      - text: Close dispute {dispute}.
        slots:
          dispute: path.dispute
      - text: Accept dispute {dispute} as lost.
        slots:
          dispute: path.dispute
      method: generated
      generated: '2026-09-26'