# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Charges API
  version: 1.0.0
extends: openapi/shopify-charges-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List usage charges on a subscription (API 2020-01)
      effect: read
      questions:
      - What usage charges has my app billed against a recurring charge on API 2020-01?
      - Can version 2020-01 return only selected fields of each usage charge?
      instructions:
      - text: List usage charges for recurring charge {charge} using 2020-01.
        slots:
          charge: path.recurring_application_charge_id
      - text: Show {fields} of the usage charges on recurring charge {charge}, API 2020-01.
        slots:
          charge: path.recurring_application_charge_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List usage charges on a subscription (API 2020-04)
      effect: read
      questions:
      - How do I see metered fees added to an app subscription through release 2020-04?
      - Which usage charges sit under one recurring app charge in version 2020-04?
      instructions:
      - text: Get the usage charges billed on recurring charge {charge} via 2020-04.
        slots:
          charge: path.recurring_application_charge_id
      - text: Fetch usage charges for {charge} limited to {fields}, release 2020-04.
        slots:
          charge: path.recurring_application_charge_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List usage charges on a subscription (API 2020-07)
      effect: read
      questions:
      - Can I review the usage-based fees on an app's recurring charge with 2020-07?
      - What has been metered against a recurring application charge under API 2020-07?
      instructions:
      - text: Retrieve usage charges under recurring charge {charge} on 2020-07.
        slots:
          charge: path.recurring_application_charge_id
      - text: On API 2020-07, list only {fields} for usage charges of {charge}.
        slots:
          charge: path.recurring_application_charge_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List usage charges on a subscription (API 2020-10)
      effect: read
      questions:
      - How do I list the usage charges my app added to a merchant's Shopify subscription?
      - Which metered fees are recorded against a recurring app charge on API 2020-10?
      instructions:
      - text: List all usage charges for recurring application charge {charge} with 2020-10.
        slots:
          charge: path.recurring_application_charge_id
      - text: Show usage charges on {charge} returning just {fields}, version 2020-10.
        slots:
          charge: path.recurring_application_charge_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List usage charges on a subscription (API 2021-01)
      effect: read
      questions:
      - What usage fees has an app subscription accrued, checked via release 2021-01?
      - Can the 2021-01 API narrow usage charge results to certain fields?
      instructions:
      - text: Fetch usage charges for recurring charge {charge} through 2021-01.
        slots:
          charge: path.recurring_application_charge_id
      - text: Using release 2021-01, get {fields} from the usage charges on {charge}.
        slots:
          charge: path.recurring_application_charge_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List usage charges on a subscription (unstable API)
      effect: read
      questions:
      - Can the unstable API show usage charges under a recurring application charge?
      - Which metered app fees does the unstable release list for one subscription?
      instructions:
      - text: List usage charges on recurring charge {charge} using the unstable API.
        slots:
          charge: path.recurring_application_charge_id
      - text: From the unstable version, return {fields} for usage charges on {charge}.
        slots:
          charge: path.recurring_application_charge_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'