# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Billing Management Initiate Billing API
  version: 1.0.0
extends: openapi/conga-initiate-billing-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: 13
- target: $.paths['/schedules/adjustments/apply-adjustment'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply adjustments to a billing schedule
      effect: write
      questions:
      - How do I apply an adjustment to a billing schedule?
      - Can I adjust scheduled billing amounts after creation?
      instructions:
      - text: Apply the adjustments to the billing schedule.
      - text: Post these billing schedule adjustments.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/adjustments/update-approval-stage'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a billing adjustment's approval stage
      effect: write
      questions:
      - How do I move a billing adjustment to the next approval stage?
      - Can I approve a billing schedule detail adjustment?
      instructions:
      - text: Update the approval stage of the billing schedule details.
      - text: Advance the selected adjustments to the next approval stage.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/amend'].post
  update:
    x-apievangelist-phrasing:
      intent: Amend billing schedules
      effect: write
      questions:
      - How do I update billing schedules after an order is amended?
      - Can I set a ready-for-billing date when amending schedules?
      instructions:
      - text: Amend billing schedules for order line items {items}.
        slots:
          items: requestBody.OrderLineItemIds
      - text: Amend schedules for {items} ready to bill on {date}.
        slots:
          items: requestBody.OrderLineItemIds
          date: requestBody.ReadyForBillingDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/delete-adjustments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete billing schedule adjustments
      effect: destructive
      questions:
      - Can I remove adjustment lines from a billing schedule?
      - How do I undo billing schedule adjustments?
      instructions:
      - text: Delete the adjustment billing schedule details.
      - text: Remove the selected billing adjustments.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/evergreen/renew'].post
  update:
    x-apievangelist-phrasing:
      intent: Renew evergreen billing schedules
      effect: write
      questions:
      - How do I extend billing on evergreen subscriptions?
      - Can I renew all evergreen schedules in one run?
      instructions:
      - text: Renew the evergreen billing schedules.
      - text: Extend billing for evergreen subscriptions in bulk.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/evergreen/{scheduleId}/renew'].post
  update:
    x-apievangelist-phrasing:
      intent: Renew one evergreen billing schedule
      effect: write
      questions:
      - Can I renew just a single evergreen schedule?
      - How do I extend one evergreen subscription's billing?
      instructions:
      - text: Renew evergreen schedule {schedule}.
        slots:
          schedule: path.scheduleId
      - text: Extend billing on evergreen schedule {schedule}.
        slots:
          schedule: path.scheduleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/initiate'].post
  update:
    x-apievangelist-phrasing:
      intent: Create billing records from order line item status
      effect: write
      questions:
      - How do I start billing for activated order line items?
      - Can billing initiation run asynchronously?
      instructions:
      - text: Initiate billing for order line items {items}.
        slots:
          items: requestBody.OrderLineItemIds
      - text: Create billing records for {items} ready on {date}.
        slots:
          items: requestBody.OrderLineItemIds
          date: requestBody.ReadyForBillingDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/new'].post
  update:
    x-apievangelist-phrasing:
      intent: Create billing schedules for new sales
      effect: write
      questions:
      - How do I create billing schedules for newly sold line items?
      - Can I generate schedules for new-sale order lines only?
      instructions:
      - text: Create billing schedules for new-sale line items {items}.
        slots:
          items: requestBody.OrderLineItemIds
      - text: Set up schedules for new order lines {items} billing from {date}.
        slots:
          items: requestBody.OrderLineItemIds
          date: requestBody.ReadyForBillingDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/renew'].post
  update:
    x-apievangelist-phrasing:
      intent: Renew billing schedules
      effect: write
      questions:
      - How do I extend billing schedules for renewed subscriptions?
      - Can I renew billing schedules in bulk?
      instructions:
      - text: Renew the billing schedules for renewed line items.
      - text: Run the schedule renewal for renewed subscriptions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/swap'].post
  update:
    x-apievangelist-phrasing:
      intent: Swap billing schedules
      effect: write
      questions:
      - How do billing schedules change when a product is swapped?
      - Can I swap schedules for specific order lines?
      instructions:
      - text: Swap billing schedules for line items {items}.
        slots:
          items: requestBody.OrderLineItemIds
      - text: Swap schedules on {items} effective {date}.
        slots:
          items: requestBody.OrderLineItemIds
          date: requestBody.ReadyForBillingDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/terminate'].post
  update:
    x-apievangelist-phrasing:
      intent: Terminate billing schedules
      effect: destructive
      questions:
      - How do I stop billing for terminated subscriptions?
      - Can I end billing schedules early?
      instructions:
      - text: Terminate the billing schedules for cancelled line items.
      - text: End billing on terminated subscriptions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/{billingHeaderId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get billing schedules for a billing header
      effect: read
      questions:
      - Which billing schedules belong to a billing header?
      - Can I see the schedule lines for one header?
      instructions:
      - text: Get billing schedules for header {header}.
        slots:
          header: path.billingHeaderId
      - text: Show the schedules under billing header {header}.
        slots:
          header: path.billingHeaderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/schedules/{orderId}/initiate'].post
  update:
    x-apievangelist-phrasing:
      intent: Initiate billing for a whole order
      effect: write
      questions:
      - Can I start billing for every line on an order at once?
      - How do I bill an entire order from a given date?
      instructions:
      - text: Initiate billing for all lines on order {order}.
        slots:
          order: path.orderId
      - text: Start billing order {order} from {date}.
        slots:
          order: path.orderId
          date: requestBody.ReadyForBillingDate
      method: generated
      generated: '2026-10-01'