# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Remote Contractors Contractor Subscriptions API
  version: 1.0.0
extends: openapi/remote-com-contractor-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: 4
- target: $.paths['/contractors/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List contractor subscriptions
      effect: read
      questions:
      - Which of my contractors are on Plus or Contractor of Record plans?
      - Can I filter contractor subscriptions by plan?
      instructions:
      - text: List contractor subscriptions on plan {plan}.
        slots:
          plan: query.plan
      - text: Show the subscriptions for contractor employment {employment_id}.
        slots:
          employment_id: query.employment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contractors/{employment_id}/subscriptions/plus'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe, change or cancel Contractor Plus
      effect: write
      questions:
      - How do I add the Plus indemnity plan to a contractor?
      - Can I change or cancel a contractor's Plus subscription?
      instructions:
      - text: Apply action {action} to the Plus plan of contractor {employment_id}.
        slots:
          action: requestBody.action
          employment_id: path.employment_id
      - text: Subscribe contractor {employment_id} to Plus plan {plan} starting {starts_on} using action {action}.
        slots:
          employment_id: path.employment_id
          plan: requestBody.plan
          starts_on: requestBody.starts_on
          action: requestBody.action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contractors/{employment_id}/subscriptions/cor'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe, change or cancel Contractor of Record
      effect: write
      questions:
      - How do I move a contractor onto a Contractor of Record subscription?
      - Can I switch plans on an existing COR subscription?
      instructions:
      - text: Apply action {action} to the COR subscription of contractor {employment_id}.
        slots:
          action: requestBody.action
          employment_id: path.employment_id
      - text: Put contractor {employment_id} on COR plan {plan} from {starts_on} with action {action}.
        slots:
          employment_id: path.employment_id
          plan: requestBody.plan
          starts_on: requestBody.starts_on
          action: requestBody.action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contractors/{employment_id}/subscriptions/cor'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Contractor of Record subscription
      effect: destructive
      questions:
      - How do I remove the COR subscription from a contractor entirely?
      - Can a contractor's Contractor of Record subscription be deleted?
      instructions:
      - text: Delete the COR subscription for contractor {employment_id}.
        slots:
          employment_id: path.employment_id
      - text: Remove contractor {employment_id} from Contractor of Record.
        slots:
          employment_id: path.employment_id
      method: generated
      generated: '2026-09-26'