# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Drip Subscriptions API
  version: 1.0.0
extends: openapi/drippay-subscriptions-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: 7
- target: $.paths['/v1/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriptions
      effect: read
      questions:
      - Which subscriptions does a customer have?
      - Can I list only paused or cancelled subscriptions?
      instructions:
      - text: List subscriptions for customer {customerId}.
        slots:
          customerId: query.customerId
      - text: Show {limit} subscriptions with status {status}.
        slots:
          limit: query.limit
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a recurring subscription
      effect: write
      questions:
      - How do I start charging a customer a recurring monthly fee in USDC?
      - Can a subscription include a free trial and some included usage?
      instructions:
      - text: Subscribe customer {customerId} to {name} at {priceUsdc} USDC every {interval}.
        slots:
          customerId: requestBody.customerId
          name: requestBody.name
          priceUsdc: requestBody.priceUsdc
          interval: requestBody.interval
      - text: Create {name} for {customerId}, {priceUsdc} per {interval}, with a {trialDays}-day trial.
        slots:
          name: requestBody.name
          customerId: requestBody.customerId
          priceUsdc: requestBody.priceUsdc
          interval: requestBody.interval
          trialDays: requestBody.trialDays
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscriptions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription
      effect: read
      questions:
      - What price and billing period is a subscription on?
      - Can I look up one subscription's details?
      instructions:
      - text: Show subscription {id}.
        slots:
          id: path.id
      - text: Get the details of subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscriptions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a subscription
      effect: write
      questions:
      - When does a subscription price change take effect?
      - Can I change the included usage on an existing subscription?
      instructions:
      - text: Change subscription {id} to {priceUsdc} USDC from next period.
        slots:
          id: path.id
          priceUsdc: requestBody.priceUsdc
      - text: Set included usage on subscription {id} to {includedUsage}.
        slots:
          id: path.id
          includedUsage: requestBody.includedUsage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscriptions/{id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a subscription
      effect: destructive
      questions:
      - Does cancelling a subscription stop it immediately or at period end?
      - How do I cancel a customer's subscription right away?
      instructions:
      - text: Cancel subscription {id} at the end of the period.
        slots:
          id: path.id
      - text: Cancel subscription {id} immediately ({immediate}).
        slots:
          id: path.id
          immediate: requestBody.immediate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscriptions/{id}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a subscription
      effect: write
      questions:
      - Can I pause a subscription so no charges are made for a while?
      - Is it possible to set a date for a paused subscription to resume?
      instructions:
      - text: Pause subscription {id}.
        slots:
          id: path.id
      - text: Pause subscription {id} until {resumeDate}.
        slots:
          id: path.id
          resumeDate: requestBody.resumeDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscriptions/{id}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused subscription
      effect: write
      questions:
      - How do I restart billing on a paused subscription?
      - Does resuming a subscription start a new billing period?
      instructions:
      - text: Resume subscription {id}.
        slots:
          id: path.id
      - text: Unpause subscription {id} now.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'