Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Billing API

3 actions 3 updates phrasing extends openapi/live-direct-marketing-online-billing-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/api/billing/balance'].get

$.paths['/api/billing/ledger'].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 Live Direct Marketing Online Billing API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-billing-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: 2
- target: $.paths['/api/billing/balance'].get
  update:
    x-apievangelist-phrasing:
      intent: Check account balance and operation prices
      effect: read
      questions:
      - How much money is left on my account balance?
      - What does each send, render or audit cost, and where do I top up?
      instructions:
      - text: Show my account balance in USD.
      - text: List operation prices and the top-up link.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/billing/ledger'].get
  update:
    x-apievangelist-phrasing:
      intent: List balance charges and credits
      effect: read
      questions:
      - What has been charged to my balance for a given campaign?
      - Can I see only refunds or credits in the billing ledger?
      instructions:
      - text: Show billing ledger entries for campaign {campaignId}.
        slots:
          campaignId: query.campaignId
      - text: List the last {limit} {entryType} ledger entries.
        slots:
          limit: query.limit
          entryType: query.entryType
      - text: Continue the ledger from cursor {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'