# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Subscription Subscription Schedules API
  version: 1.0.0
extends: openapi/stripe-subscription-schedules-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: 6
- target: $.paths['/v1/subscription_schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscription schedules
      effect: read
      questions:
      - How do I see all the subscription changes I've scheduled?
      - Can I list only the schedules that haven't started yet?
      - How do I find schedules for one customer?
      instructions:
      - text: List my subscription schedules.
      - text: List subscription schedules for customer {customer}.
        slots:
          customer: query.customer
      - text: Show schedules that completed {completed_at}.
        slots:
          completed_at: query.completed_at
      - text: 'List only schedules not yet started: {scheduled}.'
        slots:
          scheduled: query.scheduled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscription_schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a subscription with future phases
      effect: write
      questions:
      - How do I set up a subscription that changes price on a future date?
      - Can I move an existing subscription onto a schedule?
      - How many active or scheduled subscriptions can one customer have?
      instructions:
      - text: Create a subscription schedule for customer {customer} with phases {phases}.
        slots:
          customer: requestBody.customer
          phases: requestBody.phases
      - text: Put existing subscription {from_subscription} on a schedule.
        slots:
          from_subscription: requestBody.from_subscription
      - text: Schedule a subscription for {customer} starting {start_date} that ends by {end_behavior}.
        slots:
          customer: requestBody.customer
          start_date: requestBody.start_date
          end_behavior: requestBody.end_behavior
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscription_schedules/{schedule}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription schedule
      effect: read
      questions:
      - How do I see the phases planned for a subscription schedule?
      - Which phase is a schedule currently in?
      instructions:
      - text: Show subscription schedule {schedule}.
        slots:
          schedule: path.schedule
      - text: Get the phases and status of schedule {schedule}.
        slots:
          schedule: path.schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscription_schedules/{schedule}'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a subscription schedule's phases
      effect: write
      questions:
      - How do I change the upcoming phases of a scheduled subscription?
      - Are changes to the current phase prorated?
      instructions:
      - text: Replace the phases on schedule {schedule} with {phases}.
        slots:
          schedule: path.schedule
          phases: requestBody.phases
      - text: Update schedule {schedule} phases to {phases} with proration {proration_behavior}.
        slots:
          schedule: path.schedule
          phases: requestBody.phases
          proration_behavior: requestBody.proration_behavior
      - text: Change what happens when schedule {schedule} ends to {end_behavior}.
        slots:
          schedule: path.schedule
          end_behavior: requestBody.end_behavior
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscription_schedules/{schedule}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a subscription schedule and its subscription
      effect: destructive
      questions:
      - How do I cancel a scheduled subscription immediately?
      - Will canceling a schedule send a final invoice for unbilled usage?
      - Can I cancel a schedule that has already completed?
      instructions:
      - text: Cancel subscription schedule {schedule}.
        slots:
          schedule: path.schedule
      - text: 'Cancel schedule {schedule} without prorating: prorate {prorate}.'
        slots:
          schedule: path.schedule
          prorate: requestBody.prorate
      - text: 'Cancel schedule {schedule} and invoice now: {invoice_now}.'
        slots:
          schedule: path.schedule
          invoice_now: requestBody.invoice_now
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/subscription_schedules/{schedule}/release'].post
  update:
    x-apievangelist-phrasing:
      intent: Release a subscription from its schedule
      effect: write
      questions:
      - How do I stop a schedule but keep the customer's subscription running?
      - Can I keep a planned cancellation date when releasing a schedule?
      instructions:
      - text: Release subscription schedule {schedule}.
        slots:
          schedule: path.schedule
      - text: 'Release schedule {schedule} and keep the cancel date: {preserve_cancel_date}.'
        slots:
          schedule: path.schedule
          preserve_cancel_date: requestBody.preserve_cancel_date
      method: generated
      generated: '2026-09-26'