# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Drip Billable Metrics API
  version: 1.0.0
extends: openapi/drippay-billable-metrics-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: 7
- target: $.paths['/v1/billable-metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: List billable metrics
      effect: read
      questions:
      - Which billable metrics have I defined?
      - Can I see every metric I bill usage on?
      instructions:
      - text: List my billable metrics.
      - text: Show all the metrics defined for my business.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/billable-metrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a billable metric
      effect: write
      questions:
      - How do I define a metric that bills on several event types at once?
      - Does a billable metric's name have to be unique?
      instructions:
      - text: Create a billable metric that unions my usage event types.
      - text: Define a new billable metric for my business.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/billable-metrics/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a billable metric
      effect: read
      questions:
      - What event types and aggregation does one metric use?
      - Can I fetch a single billable metric by ID?
      instructions:
      - text: Show billable metric {id}.
        slots:
          id: path.id
      - text: Get the definition of metric {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/billable-metrics/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a billable metric
      effect: destructive
      questions:
      - What happens to historical charges if I delete a billable metric?
      - How do I retire a metric I no longer bill on?
      instructions:
      - text: Delete billable metric {id}.
        slots:
          id: path.id
      - text: Soft-delete metric {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/billable-metrics/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a billable metric
      effect: write
      questions:
      - Can I change the definition of an existing billable metric?
      - How do I edit a metric I've already saved?
      instructions:
      - text: Update billable metric {id}.
        slots:
          id: path.id
      - text: Edit the saved definition of metric {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/billable-metrics/{id}/evaluate'].post
  update:
    x-apievangelist-phrasing:
      intent: Evaluate a saved metric over a period
      effect: read
      questions:
      - What value would a saved metric produce over a given billing period?
      - Can I dry-run a billable metric against real usage without creating charges?
      instructions:
      - text: Evaluate billable metric {id} over a period.
        slots:
          id: path.id
      - text: Run metric {id} against my usage events without billing anything.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/billable-metrics/preview'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview an unsaved metric SQL expression
      effect: read
      questions:
      - Can I test a SQL expression for a metric before I save it?
      - What would a draft metric query return on my events?
      instructions:
      - text: Preview this unsaved metric SQL expression.
      - text: Test a draft sqlExpression before creating the metric.
      method: generated
      generated: '2026-10-01'