Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Commerce Partner Subscriptions API

7 actions 7 updates phrasing extends openapi/adobe-suite-subscriptions-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v2/customers/{customer-id}/subscriptions'].get
$.paths['/v2/customers/{customer-id}/subscriptions/{subscription-id}'].get
$.paths['/v2/customers/{customer-id}/subscriptions/{subscription-id}'].patch
$.paths['/v3/customers/{customer-id}/subscriptions'].get
$.paths['/v3/customers/{customer-id}/subscriptions/{subscription-id}'].get
$.paths['/v3/customers/{customer-id}/subscriptions/{subscription-id}'].patch

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Commerce Partner Subscriptions API
  version: 1.0.0
extends: openapi/adobe-suite-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: 6
- target: $.paths['/v2/customers/{customer-id}/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's subscriptions (v2)
      effect: read
      questions:
      - How do I list every subscription a reseller customer has using the v2 endpoint?
      - What subscriptions does a customer hold under the older v2 API?
      instructions:
      - text: List all subscriptions for customer {customer-id} using v2.
        slots:
          customer-id: path.customer-id
      - text: Use the v2 API to show customer {customer-id}'s subscriptions.
        slots:
          customer-id: path.customer-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/customers/{customer-id}/subscriptions/{subscription-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription's details (v2)
      effect: read
      questions:
      - What is the current quantity and auto-renewal status of one subscription via v2?
      - Can the v2 endpoint tell me when a customer's subscription was created?
      instructions:
      - text: Get v2 details of subscription {subscription-id} for customer {customer-id}.
        slots:
          subscription-id: path.subscription-id
          customer-id: path.customer-id
      - text: With v2, show auto-renewal status for customer {customer-id} subscription {subscription-id}.
        slots:
          customer-id: path.customer-id
          subscription-id: path.subscription-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/customers/{customer-id}/subscriptions/{subscription-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a subscription's auto-renewal (v2)
      effect: write
      questions:
      - How do I turn off auto-renewal on a customer's subscription with the v2 API?
      - Can I change how many licenses renew through the v2 endpoint?
      instructions:
      - text: Via v2, set auto-renewal to {autoRenewal} on subscription {subscription-id} for customer {customer-id}.
        slots:
          autoRenewal: requestBody.autoRenewal
          subscription-id: path.subscription-id
          customer-id: path.customer-id
      - text: Using v2, renew {currentQuantity} licenses on customer {customer-id} subscription {subscription-id}.
        slots:
          currentQuantity: requestBody.currentQuantity
          customer-id: path.customer-id
          subscription-id: path.subscription-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/customers/{customer-id}/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's subscriptions (v3)
      effect: read
      questions:
      - Which subscriptions does a customer have according to the current v3 API?
      - Can I pull a reseller customer's full subscription list from v3?
      instructions:
      - text: List all subscriptions for customer {customer-id} using v3.
        slots:
          customer-id: path.customer-id
      - text: Use the v3 API to show customer {customer-id}'s subscriptions.
        slots:
          customer-id: path.customer-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/customers/{customer-id}/subscriptions/{subscription-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscription's details (v3)
      effect: read
      questions:
      - What quantity and renewal status does a subscription show in v3?
      - Does the v3 subscription lookup include the creation date?
      instructions:
      - text: Get v3 details of subscription {subscription-id} for customer {customer-id}.
        slots:
          subscription-id: path.subscription-id
          customer-id: path.customer-id
      - text: With v3, show auto-renewal status for customer {customer-id} subscription {subscription-id}.
        slots:
          customer-id: path.customer-id
          subscription-id: path.subscription-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/customers/{customer-id}/subscriptions/{subscription-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a subscription's auto-renewal (v3)
      effect: write
      questions:
      - How do I switch off auto-renew for a subscription with the v3 API?
      - Can v3 change the number of licenses set to renew?
      instructions:
      - text: Via v3, set auto-renewal to {autoRenewal} on subscription {subscription-id} for customer {customer-id}.
        slots:
          autoRenewal: requestBody.autoRenewal
          subscription-id: path.subscription-id
          customer-id: path.customer-id
      - text: Using v3, renew {currentQuantity} licenses on customer {customer-id} subscription {subscription-id}.
        slots:
          currentQuantity: requestBody.currentQuantity
          customer-id: path.customer-id
          subscription-id: path.subscription-id
      method: generated
      generated: '2026-09-26'