Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Endpoint API

9 actions 9 updates phrasing extends openapi/shopify-endpoint-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 9

$.info
$.paths['/admin/api/2020-01/application_charges/{application_charge_id}/activate.json'].post
$.paths['/admin/api/2020-04/application_charges/{application_charge_id}/activate.json'].post
$.paths['/admin/api/2020-07/application_charges/{application_charge_id}/activate.json'].post
$.paths['/admin/api/2020-10/application_charges/{application_charge_id}/activate.json'].post
$.paths['/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/activate.json'].post
$.paths['/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/activate.json'].post
$.paths['/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/activate.json'].post
$.paths['/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/activate.json'].post

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 Endpoint API
  version: 1.0.0
extends: openapi/shopify-endpoint-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: 8
- target: $.paths['/admin/api/2020-01/application_charges/{application_charge_id}/activate.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a one-time app charge (deprecated, API 2020-01)
      effect: write
      questions:
      - After a merchant accepts my one-time app fee, how do I activate it on API 2020-01?
      - Is activating an accepted one-time application charge still required in 2020-01?
      instructions:
      - text: Activate one-time application charge {charge} using 2020-01.
        slots:
          charge: path.application_charge_id
      - text: Confirm the accepted single app purchase {charge} via release 2020-01.
        slots:
          charge: path.application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/application_charges/{application_charge_id}/activate.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a one-time app charge (deprecated, API 2020-04)
      effect: write
      questions:
      - Can I still call the one-time charge activation step on version 2020-04?
      - What happens to an accepted one-off app payment I activate with 2020-04?
      instructions:
      - text: Activate the one-off app charge {charge} on 2020-04.
        slots:
          charge: path.application_charge_id
      - text: Finalize accepted one-time charge {charge} through the 2020-04 release.
        slots:
          charge: path.application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/application_charges/{application_charge_id}/activate.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a one-time app charge (deprecated, API 2020-07)
      effect: write
      questions:
      - Is the separate activate call for one-time app charges needed under 2020-07?
      - Which endpoint in 2020-07 turns an accepted single app fee into an active charge?
      instructions:
      - text: Activate one-time app purchase {charge}, version 2020-07.
        slots:
          charge: path.application_charge_id
      - text: Mark accepted application charge {charge} active using API 2020-07.
        slots:
          charge: path.application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/application_charges/{application_charge_id}/activate.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a one-time app charge (deprecated, API 2020-10)
      effect: write
      questions:
      - Does version 2020-10 still expose activation for one-time application charges?
      - What's the legacy way to activate a merchant-approved one-time app fee in 2020-10?
      instructions:
      - text: Activate single-payment app charge {charge} with 2020-10.
        slots:
          charge: path.application_charge_id
      - text: Run the deprecated 2020-10 activation on one-time charge {charge}.
        slots:
          charge: path.application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/activate.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an app subscription charge (deprecated, 2020-01)
      effect: write
      questions:
      - Once a merchant approves my app subscription, how do I activate it with 2020-01?
      - Do recurring application charges need an explicit activate call on API 2020-01?
      instructions:
      - text: Activate recurring app charge {charge} using API 2020-01.
        slots:
          charge: path.recurring_application_charge_id
      - text: Start billing on accepted subscription {charge} via 2020-01.
        slots:
          charge: path.recurring_application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/recurring_application_charges/{recurring_application_charge_id}/activate.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an app subscription charge (deprecated, 2020-04)
      effect: write
      questions:
      - Can I activate an approved recurring app plan through release 2020-04?
      - Is subscription activation for apps deprecated as of the 2020-04 version?
      instructions:
      - text: Activate the recurring application charge {charge} on 2020-04.
        slots:
          charge: path.recurring_application_charge_id
      - text: Turn on merchant-accepted app subscription {charge}, release 2020-04.
        slots:
          charge: path.recurring_application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/recurring_application_charges/{recurring_application_charge_id}/activate.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an app subscription charge (deprecated, 2020-07)
      effect: write
      questions:
      - Which 2020-07 call activates a recurring charge a store owner already accepted?
      - Does my app still have to activate monthly charges under version 2020-07?
      instructions:
      - text: Activate subscription charge {charge} with version 2020-07.
        slots:
          charge: path.recurring_application_charge_id
      - text: Put approved recurring app fee {charge} into effect via 2020-07.
        slots:
          charge: path.recurring_application_charge_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/activate.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an app subscription charge (deprecated, 2020-10)
      effect: write
      questions:
      - Is the old recurring-charge activation step still callable in 2020-10?
      - What does activating an accepted app subscription do on API 2020-10?
      instructions:
      - text: Activate recurring charge {charge} through API 2020-10.
        slots:
          charge: path.recurring_application_charge_id
      - text: Call the legacy 2020-10 activate step for app subscription {charge}.
        slots:
          charge: path.recurring_application_charge_id
      method: generated
      generated: '2026-09-24'