# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Balance API
  version: 1.0.0
extends: openapi/shopify-balance-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/shopify_payments/balance.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the Shopify Payments balance (2020-01)
      effect: read
      questions:
      - How do I see my current Shopify Payments balance with API version 2020-01?
      - Can an app read the account's payout balance on the 2020-01 version?
      instructions:
      - text: Get the current Shopify Payments balance using API version 2020-01.
      - text: Show my payments account balance on the 2020-01 version.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/shopify_payments/balance.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the payments account balance (2020-04)
      effect: read
      questions:
      - Which 2020-04 endpoint tells me how much money is in my payments account?
      - Can release 2020-04 report my Shopify Payments balance right now?
      instructions:
      - text: Using release 2020-04, fetch the payments account's current balance.
      - text: Tell me how much is in my payments account with the 2020-04 release.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/shopify_payments/balance.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the current payments balance (2020-07)
      effect: read
      questions:
      - What does the 2020-07 API return for my payments balance?
      - Is the Shopify Payments balance readable on 2020-07?
      instructions:
      - text: Read the payments balance from the 2020-07 API.
      - text: For the 2020-07 API, look up my account's current balance.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/shopify_payments/balance.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve the payments balance (2020-10, current)
      effect: read
      questions:
      - What's my current balance, per the non-deprecated 2020-10 API?
      - Can I retrieve the payments account balance on the current 2020-10 version?
      instructions:
      - text: Retrieve my current payments balance on 2020-10.
      - text: Check the account balance using the non-deprecated 2020-10 API.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/shopify_payments/balance.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch the payments balance (2021-01)
      effect: read
      questions:
      - Can version 2021-01 return the payments account's current balance?
      - Which 2021-01 call shows my payments balance?
      instructions:
      - text: With version 2021-01, fetch my payments balance.
      - text: Display the current account balance via the 2021-01 version.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/shopify_payments/balance.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the payments balance (unstable version)
      effect: read
      questions:
      - Can I read my payments balance from the unstable API version?
      - Does the unstable version expose the current account balance?
      instructions:
      - text: On the unstable API version, get my payments balance.
      - text: Try reading the account balance using the unstable version.
      method: generated
      generated: '2026-09-24'