Drippay · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drip Dunning API

6 actions 6 updates phrasing extends openapi/drippay-dunning-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Drippay's API. It is a proposal applied on top of the contract, not a document Drippay publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v1/dunning/schedule'].get

$.paths['/v1/dunning/schedule'].put

$.paths['/v1/collections'].get

$.paths['/v1/collections/{id}'].get

$.paths['/v1/collections/{id}/retry'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Drip Dunning API
  version: 1.0.0
extends: openapi/drippay-dunning-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/dunning/schedule'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the dunning retry schedule
      effect: read
      questions:
      - How often are failed payments retried for my business?
      - Am I using a custom dunning schedule or the system default?
      instructions:
      - text: Show my active dunning schedule.
      - text: Get the retry schedule for failed payments.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dunning/schedule'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the dunning retry schedule
      effect: write
      questions:
      - Can I choose on which days after a failure payments are retried?
      - How do I attach a final-notice email to a retry step?
      instructions:
      - text: Replace my dunning schedule with new retry steps.
      - text: Configure which days after a failure to retry payment and which notice email to send.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections'].get
  update:
    x-apievangelist-phrasing:
      intent: List failed payments in collections
      effect: read
      questions:
      - Which failed payments are currently being retried?
      - Can I see a customer's open collections and when the next retry is?
      instructions:
      - text: List failed payments in collections.
      - text: Show open collections with their next retry time.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one failed payment's detail
      effect: read
      questions:
      - What's the retry history for one failed payment?
      - Why did a specific collection retry fail?
      instructions:
      - text: Show failed payment {id}.
        slots:
          id: path.id
      - text: Get retry history and resolution for collection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/collections/{id}/retry'].post
  update:
    x-apievangelist-phrasing:
      intent: Manually retry a failed payment
      effect: write
      questions:
      - Can I retry a failed payment now instead of waiting for the schedule?
      - Do manual payment retries work when the dunning scheduler is off?
      instructions:
      - text: Retry failed payment {id} now.
        slots:
          id: path.id
      - text: Manually re-attempt collection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'