Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Applications API

105 actions 105 updates phrasing extends openapi/shopify-applications-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Shopify's API. It is a proposal applied on top of the contract, not a document Shopify publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 105 · first 16 shown; the file carries all of them

$.info
$.paths['/admin/api/2020-01/reports/{report_id}.json'].get
$.paths['/admin/api/2020-04/reports/{report_id}.json'].get
$.paths['/admin/api/2020-07/reports/{report_id}.json'].get
$.paths['/admin/api/2020-10/reports/{report_id}.json'].get
$.paths['/admin/api/2021-01/reports/{report_id}.json'].get
$.paths['/admin/api/unstable/reports/{report_id}.json'].get
$.paths['/admin/api/2020-01/application_charges.json'].get
$.paths['/admin/api/2020-01/application_charges.json'].post
$.paths['/admin/api/2020-01/application_charges/{application_charge_id}.json'].get
$.paths['/admin/api/2020-04/application_charges.json'].get
$.paths['/admin/api/2020-04/application_charges.json'].post
$.paths['/admin/api/2020-04/application_charges/{application_charge_id}.json'].get
$.paths['/admin/api/2020-07/application_charges.json'].get
$.paths['/admin/api/2020-07/application_charges.json'].post
$.paths['/admin/api/2020-07/application_charges/{application_charge_id}.json'].get

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 Shopify Applications API
  version: 1.0.0
