# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Algovoi Co Uk Subscriptions API
  version: 1.0.0
extends: openapi/algovoi-co-uk-subscriptions-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: 8
- target: $.paths['/v1/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List merchant subscriptions
      effect: read
      questions:
      - Which subscriptions are my customers on as a merchant?
      - Can I list only paused or cancelled subscriptions?
      instructions:
      - text: List my merchant subscriptions.
      - text: Show {limit} subscriptions with status {status}.
        slots:
          limit: query.limit
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a recurring subscription
      effect: write
      questions:
      - How do I bill a customer a fixed crypto amount every month?
      - Can a subscription use a custom interval in days or a billing anchor day?
      - What happens when a subscription payment fails?
      instructions:
      - text: Create a {cadence} subscription of {amount} {currency} for customer {customer_id}.
        slots:
          cadence: requestBody.cadence
          amount: requestBody.amount
          currency: requestBody.currency
          customer_id: requestBody.customer_id
      - text: Start billing {amount} {currency} every {custom_interval_days} days on cadence {cadence}.
        slots:
          amount: requestBody.amount
          currency: requestBody.currency
          custom_interval_days: requestBody.custom_interval_days
          cadence: requestBody.cadence
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptions/{subscription_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription
      effect: read
      questions:
      - What are the billing terms and status of one subscription?
      - Can a merchant fetch a single subscription by id?
      instructions:
      - text: Get subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Show billing terms for subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptions/{subscription_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a subscription's notices and policies
      effect: write
      questions:
      - Can I change how far ahead customers are notified of a charge on an existing subscription?
      - How do I set an existing subscription to cancel at the end of its period?
      instructions:
      - text: Set subscription {subscription_id} to cancel at period end {cancel_at_period_end}.
        slots:
          subscription_id: path.subscription_id
          cancel_at_period_end: requestBody.cancel_at_period_end
      - text: Change subscription {subscription_id} notice lead time to {notify_lead_hours} hours.
        slots:
          subscription_id: path.subscription_id
          notify_lead_hours: requestBody.notify_lead_hours
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptions/{subscription_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a subscription as the merchant
      effect: destructive
      questions:
      - How does a merchant cancel a customer's subscription?
      - Will cancelling stop all future charges on that subscription?
      instructions:
      - text: Cancel merchant subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: End customer subscription {subscription_id} for good.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptions/{subscription_id}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a subscription
      effect: write
      questions:
      - Can I pause billing on a subscription without cancelling it?
      - How do I put a customer's plan on hold?
      instructions:
      - text: Pause subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Hold billing on subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptions/{subscription_id}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume a paused subscription
      effect: write
      questions:
      - How do I restart billing on a paused subscription?
      - Can a paused plan be picked back up?
      instructions:
      - text: Resume subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Restart billing on paused subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/subscriptions/{subscription_id}/invoices'].get
  update:
    x-apievangelist-phrasing:
      intent: List a subscription's invoices
      effect: read
      questions:
      - Which invoices has a subscription generated so far?
      - Can a merchant page through invoices for one subscription?
      instructions:
      - text: List invoices for subscription {subscription_id}.
        slots:
          subscription_id: path.subscription_id
      - text: Show {limit} invoices on subscription {subscription_id}.
        slots:
          limit: query.limit
          subscription_id: path.subscription_id
      method: generated
      generated: '2026-10-01'