# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Credit Notes API
  version: 1.0.0
extends: openapi/stripe-credit-notes-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: 8
- target: $.paths['/v1/credit_notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List credit notes
      effect: read
      questions:
      - How do I see all the credit notes I've issued against invoices?
      - Can I list the credit notes for one customer or one invoice?
      instructions:
      - text: List my recent credit notes.
      - text: List credit notes for customer {customer}.
        slots:
          customer: query.customer
      - text: List credit notes issued against invoice {invoice}.
        slots:
          invoice: query.invoice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/credit_notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue a credit note on an invoice
      effect: write
      questions:
      - How do I reduce what a customer owes on a finalized invoice?
      - Can a credit note refund money on an invoice that's already paid, or credit the customer's balance instead?
      - Can I record a reason and a memo on a credit note?
      instructions:
      - text: Issue a credit note for {amount} on invoice {invoice}.
        slots:
          amount: requestBody.amount
          invoice: requestBody.invoice
      - text: Credit invoice {invoice} for reason {reason} with memo {memo}.
        slots:
          invoice: requestBody.invoice
          reason: requestBody.reason
          memo: requestBody.memo
      - text: Issue a credit note on paid invoice {invoice} that refunds {refund_amount}.
        slots:
          invoice: requestBody.invoice
          refund_amount: requestBody.refund_amount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/credit_notes/preview'].get
  update:
    x-apievangelist-phrasing:
      intent: Preview a credit note before issuing it
      effect: read
      questions:
      - Can I see what a credit note would look like before I actually issue it?
      - How do I check the effect of a credit on an invoice total without committing it?
      instructions:
      - text: Preview a credit note for {amount} on invoice {invoice}.
        slots:
          amount: query.amount
          invoice: query.invoice
      - text: Show me a draft credit note for invoice {invoice} with reason {reason}.
        slots:
          invoice: query.invoice
          reason: query.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/credit_notes/preview/lines'].get
  update:
    x-apievangelist-phrasing:
      intent: List line items of a credit note preview
      effect: read
      questions:
      - How do I page through every line item in a previewed credit note?
      - Can I see the full list of credited lines before issuing the credit note?
      instructions:
      - text: List the preview credit note lines for invoice {invoice}.
        slots:
          invoice: query.invoice
      - text: Show all line items of a previewed credit for invoice {invoice} with lines {lines}.
        slots:
          invoice: query.invoice
          lines: query.lines
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/credit_notes/{credit_note}/lines'].get
  update:
    x-apievangelist-phrasing:
      intent: List line items on a credit note
      effect: read
      questions:
      - How do I get every line item on a credit note I already issued?
      - Can I page through a long list of credit note lines?
      instructions:
      - text: List the line items on credit note {credit_note}.
        slots:
          credit_note: path.credit_note
      - text: Show the first {limit} lines of credit note {credit_note}.
        slots:
          limit: query.limit
          credit_note: path.credit_note
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/credit_notes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a credit note
      effect: read
      questions:
      - How do I view the details of one credit note?
      - What amount and reason are recorded on a specific credit note?
      instructions:
      - text: Get credit note {id}.
        slots:
          id: path.id
      - text: Show me the amount and status of credit note {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/credit_notes/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a credit note's memo
      effect: write
      questions:
      - Can I change the memo on a credit note after it's issued?
      - How do I add my own metadata to an existing credit note?
      instructions:
      - text: Set the memo on credit note {id} to {memo}.
        slots:
          id: path.id
          memo: requestBody.memo
      - text: Add metadata {metadata} to credit note {id}.
        slots:
          metadata: requestBody.metadata
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/credit_notes/{id}/void'].post
  update:
    x-apievangelist-phrasing:
      intent: Void a credit note
      effect: destructive
      questions:
      - How do I cancel a credit note I issued by mistake?
      - What happens when I void a credit note?
      instructions:
      - text: Void credit note {id}.
        slots:
          id: path.id
      - text: Mark credit note {id} as void.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'