# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Subscription Lines API
  version: 1.0.0
extends: openapi/optimizely-subscription-lines-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: 9
- target: $.paths['/api/v1/admin/SubscriptionLines'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscription lines
      effect: read
      questions:
      - Which products are on my customers' recurring subscriptions?
      - Can I filter subscription lines to one subscription?
      - How many subscription line records exist?
      instructions:
      - text: List all subscription lines.
      - text: List subscription lines matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} subscription lines ordered by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SubscriptionLines'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a product to a subscription
      effect: write
      questions:
      - How do I add a product line to a recurring subscription?
      - Can I set the quantity and price when adding a subscription line?
      instructions:
      - text: Add product {productId} to subscription {subscriptionId} with quantity {qtyOrdered}.
        slots:
          productId: requestBody.productId
          subscriptionId: requestBody.subscriptionId
          qtyOrdered: requestBody.qtyOrdered
      - text: Create a subscription line for product {productId} priced at {price}.
        slots:
          productId: requestBody.productId
          price: requestBody.price
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SubscriptionLines({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription line
      effect: read
      questions:
      - What product, quantity and price are on a specific subscription line?
      - Can I fetch one subscription line by ID?
      instructions:
      - text: Get subscription line {id}.
        slots:
          id: path.id
      - text: Show the product and quantity on subscription line {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SubscriptionLines({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a subscription line
      effect: write
      questions:
      - How do I overwrite a subscription line record completely?
      - Does replacing a subscription line reset fields I leave out?
      instructions:
      - text: Replace subscription line {id} with product {productId} at quantity {qtyOrdered}.
        slots:
          id: path.id
          productId: requestBody.productId
          qtyOrdered: requestBody.qtyOrdered
      - text: Overwrite all fields of subscription line {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SubscriptionLines({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a subscription line
      effect: destructive
      questions:
      - Can I remove one product line from a subscription?
      - Is it possible to delete a subscription line only if its ETag matches?
      instructions:
      - text: Delete subscription line {id}.
        slots:
          id: path.id
      - text: Delete subscription line {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SubscriptionLines({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a subscription line
      effect: write
      questions:
      - How do I change the quantity on an existing subscription line?
      - Can I update just the price of a subscription line?
      instructions:
      - text: Change the quantity on subscription line {id} to {qtyOrdered}.
        slots:
          id: path.id
          qtyOrdered: requestBody.qtyOrdered
      - text: Set the price of subscription line {id} to {price}.
        slots:
          id: path.id
          price: requestBody.price
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/SubscriptionLines/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank subscription line template
      effect: read
      questions:
      - What default values does a new subscription line start with?
      - Can I fetch an empty subscription line template?
      instructions:
      - text: Fetch the default subscription line template.
      - text: Show the starting values for a new subscription line.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/subscriptionlines/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete subscription lines
      effect: destructive
      questions:
      - Can I delete several subscription lines at once?
      - How do I remove a batch of subscription lines by ID?
      instructions:
      - text: Bulk delete subscription lines {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these subscription lines together: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/subscriptionlines({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a subscription line
      effect: read
      questions:
      - Can I read a custom property stored on a subscription line?
      - What extra custom values does a subscription line carry?
      instructions:
      - text: Get custom property {custompropertyKey} on subscription line {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show subscription line {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'