# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Square Checkout API version: 1.0.0 extends: openapi/square-checkout-api-openapi.yml actions: - target: $.info update: x-apievangelist-phrasing: method: generated generated: '2026-09-26' generator: build-phrasing.py label: Generated by API Evangelist operations: 10 - target: $.paths['/v2/locations/{location_id}/checkouts'].post update: x-apievangelist-phrasing: intent: Create a legacy hosted checkout for an order effect: write questions: - How do I send buyers to a hosted checkout page for an order using the older Checkout endpoint? - Can the legacy location checkout ask the buyer for a shipping address? instructions: - text: Create a legacy checkout at location {location_id} for order {order}. slots: location_id: path.location_id order: requestBody.order - text: Create a location {location_id} checkout for {order} that redirects to {redirect_url}. slots: location_id: path.location_id order: requestBody.order redirect_url: requestBody.redirect_url method: generated generated: '2026-09-26' - target: $.paths['/v2/online-checkout/location-settings/{location_id}'].get update: x-apievangelist-phrasing: intent: Get checkout page settings for a location effect: read questions: - What tipping and custom field settings does a location's hosted checkout use? - Can I see the checkout page configuration for one location? instructions: - text: Get checkout location settings for {location_id}. slots: location_id: path.location_id - text: Show hosted checkout settings for location {location_id}. slots: location_id: path.location_id method: generated generated: '2026-09-26' - target: $.paths['/v2/online-checkout/location-settings/{location_id}'].put update: x-apievangelist-phrasing: intent: Update checkout page settings for a location effect: write questions: - Can I change the hosted checkout options for just one location? - How do I update a location's checkout page policies or branding? instructions: - text: Update checkout settings for location {location_id} to {location_settings}. slots: location_id: path.location_id location_settings: requestBody.location_settings - text: Apply {location_settings} to the hosted checkout of location {location_id}. slots: location_settings: requestBody.location_settings location_id: path.location_id method: generated generated: '2026-09-26' - target: $.paths['/v2/online-checkout/merchant-settings'].get update: x-apievangelist-phrasing: intent: Get account-wide checkout page settings effect: read questions: - Which payment methods are enabled on my hosted checkout pages account-wide? - What merchant-level checkout settings apply to every location? instructions: - text: Get my merchant-level checkout settings. - text: Show which payment methods are enabled on hosted checkout for the whole account. method: generated generated: '2026-09-26' - target: $.paths['/v2/online-checkout/merchant-settings'].put update: x-apievangelist-phrasing: intent: Update account-wide checkout page settings effect: write questions: - Can I turn on a payment method for all hosted checkout pages at once? - How do I change checkout settings at the merchant level? instructions: - text: Update merchant checkout settings to {merchant_settings}. slots: merchant_settings: requestBody.merchant_settings - text: Apply {merchant_settings} to hosted checkout across the whole account. slots: merchant_settings: requestBody.merchant_settings method: generated generated: '2026-09-26' - target: $.paths['/v2/online-checkout/payment-links'].get update: x-apievangelist-phrasing: intent: List payment links effect: read questions: - Which payment links have I created so far? - Can I page through my payment links a few at a time? instructions: - text: List all my payment links. - text: Show payment links, {limit} per page. slots: limit: query.limit method: generated generated: '2026-09-26' - target: $.paths['/v2/online-checkout/payment-links'].post update: x-apievangelist-phrasing: intent: Create a payment link effect: write questions: - How do I create a shareable link that lets a buyer pay me? - Can I make a quick pay link for a single item and price? instructions: - text: Create a payment link for {quick_pay}. slots: quick_pay: requestBody.quick_pay - text: Make a Square-hosted payment link for order {order} with note {payment_note}. slots: order: requestBody.order payment_note: requestBody.payment_note method: generated generated: '2026-09-26' - target: $.paths['/v2/online-checkout/payment-links/{id}'].get update: x-apievangelist-phrasing: intent: Get a payment link effect: read questions: - What is the URL and order behind a specific payment link? - Can I look up one payment link by its ID? instructions: - text: Get payment link {id}. slots: id: path.id - text: Show the URL and details of payment link {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/v2/online-checkout/payment-links/{id}'].put update: x-apievangelist-phrasing: intent: Update a payment link effect: write questions: - Can I change the description or checkout options on an existing payment link? - Which payment link fields can't be edited after creation? instructions: - text: Update payment link {id} with {payment_link}. slots: id: path.id payment_link: requestBody.payment_link - text: Change the checkout options on payment link {id} to {payment_link}. slots: id: path.id payment_link: requestBody.payment_link method: generated generated: '2026-09-26' - target: $.paths['/v2/online-checkout/payment-links/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a payment link effect: destructive questions: - How do I deactivate a payment link so no one can pay it? - Can I delete a payment link I shared by mistake? instructions: - text: Delete payment link {id}. slots: id: path.id - text: Remove payment link {id} so it stops accepting payments. slots: id: path.id method: generated generated: '2026-09-26'