API Evangelist conversational phrasing for Shopify Active API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Active API
  version: 1.0.0
extends: openapi/shopify-active-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}/customize.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Raise an app subscription's usage cap (2020-01)
      effect: write
      questions:
      - How do I change the capped amount on an active recurring app charge with API version 2020-01?
      - Can my app raise the spending cap on a merchant's subscription in 2020-01?
      instructions:
      - text: Set the capped amount of recurring charge {charge_id} to {capped_amount} using API version 2020-01.
        slots:
          charge_id: path.recurring_application_charge_id
          capped_amount: query.recurring_application_charge[capped_amount]
      - text: Update the usage cap on active charge {charge_id} on the 2020-01 version.
        slots:
          charge_id: path.recurring_application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/customize.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a recurring charge's capped amount (2020-04)
      effect: write
      questions:
      - Which 2020-04 call adjusts the maximum a usage-based app subscription can bill?
      - Can release 2020-04 customize the cap of an active recurring application charge?
      instructions:
      - text: Using release 2020-04, cap recurring charge {charge_id} at {capped_amount}.
        slots:
          charge_id: path.recurring_application_charge_id
          capped_amount: query.recurring_application_charge[capped_amount]
      - text: Adjust the billing ceiling of active charge {charge_id} with the 2020-04 release.
        slots:
          charge_id: path.recurring_application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/customize.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the cap on an active app charge (2020-07)
      effect: write
      questions:
      - Does the 2020-07 API let me lift the capped amount of a recurring charge that's already active?
      - What's the 2020-07 way to customize an app subscription's usage limit?
      instructions:
      - text: Lift the cap of recurring charge {charge_id} to {capped_amount} on the 2020-07 API.
        slots:
          charge_id: path.recurring_application_charge_id
          capped_amount: query.recurring_application_charge[capped_amount]
      - text: For the 2020-07 API, customize the capped amount of charge {charge_id}.
        slots:
          charge_id: path.recurring_application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/customize.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a recurring charge's capped amount (2020-10)
      effect: write
      questions:
      - Can I update the capped amount of an active recurring charge on the current 2020-10 version?
      - What's the non-deprecated 2020-10 call for increasing an app's usage billing cap?
      instructions:
      - text: Update the capped amount of recurring charge {charge_id} to {capped_amount} on 2020-10.
        slots:
          charge_id: path.recurring_application_charge_id
          capped_amount: query.recurring_application_charge[capped_amount]
      - text: Increase the usage billing cap on charge {charge_id} using the non-deprecated 2020-10 API.
        slots:
          charge_id: path.recurring_application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/recurring_application_charges/{recurring_application_charge_id}/customize.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Customize an active charge's cap (2021-01)
      effect: write
      questions:
      - Is changing a recurring application charge's capped amount possible with version 2021-01?
      - Which 2021-01 endpoint customizes the cap on an app subscription?
      instructions:
      - text: With version 2021-01, set charge {charge_id}'s capped amount to {capped_amount}.
        slots:
          charge_id: path.recurring_application_charge_id
          capped_amount: query.recurring_application_charge[capped_amount]
      - text: Customize the spending cap of recurring charge {charge_id} via the 2021-01 version.
        slots:
          charge_id: path.recurring_application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/recurring_application_charges/{recurring_application_charge_id}/customize.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a recurring charge's cap (unstable version)
      effect: write
      questions:
      - Can I test raising a recurring charge's capped amount against the unstable API version?
      - Does the unstable version support customizing an active app charge's cap?
      instructions:
      - text: On the unstable API version, change the cap of recurring charge {charge_id} to {capped_amount}.
        slots:
          charge_id: path.recurring_application_charge_id
          capped_amount: query.recurring_application_charge[capped_amount]
      - text: Try customizing the capped amount for charge {charge_id} using the unstable version.
        slots:
          charge_id: path.recurring_application_charge_id
      method: generated
      generated: '2026-09-24'