# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for PAY.JP Subscriptions API
  version: 1.0.0
extends: openapi/payjp-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: 8
- target: $.paths['/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscriptions
      effect: read
      questions:
      - How do I see all my active and past subscriptions?
      - Which customers are subscribed to plans?
      instructions:
      - text: List my subscriptions.
      - text: Show every subscription on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a customer to a plan
      effect: write
      questions:
      - How do I put a customer on a recurring plan?
      - Can I prorate the first charge when a subscription starts mid-cycle?
      instructions:
      - text: Subscribe customer {customer} to plan {plan}.
        slots:
          customer: requestBody.customer
          plan: requestBody.plan
      - text: Start plan {plan} for customer {customer} with proration {prorate}.
        slots:
          plan: requestBody.plan
          customer: requestBody.customer
          prorate: requestBody.prorate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription
      effect: read
      questions:
      - How do I check the status of one subscription?
      - Is a particular subscription active, paused or canceled?
      instructions:
      - text: Show subscription {id}.
        slots:
          id: path.id
      - text: Get the current status of subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a subscription
      effect: write
      questions:
      - How do I change the settings on an existing subscription?
      - Can I modify a subscription without canceling it?
      instructions:
      - text: Update subscription {id}.
        slots:
          id: path.id
      - text: Change the settings of existing subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscription
      effect: destructive
      questions:
      - How do I delete a subscription record entirely?
      - Can I remove a subscription outright rather than just canceling it?
      instructions:
      - text: Delete subscription {id}.
        slots:
          id: path.id
      - text: Permanently remove subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{id}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a subscription
      effect: write
      questions:
      - Can I temporarily stop billing a subscriber?
      - How do I put a subscription on hold?
      instructions:
      - text: Pause subscription {id}.
        slots:
          id: path.id
      - text: Put subscription {id} on hold so it stops billing.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/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?
      - Can a paused subscription be reactivated?
      instructions:
      - text: Resume paused subscription {id}.
        slots:
          id: path.id
      - text: Reactivate subscription {id} after its pause.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a subscription
      effect: destructive
      questions:
      - How do I cancel a customer's subscription?
      - What call stops a subscription from renewing?
      instructions:
      - text: Cancel subscription {id}.
        slots:
          id: path.id
      - text: Stop subscription {id} from renewing.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'