# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 2026-07 Partner Billing API
  version: 1.0.0
extends: openapi/lightspeed-partner-billing-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: 5
- target: $.paths['/partner/billing/subscriptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a retailer's partner subscriptions
      effect: read
      questions:
      - Which of my app subscriptions does this retailer currently have?
      - Can I check what a retailer is paying my partner app for?
      instructions:
      - text: List this retailer's partner subscriptions.
      - text: Show all partner app subscriptions for the connected retailer.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/billing/subscriptions/{subscription_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a partner subscription
      effect: read
      questions:
      - What plan and status does a specific partner subscription have?
      - Can I look up one subscription by its ID?
      instructions:
      - text: Get partner subscription {subscription}.
        slots:
          subscription: path.subscription_id
      - text: Show the status of subscription {subscription}.
        slots:
          subscription: path.subscription_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/billing/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new partner subscription checkout
      effect: write
      questions:
      - How do I send a retailer to subscribe to my app's paid plan?
      - Can I apply a coupon code when creating a subscription token?
      instructions:
      - text: Create a subscription token for product {product} at price {price} returning to {url}.
        slots:
          product: requestBody.product_handle
          price: requestBody.price_handle
          url: requestBody.return_url
      - text: Create a subscription token for product {product}, price {price}, coupon {coupon}, return URL {url}.
        slots:
          product: requestBody.product_handle
          price: requestBody.price_handle
          coupon: requestBody.coupon_code
          url: requestBody.return_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/billing/token/{partner_subscription_token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a subscription token
      effect: read
      questions:
      - What subscription does a partner subscription token point to?
      - Can I check the data behind a token after the retailer returns?
      instructions:
      - text: Get the subscription for token {token}.
        slots:
          token: path.partner_subscription_token
      - text: Look up partner subscription token {token}.
        slots:
          token: path.partner_subscription_token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/billing/update-subscription/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a subscription change checkout
      effect: write
      questions:
      - How do I let a retailer upgrade or change their existing app subscription?
      - Can I move a retailer to a different price on their current subscription?
      instructions:
      - text: Create an update-subscription token returning to {url}.
        slots:
          url: requestBody.return_url
      - text: Create a token to switch the retailer's subscription to price {price} with return URL {url}.
        slots:
          price: requestBody.price_handle
          url: requestBody.return_url
      method: generated
      generated: '2026-09-26'