# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity.DirectoryManagement Directory.company Subscription…
  version: 1.0.0
extends: openapi/azure-ad-directory-companysubscription-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: 9
- target: $.paths['/directory/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the organization's commercial subscriptions
      effect: read
      questions:
      - Which commercial Microsoft subscriptions has my organization acquired?
      - Can I see which of our subscriptions are trials and how many licenses each has?
      instructions:
      - text: List all commercial subscriptions my organization owns.
      - text: Show company subscriptions matching filter {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/subscriptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a company subscription record
      effect: write
      questions:
      - Can I create a new company subscription entry in the directory?
      - What fields, such as SKU and total licenses, go on a new company subscription?
      instructions:
      - text: Create a company subscription for SKU {sku} with {licenses} licenses.
        slots:
          sku: requestBody.skuId
          licenses: requestBody.totalLicenses
      - text: Add a subscription record for part number {part_number}.
        slots:
          part_number: requestBody.skuPartNumber
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/subscriptions/{companySubscription-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company subscription by its directory ID
      effect: read
      questions:
      - What's the status and license count of one specific company subscription?
      - When does a particular subscription reach its next lifecycle date?
      instructions:
      - text: Get company subscription {subscription} by its directory ID.
        slots:
          subscription: path.companySubscription-id
      - text: Show status and total licenses for subscription {subscription}.
        slots:
          subscription: path.companySubscription-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/subscriptions/{companySubscription-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company subscription by its directory ID
      effect: destructive
      questions:
      - Can I remove a company subscription record using its directory object ID?
      - What's the delete call for a subscription when I have its entity ID rather than the commerce ID?
      instructions:
      - text: Delete company subscription {subscription} by its directory ID.
        slots:
          subscription: path.companySubscription-id
      - text: Remove subscription record {subscription} from the directory.
        slots:
          subscription: path.companySubscription-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/subscriptions/{companySubscription-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a company subscription by its directory ID
      effect: write
      questions:
      - Can I change the license total on a subscription I address by directory ID?
      - Which fields of a company subscription record are patchable using its entity ID?
      instructions:
      - text: Set total licenses on company subscription {subscription} to {licenses}.
        slots:
          subscription: path.companySubscription-id
          licenses: requestBody.totalLicenses
      - text: Update the status of subscription entity {subscription} to {status}.
        slots:
          subscription: path.companySubscription-id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/subscriptions(commerceSubscriptionId=\'{commerceSubscriptionId}\')'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a company subscription by commerce ID
      effect: read
      questions:
      - How do I look up a subscription when all I have is its commerce subscription ID?
      - Can I fetch a company subscription by the ID from our billing records?
      instructions:
      - text: Get the company subscription with commerce subscription ID {commerce_id}.
        slots:
          commerce_id: path.commerceSubscriptionId
      - text: Look up subscription details by commerce ID {commerce_id}.
        slots:
          commerce_id: path.commerceSubscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/subscriptions(commerceSubscriptionId=\'{commerceSubscriptionId}\')'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a company subscription by commerce ID
      effect: destructive
      questions:
      - Can I delete a subscription record using its commerce subscription ID?
      - Is there a delete that keys on the commerce ID instead of the directory ID?
      instructions:
      - text: Delete the company subscription with commerce subscription ID {commerce_id}.
        slots:
          commerce_id: path.commerceSubscriptionId
      - text: Remove the subscription record identified by commerce ID {commerce_id}.
        slots:
          commerce_id: path.commerceSubscriptionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/subscriptions(commerceSubscriptionId=\'{commerceSubscriptionId}\')'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a company subscription by commerce ID
      effect: write
      questions:
      - Can I patch a subscription when I only know its commerce subscription ID?
      - What can I change on a company subscription addressed by commerce ID?
      instructions:
      - text: Set total licenses on the subscription with commerce ID {commerce_id} to {licenses}.
        slots:
          commerce_id: path.commerceSubscriptionId
          licenses: requestBody.totalLicenses
      - text: Update the status of commerce subscription {commerce_id} to {status}.
        slots:
          commerce_id: path.commerceSubscriptionId
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/subscriptions/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count the organization's company subscriptions
      effect: read
      questions:
      - How many commercial subscriptions does my organization have?
      - Can I get just a count of our company subscriptions?
      instructions:
      - text: Count the company subscriptions in my directory.
      - text: Tell me how many subscriptions match filter {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'