ThriveCart · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ThriveCart Transactions API

2 actions 2 updates phrasing extends openapi/thrivecart-transactions-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/transactions'].get

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 ThriveCart Transactions API
  version: 1.0.0
extends: openapi/thrivecart-transactions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: Search transaction activity
      effect: read
      questions:
      - How do I find all the charges and refunds for a customer email?
      - Can I filter transactions to only rebills or cancellations?
      - Is it possible to limit a transaction search to one currency?
      instructions:
      - text: Search transactions for {query} of type {transactionType}, page {page} with {perPage} per page, currency {currency}.
        slots:
          query: query.query
          transactionType: query.transactionType
          page: query.page
          perPage: query.perPage
          currency: query.currency
      - text: Find refund events matching {query} in {currency}, page {page}, {perPage} per page, type {transactionType}.
        slots:
          query: query.query
          currency: query.currency
          page: query.page
          perPage: query.perPage
          transactionType: query.transactionType
      method: generated
      generated: '2026-10-01'