extends: openapi/shopify-applications-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: 104
- target: $.paths['/admin/api/2020-01/reports/{report_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my app's reports (API 2020-01)
      effect: read
      questions:
      - How do I pull up a single report my app created on the 2020-01 Admin API?
      - Can a 2020-01 report lookup return only a few chosen fields?
      instructions:
      - text: Fetch report {report_id} through Admin API version 2020-01.
        slots:
          report_id: path.report_id
      - text: Show just the {fields} of app report {report_id}, January 2020 release.
        slots:
          fields: query.fields
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/reports/{report_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my app's reports (API 2020-04)
      effect: read
      questions:
      - Which call returns a report my app made when I'm pinned to API version 2020-04?
      - Is there a fields filter when reading an app report in the April 2020 release?
      instructions:
      - text: Open my app's report {report_id} on the 2020-04 API.
        slots:
          report_id: path.report_id
      - text: Read report {report_id} from the April 2020 endpoint, limited to {fields}.
        slots:
          report_id: path.report_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/reports/{report_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my app's reports (API 2020-07)
      effect: read
      questions:
      - Where do I read back a report my app built, using the July 2020 Admin API?
      - Does the 2020-07 single-report endpoint let me restrict the response fields?
      instructions:
      - text: Load app-created report {report_id} with the 2020-07 version.
        slots:
          report_id: path.report_id
      - text: Using July 2020 API, give me report {report_id} with only {fields}.
        slots:
          report_id: path.report_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/reports/{report_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my app's reports (API 2020-10)
      effect: read
      questions:
      - What's the current 2020-10 way to retrieve a report my app created?
      - Can I ask for specific fields when getting a report on the October 2020 API?
      instructions:
      - text: Get report {report_id} that my app created, API 2020-10.
        slots:
          report_id: path.report_id
      - text: Return fields {fields} for report {report_id} on the October 2020 version.
        slots:
          fields: query.fields
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/reports/{report_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my app's reports (API 2021-01)
      effect: read
      questions:
      - How can I look at one app report via the 2021-01 Admin API release?
      - Will the January 2021 report endpoint return a subset of fields if I list them?
      instructions:
      - text: Pull app report {report_id} from API version 2021-01.
        slots:
          report_id: path.report_id
      - text: On the 2021 January release, retrieve report {report_id} showing {fields} only.
        slots:
          report_id: path.report_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/reports/{report_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my app's reports (unstable API)
      effect: read
      questions:
      - Can I retrieve a single app report through the unstable Admin API version?
      - What does the unstable-channel report lookup return when I pass a fields list?
      instructions:
      - text: Retrieve report {report_id} from the unstable API channel.
        slots:
          report_id: path.report_id
      - text: Via unstable, fetch {fields} of my app's report {report_id}.
        slots:
          fields: query.fields
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/application_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List one-time app charges (API 2020-01)
      effect: read
      questions:
      - How do I see every one-time charge my app has billed a shop, on API 2020-01?
      - Can the 2020-01 one-time charge list start after a given charge ID?
      instructions:
      - text: List all one-time application charges using the 2020-01 version.
      - text: Show one-time app charges newer than {since_id}, January 2020 API.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/application_charges.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Bill a shop a one-time app charge (API 2020-01)
      effect: write
      questions:
      - How do I charge a merchant a single one-off fee for my app on the 2020-01 API?
      - Which 2020-01 endpoint creates a one-time application charge?
      instructions:
      - text: Create a one-time application charge with Admin API 2020-01.
      - text: Raise a single non-recurring app fee for this shop via the January 2020 release.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/application_charges/{application_charge_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a one-time app charge (API 2020-01)
      effect: read
      questions:
      - How can I check the status of one specific one-time app charge on 2020-01?
      - Does the January 2020 charge lookup accept a fields list?
      instructions:
      - text: Look up one-time charge {application_charge_id} on API 2020-01.
        slots:
          application_charge_id: path.application_charge_id
      - text: Get the {fields} of application charge {application_charge_id}, January 2020 release.
        slots:
          fields: query.fields
          application_charge_id: path.application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/application_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List one-time app charges (API 2020-04)
      effect: read
      questions:
      - Where can I list the one-off fees my app charged, using API version 2020-04?
      - Is paging by since_id supported on the April 2020 one-time charge list?
      instructions:
      - text: Show my app's one-time charges from the 2020-04 API.
      - text: Page April 2020 one-off app charges after ID {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/application_charges.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Bill a shop a one-time app charge (API 2020-04)
      effect: write
      questions:
      - Can I bill a store a one-time purchase for my app on the April 2020 API?
      - What call starts a single application charge under version 2020-04?
      instructions:
      - text: Start a one-off application charge on the 2020-04 release.
      - text: Charge the merchant once for my app using April 2020 Admin API.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/application_charges/{application_charge_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a one-time app charge (API 2020-04)
      effect: read
      questions:
      - Which 2020-04 call shows me one particular one-time app charge?
      - Can I narrow an April 2020 single-charge response to certain fields?
      instructions:
      - text: Retrieve one-off charge {application_charge_id} via version 2020-04.
        slots:
          application_charge_id: path.application_charge_id
      - text: Using April 2020, show {fields} for one-time charge {application_charge_id}.
        slots:
          fields: query.fields
          application_charge_id: path.application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/application_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List one-time app charges (API 2020-07)
      effect: read
      questions:
      - What's the July 2020 endpoint for listing all one-time charges from my app?
      - Can I skip earlier one-time charges with since_id on 2020-07?
      instructions:
      - text: Get every one-time app charge on API 2020-07.
      - text: List July 2020 application charges created after {since_id}, only {fields}.
        slots:
          since_id: query.since_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/application_charges.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Bill a shop a one-time app charge (API 2020-07)
      effect: write
      questions:
      - How would I create a one-time app purchase for a store on the 2020-07 release?
      - Is a one-off application charge created with a POST on the July 2020 API?
      instructions:
      - text: Create a one-time charge for my app with the July 2020 version.
      - text: Bill this store a single app payment through 2020-07.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/application_charges/{application_charge_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a one-time app charge (API 2020-07)
      effect: read
      questions:
      - Where do I read a single one-time app charge by ID on the July 2020 API?
      - Can the 2020-07 charge detail call return only the fields I name?
      instructions:
      - text: Fetch application charge {application_charge_id} from 2020-07.
        slots:
          application_charge_id: path.application_charge_id
      - text: Show fields {fields} of one-off charge {application_charge_id}, July 2020 release.
        slots:
          fields: query.fields
          application_charge_id: path.application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/application_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List one-time app charges (API 2020-10)
      effect: read
      questions:
      - How can I list the one-time charges my app has made on the current 2020-10 API?
      - Does the October 2020 one-time charge list support since_id paging?
      instructions:
      - text: List one-time application charges, version 2020-10.
      - text: Show October 2020 one-off charges after charge {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/application_charges.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Bill a shop a one-time app charge (API 2020-10)
      effect: write
      questions:
      - Can I sell a merchant a one-time app upgrade using the 2020-10 Admin API?
      - Which October 2020 endpoint makes a one-time application charge?
      instructions:
      - text: Make a one-time app charge for the shop on API 2020-10.
      - text: Create a single non-recurring app charge on the October 2020 version.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/application_charges/{application_charge_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a one-time app charge (API 2020-10)
      effect: read
      questions:
      - What's the 2020-10 call to see whether a one-time app charge was accepted?
      - Can I get selected fields of a one-time charge on the October 2020 API?
      instructions:
      - text: Get one-time charge {application_charge_id} with API version 2020-10.
        slots:
          application_charge_id: path.application_charge_id
      - text: Return {fields} for charge {application_charge_id} on the October 2020 release.
        slots:
          fields: query.fields
          application_charge_id: path.application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/application_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List one-time app charges (API 2021-01)
      effect: read
      questions:
      - Which call lists my app's one-off charges on the January 2021 API?
      - Is since_id available to page one-time charges in version 2021-01?
      instructions:
      - text: Pull all one-time app charges using 2021-01.
      - text: List 2021-01 one-off application charges beyond ID {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/application_charges.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Bill a shop a one-time app charge (API 2021-01)
      effect: write
      questions:
      - How do I create a one-off purchase charge for my app on 2021-01?
      - Does the January 2021 release still let me POST a one-time application charge?
      instructions:
      - text: Issue a one-time app charge via the 2021-01 Admin API.
      - text: Charge this shop a one-off app fee on the January 2021 release.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/application_charges/{application_charge_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a one-time app charge (API 2021-01)
      effect: read
      questions:
      - How can I inspect one specific one-off app charge on the 2021-01 version?
      - Can January 2021 charge lookups be trimmed to particular fields?
      instructions:
      - text: Inspect one-time charge {application_charge_id} on API 2021-01.
        slots:
          application_charge_id: path.application_charge_id
      - text: From the January 2021 release, get {fields} of charge {application_charge_id}.
        slots:
          fields: query.fields
          application_charge_id: path.application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/application_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List one-time app charges (unstable API)
      effect: read
      questions:
      - Can I list one-time app charges on the unstable Admin API channel?
      - Does the unstable one-time charge list take a since_id cursor?
      instructions:
      - text: List one-off app charges from the unstable version.
      - text: Via unstable, show one-time charges after {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/application_charges.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Bill a shop a one-time app charge (unstable API)
      effect: write
      questions:
      - Is creating a one-time app charge possible on the unstable API version?
      - What unstable-channel endpoint bills a shop once for my app?
      instructions:
      - text: Create a one-time application charge on unstable.
      - text: Bill the store a single app fee through the unstable channel.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/application_charges/{application_charge_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a one-time app charge (unstable API)
      effect: read
      questions:
      - How do I get one one-off app charge by ID on the unstable channel?
      - Can an unstable single-charge lookup return a limited field set?
      instructions:
      - text: Get application charge {application_charge_id} on the unstable API.
        slots:
          application_charge_id: path.application_charge_id
      - text: 'Unstable channel: show {fields} for one-off charge {application_charge_id}.'
        slots:
          fields: query.fields
          application_charge_id: path.application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/application_credits.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue an app credit to a shop (API 2020-01)
      effect: write
      questions:
      - How do I give a merchant a credit toward future app charges on API 2020-01?
      - Which 2020-01 call creates an application credit?
      instructions:
      - text: Issue an application credit to this shop using 2020-01.
      - text: Credit the merchant's app billing via the January 2020 release.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/application_credits/{application_credit_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app credit (API 2020-01)
      effect: read
      questions:
      - Where can I look up one application credit I issued, on version 2020-01?
      - Can a January 2020 credit lookup return just some fields?
      instructions:
      - text: Show application credit {application_credit_id} on API 2020-01.
        slots:
          application_credit_id: path.application_credit_id
      - text: Get {fields} of credit {application_credit_id} from the January 2020 version.
        slots:
          fields: query.fields
          application_credit_id: path.application_credit_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/application_credits.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue an app credit to a shop (API 2020-04)
      effect: write
      questions:
      - Can I credit a store for my app on the April 2020 Admin API?
      - What's the 2020-04 endpoint to create an application credit?
      instructions:
      - text: Create an app credit for the merchant with version 2020-04.
      - text: Give this shop an application credit through April 2020.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/application_credits/{application_credit_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app credit (API 2020-04)
      effect: read
      questions:
      - How can I retrieve a single application credit on the 2020-04 release?
      - Is there a fields option on the April 2020 credit detail call?
      instructions:
      - text: Retrieve app credit {application_credit_id} via 2020-04.
        slots:
          application_credit_id: path.application_credit_id
      - text: 'April 2020: return {fields} for credit {application_credit_id}.'
        slots:
          fields: query.fields
          application_credit_id: path.application_credit_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/application_credits.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue an app credit to a shop (API 2020-07)
      effect: write
      questions:
      - What call issues a merchant credit for my app under API 2020-07?
      - Can I create application credits on the July 2020 version?
      instructions:
      - text: Issue a July 2020 application credit to the shop.
      - text: Add an app billing credit for this store on 2020-07.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/application_credits/{application_credit_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app credit (API 2020-07)
      effect: read
      questions:
      - Which July 2020 endpoint returns one application credit by ID?
      - Can I limit the fields of a 2020-07 application credit response?
      instructions:
      - text: Fetch credit {application_credit_id} from API 2020-07.
        slots:
          application_credit_id: path.application_credit_id
      - text: Show only {fields} of app credit {application_credit_id}, July 2020 release.
        slots:
          fields: query.fields
          application_credit_id: path.application_credit_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/application_credits.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue an app credit to a shop (API 2020-10)
      effect: write
      questions:
      - How do I credit a merchant against future app charges on the 2020-10 API?
      - Is the October 2020 application credit endpoint a POST with no path ID?
      instructions:
      - text: Create an application credit on API version 2020-10.
      - text: Credit this store toward my app's charges using October 2020.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/application_credits/{application_credit_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app credit (API 2020-10)
      effect: read
      questions:
      - What's the current 2020-10 way to read back an application credit?
      - Can the October 2020 credit lookup return selected fields only?
      instructions:
      - text: Get application credit {application_credit_id} on 2020-10.
        slots:
          application_credit_id: path.application_credit_id
      - text: On October 2020, show fields {fields} for app credit {application_credit_id}.
        slots:
          fields: query.fields
          application_credit_id: path.application_credit_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/application_credits.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue an app credit to a shop (API 2021-01)
      effect: write
      questions:
      - Can I still issue an app credit to a merchant on the 2021-01 release?
      - Which January 2021 call creates a credit for my app's billing?
      instructions:
      - text: Issue an app credit with the 2021-01 Admin API.
      - text: Give the merchant a billing credit for my app, January 2021 version.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/application_credits/{application_credit_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app credit (API 2021-01)
      effect: read
      questions:
      - How do I view one application credit on API version 2021-01?
      - Does the January 2021 credit detail endpoint honor a fields list?
      instructions:
      - text: View app credit {application_credit_id} from 2021-01.
        slots:
          application_credit_id: path.application_credit_id
      - text: Read {fields} of application credit {application_credit_id} on the January 2021 release.
        slots:
          fields: query.fields
          application_credit_id: path.application_credit_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/application_credits.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Issue an app credit to a shop (unstable API)
      effect: write
      questions:
      - Can the unstable API version create application credits?
      - What unstable endpoint credits a merchant for my app?
      instructions:
      - text: Create an app credit on the unstable channel.
      - text: Issue this shop an application credit via unstable.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/application_credits/{application_credit_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app credit (unstable API)
      effect: read
      questions:
      - How can I fetch one application credit through the unstable API?
      - Will the unstable credit lookup return only the fields I ask for?
      instructions:
      - text: Get app credit {application_credit_id} on unstable.
        slots:
          application_credit_id: path.application_credit_id
      - text: 'Unstable channel: fetch {fields} of credit {application_credit_id}.'
        slots:
          fields: query.fields
          application_credit_id: path.application_credit_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/recurring_application_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List app subscriptions (API 2020-01)
      effect: read
      questions:
      - How do I list the recurring subscription charges for my app on API 2020-01?
      - Can I page 2020-01 recurring app charges with since_id?
      instructions:
      - text: List recurring application charges on version 2020-01.
      - text: Show January 2020 app subscriptions after charge {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/recurring_application_charges.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an app subscription charge (API 2020-01)
      effect: write
      questions:
      - How do I set up a monthly subscription charge for my app on 2020-01?
      - Which January 2020 call creates a recurring application charge?
      instructions:
      - text: Create a recurring app charge using the 2020-01 API.
      - text: Start a subscription billing plan for this shop, January 2020 release.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an app subscription (API 2020-01)
      effect: destructive
      questions:
      - How do I cancel a merchant's recurring app charge on API 2020-01?
      - Is cancelling a subscription charge a DELETE on the January 2020 version?
      instructions:
      - text: Cancel recurring charge {recurring_application_charge_id} via 2020-01.
        slots:
          recurring_application_charge_id: path.recurring_application_charge_id
      - text: End app subscription {recurring_application_charge_id} on the January 2020 release.
        slots:
          recurring_application_charge_id: path.recurring_application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/recurring_application_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List app subscriptions (API 2020-04)
      effect: read
      questions:
      - Where do I see all recurring app charges with the April 2020 Admin API?
      - Can a 2020-04 subscription charge list return only certain fields?
      instructions:
      - text: Show my app's recurring charges from API 2020-04.
      - text: List April 2020 recurring charges with fields {fields} only.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/recurring_application_charges.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an app subscription charge (API 2020-04)
      effect: write
      questions:
      - Can I create a recurring subscription for my app on the 2020-04 version?
      - What April 2020 endpoint bills a merchant on a recurring basis?
      instructions:
      - text: Set up a recurring application charge through 2020-04.
      - text: Begin recurring app billing for the store with the April 2020 API.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an app subscription (API 2020-04)
      effect: destructive
      questions:
      - Which 2020-04 call cancels a recurring charge for my app?
      - Can I stop a merchant's app subscription on the April 2020 release?
      instructions:
      - text: Cancel app subscription {recurring_application_charge_id} using 2020-04.
        slots:
          recurring_application_charge_id: path.recurring_application_charge_id
      - text: Stop recurring charge {recurring_application_charge_id} on the April 2020 API.
        slots:
          recurring_application_charge_id: path.recurring_application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/recurring_application_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List app subscriptions (API 2020-07)
      effect: read
      questions:
      - What's the July 2020 call to list my app's recurring subscription charges?
      - Does since_id work on the 2020-07 recurring charge list?
      instructions:
      - text: Get all recurring app charges via 2020-07.
      - text: List July 2020 subscription charges after {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/recurring_application_charges.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an app subscription charge (API 2020-07)
      effect: write
      questions:
      - How would I start recurring billing for my app on the 2020-07 release?
      - Is a recurring application charge created by POST on the July 2020 API?
      instructions:
      - text: Create a subscription charge for my app on 2020-07.
      - text: Put this merchant on recurring app billing, July 2020 version.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel an app subscription (API 2020-07)
      effect: destructive
      questions:
      - Where do I cancel a recurring app charge on the July 2020 Admin API?
      - What happens to the subscription when I delete a recurring charge on 2020-07?
      instructions:
      - text: Cancel recurring app charge {recurring_application_charge_id}, API 2020-07.
        slots:
          recurring_application_charge_id: path.recurring_application_charge_id
      - text: Terminate subscription {recurring_application_charge_id} with the July 2020 release.
        slots:
          recurring_application_charge_id: path.recurring_application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/recurring_application_charges.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List app subscriptions (API 2020-10)
      effect: read
      questions:
      - How can I see every recurring charge my app has on the current 2020-10 API?
      - Can I filter October 2020 recurring charges to those after a given ID?
      instructions:
      - text: List recurring application charges, version 2020-10.
      - text: Show October 2020 app subscriptions newer than {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/recurring_application_charges.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an app subscription charge (API 2020-10)
      effect: write
      questions:
      - How do I charge a merchant a recurring fee for my app on 2020-10?
      - Which October 2020 endpoint creates a recurring application charge?
      instructions:
      - text: Create a recurring app charge on API 2020-10.
      - text: Start subscription billing for this shop on the October 2020 release.
      method: generated
      generated: '2026-09-24'


# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/overlays/shopify-applications-api-phrasing-overlay.yaml