# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Shopify Charge API version: 1.0.0 extends: openapi/shopify-charge-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: 18 - target: $.paths['/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}.json'].get update: x-apievangelist-phrasing: intent: Get an app subscription charge (2020-01) effect: read questions: - How do I check the status of a merchant's recurring app charge with the 2020-01 API? - Can version 2020-01 return only selected fields of a recurring charge? instructions: - text: Get recurring application charge {charge_id} using 2020-01. slots: charge_id: path.recurring_application_charge_id - text: On 2020-01, show fields {fields} of recurring charge {charge_id}. slots: charge_id: 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}.json'].get update: x-apievangelist-phrasing: intent: Get an app subscription charge (2020-04) effect: read questions: - Can I see whether a merchant accepted my app's monthly plan using release 2020-04? - Which ID does 2020-04 need to look up a recurring application charge? instructions: - text: Look up the app subscription charge {charge_id} via 2020-04. slots: charge_id: path.recurring_application_charge_id - text: Using 2020-04, fetch recurring charge {charge_id} limited to {fields}. slots: charge_id: 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}.json'].get update: x-apievangelist-phrasing: intent: Get an app subscription charge (2020-07) effect: read questions: - Is there a 2020-07 endpoint to retrieve one recurring application charge? - Can I confirm a recurring app billing plan is active on 2020-07? instructions: - text: Retrieve recurring application charge {charge_id} through API version 2020-07. slots: charge_id: path.recurring_application_charge_id - text: Confirm the billing plan status of recurring charge {charge_id} on 2020-07. 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}.json'].get update: x-apievangelist-phrasing: intent: Get an app subscription charge effect: read questions: - What call retrieves a single recurring application charge in the 2020-10 Admin API? - Can I read just a few fields of a recurring charge on version 2020-10? instructions: - text: Show recurring application charge {charge_id} with the 2020-10 Admin API. slots: charge_id: path.recurring_application_charge_id - text: Using 2020-10, get only {fields} for recurring charge {charge_id}. slots: charge_id: 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}.json'].get update: x-apievangelist-phrasing: intent: Get an app subscription charge (2021-01) effect: read questions: - Does the January 2021 (2021-01) API let me view a recurring app charge? - Can I audit a merchant's app subscription details on 2021-01? instructions: - text: Audit app subscription {charge_id} via the 2021-01 version. slots: charge_id: path.recurring_application_charge_id - text: With API version 2021-01, return fields {fields} of recurring charge {charge_id}. slots: charge_id: 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}.json'].get update: x-apievangelist-phrasing: intent: Get an app subscription charge (unstable) effect: read questions: - Can I retrieve a recurring application charge through the unstable Admin API? - Is single recurring charge lookup supported on the unstable version? instructions: - text: Get recurring charge {charge_id} against the unstable API. slots: charge_id: path.recurring_application_charge_id - text: Use the unstable endpoint to read app subscription charge {charge_id}. slots: charge_id: path.recurring_application_charge_id method: generated generated: '2026-09-24' - target: $.paths['/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json'].post update: x-apievangelist-phrasing: intent: Bill a usage charge on an app plan (2020-01) effect: write questions: - How do I bill a merchant for metered usage on top of their app plan with the 2020-01 API? - Can version 2020-01 add a usage charge under a recurring charge? instructions: - text: Create a usage charge under recurring charge {charge_id} using 2020-01. slots: charge_id: path.recurring_application_charge_id - text: On 2020-01, bill metered usage against app subscription {charge_id}. slots: charge_id: path.recurring_application_charge_id method: generated generated: '2026-09-24' - target: $.paths['/admin/api/2020-01/recurring_application_charges/{recurring_application_charge_id}/usage_charges/{usage_charge_id}.json'].get update: x-apievangelist-phrasing: intent: Get one usage charge (2020-01) effect: read questions: - How do I look up a single usage charge I billed with the 2020-01 API? - Which two IDs does version 2020-01 need to fetch a usage charge? instructions: - text: Get usage charge {usage_charge_id} under recurring charge {charge_id} using 2020-01. slots: charge_id: path.recurring_application_charge_id usage_charge_id: path.usage_charge_id - text: On 2020-01, show fields {fields} of usage charge {usage_charge_id} on plan {charge_id}. slots: charge_id: path.recurring_application_charge_id usage_charge_id: path.usage_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'].post update: x-apievangelist-phrasing: intent: Bill a usage charge on an app plan (2020-04) effect: write questions: - Can I charge for extra usage beyond a merchant's base subscription on release 2020-04? - Which recurring charge does a 2020-04 usage charge attach to? instructions: - text: Add a usage charge to recurring charge {charge_id} via 2020-04. slots: charge_id: path.recurring_application_charge_id - text: Using 2020-04, record billable usage on subscription {charge_id}. 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}/usage_charges/{usage_charge_id}.json'].get update: x-apievangelist-phrasing: intent: Get one usage charge (2020-04) effect: read questions: - Can I verify a metered fee was recorded using release 2020-04? - Does 2020-04 let me retrieve a usage charge by ID? instructions: - text: Verify usage charge {usage_charge_id} on subscription {charge_id} via 2020-04. slots: charge_id: path.recurring_application_charge_id usage_charge_id: path.usage_charge_id - text: Using 2020-04, fetch {fields} for usage charge {usage_charge_id} of recurring charge {charge_id}. slots: charge_id: path.recurring_application_charge_id usage_charge_id: path.usage_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'].post update: x-apievangelist-phrasing: intent: Bill a usage charge on an app plan (2020-07) effect: write questions: - Is there a 2020-07 endpoint for creating usage charges? - Can I bill per-use fees to a merchant through 2020-07? instructions: - text: Bill per-use fees on recurring charge {charge_id} through API version 2020-07. slots: charge_id: path.recurring_application_charge_id - text: Post a new usage charge for app plan {charge_id} on 2020-07. 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}/usage_charges/{usage_charge_id}.json'].get update: x-apievangelist-phrasing: intent: Get one usage charge (2020-07) effect: read questions: - Is there a 2020-07 endpoint that retrieves a usage charge? - Can I check a past usage fee by its ID on 2020-07? instructions: - text: Retrieve usage charge {usage_charge_id} for plan {charge_id} through API version 2020-07. slots: charge_id: path.recurring_application_charge_id usage_charge_id: path.usage_charge_id - text: Check past usage fee {usage_charge_id} billed under {charge_id} on 2020-07. slots: charge_id: path.recurring_application_charge_id usage_charge_id: path.usage_charge_id method: generated generated: '2026-09-24' - target: $.paths['/admin/api/2020-10/recurring_application_charges/{recurring_application_charge_id}/usage_charges.json'].post update: x-apievangelist-phrasing: intent: Bill a usage charge on an app plan effect: write questions: - What call creates a usage charge in the 2020-10 Admin API? - Can my app add metered fees to an active recurring charge on version 2020-10? instructions: - text: Create a usage charge on recurring charge {charge_id} with the 2020-10 Admin API. slots: charge_id: path.recurring_application_charge_id - text: Using 2020-10, charge metered usage to app subscription {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}/usage_charges/{usage_charge_id}.json'].get update: x-apievangelist-phrasing: intent: Get one usage charge effect: read questions: - What call retrieves a single usage charge in the 2020-10 Admin API? - Can I read selected fields of one usage charge on version 2020-10? instructions: - text: Show usage charge {usage_charge_id} on recurring charge {charge_id} with the 2020-10 Admin API. slots: charge_id: path.recurring_application_charge_id usage_charge_id: path.usage_charge_id - text: Using 2020-10, get only {fields} of usage charge {usage_charge_id} under {charge_id}. slots: charge_id: path.recurring_application_charge_id usage_charge_id: path.usage_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'].post update: x-apievangelist-phrasing: intent: Bill a usage charge on an app plan (2021-01) effect: write questions: - Does the January 2021 (2021-01) API support usage-based app billing? - Can I add a usage fee to a merchant's plan on 2021-01? instructions: - text: Add a usage fee to plan {charge_id} via the 2021-01 version. slots: charge_id: path.recurring_application_charge_id - text: With API version 2021-01, create a usage charge beneath recurring charge {charge_id}. 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}/usage_charges/{usage_charge_id}.json'].get update: x-apievangelist-phrasing: intent: Get one usage charge (2021-01) effect: read questions: - Does the January 2021 (2021-01) API let me view a usage charge? - Can I reconcile a single metered fee against my records on 2021-01? instructions: - text: Reconcile usage charge {usage_charge_id} of subscription {charge_id} via the 2021-01 version. slots: charge_id: path.recurring_application_charge_id usage_charge_id: path.usage_charge_id - text: With API version 2021-01, return fields {fields} of usage charge {usage_charge_id} on {charge_id}. slots: charge_id: path.recurring_application_charge_id usage_charge_id: path.usage_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'].post update: x-apievangelist-phrasing: intent: Bill a usage charge on an app plan (unstable) effect: write questions: - Can I create a usage charge through the unstable Admin API? - Is usage billing available on the unstable version? instructions: - text: Create a usage charge for recurring charge {charge_id} against the unstable API. slots: charge_id: path.recurring_application_charge_id - text: Use the unstable endpoint to bill usage on app plan {charge_id}. 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}/usage_charges/{usage_charge_id}.json'].get update: x-apievangelist-phrasing: intent: Get one usage charge (unstable) effect: read questions: - Can I retrieve a usage charge through the unstable Admin API? - Is single usage charge lookup supported on the unstable version? instructions: - text: Get usage charge {usage_charge_id} under {charge_id} against the unstable API. slots: charge_id: path.recurring_application_charge_id usage_charge_id: path.usage_charge_id - text: Use the unstable endpoint to read metered charge {usage_charge_id} on plan {charge_id}. slots: charge_id: path.recurring_application_charge_id usage_charge_id: path.usage_charge_id method: generated generated: '2026-09-24'