Pp Square

Square — Printing Press CLI

Prerequisites: Install the CLI

This skill drives the square-pp-cli binary. You must verify the CLI is installed before invoking any command from this skill. If it is missing, install it first:

1. Install via the Printing Press installer. It defaults binaries to $HOME/.local/bin on macOS/Linux and %LOCALAPPDATA%\Programs\PrintingPress\bin on Windows:

   npx -y @mvanhorn/printing-press-library install square --cli-only
   

2. Verify: square-pp-cli --version
3. Ensure the reported install directory is on $PATH for the agent/runtime that will invoke this skill.

If the npx install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.6 or newer). This installs into $GOPATH/bin (default $HOME/go/bin), so add that directory to $PATH instead:

go install github.com/mvanhorn/printing-press-library/library/commerce/square/cmd/square-pp-cli@latest

If --version reports "command not found" after install, the runtime cannot see the binary directory on $PATH. Do not proceed with skill commands until verification succeeds.

Use one scriptable CLI for payments, orders, catalog, inventory, customers, bookings, staff, and developer operations. Sync selected resources locally, then run close reconciliation, inventory drift, customer timelines, webhook health checks, and service reviews with compact agent-ready output.

When to Use This CLI

Use this CLI for Square API automation, operator investigations, local history, and cross-resource analysis involving payments, orders, inventory, customers, bookings, or integrations. Prefer it when a repeatable command, offline search, or compact agent result is more useful than clicking through the Square Dashboard or writing a one-off SDK script.

Anti-triggers

Do not use this CLI for:

• Do not use this CLI to collect or handle raw card numbers; use Square's approved Web Payments or Mobile Payments SDKs.
• Do not run production payment, refund, payout, or destructive mutations without explicit human approval and a reviewed request.
• Do not use this CLI for Square Dashboard-only features that are absent from the public API.
• Do not treat mock verification as proof that a production Square account or location is configured correctly.

Unique Capabilities

These capabilities aren't available in any other tool for this API.

Operational reconciliation

• reconcile close — Explain the difference between sales, collected payments, refunds, disputes, and payouts for each location.

  Use this when an operator needs an explainable close instead of several unrelated API responses.

  square-pp-cli reconcile close --since 24h --agent
  

• inventory drift — See which prices, variations, availability settings, and location counts changed since an earlier snapshot.

  Use this before opening or publishing a menu when current-state API calls cannot explain what changed.

  square-pp-cli inventory drift --since 7d --agent
  

Connected customer operations

• customer timeline — Follow one customer's orders, payments, refunds, loyalty activity, invoices, and bookings in chronological order.

  Use this for customer-service investigations that otherwise require carrying IDs between services.

  square-pp-cli customer timeline CUSTOMER_ABC123 --agent
  

• service review — Review completed, unpaid, and missed appointments alongside staff and location utilization.

  Use this for a service business's weekly operating review instead of assembling separate reports.

  square-pp-cli service review --since 7d --agent
  

Integration confidence

• webhook health — Measure duplicate locally ingested webhook deliveries, ordering problems, delivery lag, gaps, and subscription changes.

  Use this before releases or during incidents when a subscription listing cannot reveal delivery behavior.

  square-pp-cli webhook health --since 24h --agent
  

• request check — Validate a planned Square request, environment, API version, mutation policy, and idempotency before anything is sent.

  Use this before a risky sandbox or production call when schema validity alone is not enough.

  square-pp-cli request check --method POST --path /v2/payments --body payment-request.json --agent
  

Command Reference

apple-pay — Manage apple pay

• square-pp-cli apple-pay — Activates a domain for use with Apple Pay on the Web and Square.

bank-accounts — Manage bank accounts

• square-pp-cli bank-accounts create — Store a bank account on file for a square account
• square-pp-cli bank-accounts get — Retrieve details of a BankAccount bank account linked to a Square account.
• square-pp-cli bank-accounts get-by-v1-id — Returns details of a BankAccount identified by V1 bank account ID.
• square-pp-cli bank-accounts list — Returns a list of BankAccount objects linked to a Square account.

bookings — Manage bookings

• square-pp-cli bookings bulk-delete-custom-attributes — Bulk deletes bookings custom attributes.
• square-pp-cli bookings bulk-retrieve — Bulk-Retrieves a list of bookings by booking IDs.
• square-pp-cli bookings bulk-retrieve-team-member-profiles — Retrieves one or more team members' booking profiles.
• square-pp-cli bookings bulk-upsert-custom-attributes — Bulk upserts bookings custom attributes.
• square-pp-cli bookings create — Creates a booking. The required input must include the following: - Booking.location_id - `Booking.
• square-pp-cli bookings create-custom-attribute-definition — Creates a bookings custom attribute definition.
• square-pp-cli bookings delete-custom-attribute-definition — Deletes a bookings custom attribute definition.
• square-pp-cli bookings list — Retrieve a collection of bookings.
• square-pp-cli bookings list-custom-attribute-definitions — Get all bookings custom attribute definitions.
• square-pp-cli bookings list-location-profiles — Lists location booking profiles of a seller.
• square-pp-cli bookings list-team-member-profiles — Lists booking profiles for team members.
• square-pp-cli bookings retrieve — Retrieves a booking. To call this endpoint with buyer-level permissions, set APPOINTMENTS_READ for the OAuth scope.
• square-pp-cli bookings retrieve-business-profile — Retrieves a seller's booking profile.
• square-pp-cli bookings retrieve-custom-attribute-definition — Retrieves a bookings custom attribute definition.
• square-pp-cli bookings retrieve-location-profile — Retrieves a seller's location booking profile.
• square-pp-cli bookings retrieve-team-member-profile — Retrieves a team member's booking profile.
• square-pp-cli bookings search-availability — Searches for availabilities for booking.
• square-pp-cli bookings update — Updates a booking. To call this endpoint with buyer-level permissions, set APPOINTMENTS_WRITE for the OAuth scope.
• square-pp-cli bookings update-custom-attribute-definition — Updates a bookings custom attribute definition.

cards — Manage cards

• square-pp-cli cards create — Adds a card on file to an existing merchant.
• square-pp-cli cards list — Retrieves a list of cards owned by the account making the request. A max of 25 cards will be returned.
• square-pp-cli cards retrieve — Retrieves details for a specific Card.

cash-drawers — Manage cash drawers

• square-pp-cli cash-drawers list-shift-events — Provides a paginated list of events for a single cash drawer shift.
• square-pp-cli cash-drawers list-shifts — Provides the details for all of the cash drawer shifts for a location in a date range.
• square-pp-cli cash-drawers retrieve-shift — Provides the summary details for a single cash drawer shift.

catalog — Manage catalog

• square-pp-cli catalog batch-delete-objects — Deletes a set of CatalogItem
• square-pp-cli catalog batch-retrieve-objects — Returns a set of objects based on the provided ID.
• square-pp-cli catalog batch-upsert-objects — Creates or updates up to 10,000 target objects based on the provided list of objects.
• square-pp-cli catalog create-image — Uploads an image file to be represented by a CatalogImage
• square-pp-cli catalog delete-object — Deletes a single CatalogObject
• square-pp-cli catalog get — Retrieves information about the Square Catalog API
• square-pp-cli catalog list — Returns a list of all CatalogObjects of the specified types in the catalog.
• square-pp-cli catalog retrieve-object — Returns a single CatalogItem as a CatalogObject based on the provided ID.
• square-pp-cli catalog search-items — Searches for catalog items or item variations by matching supported search attribute values
• square-pp-cli catalog search-objects — Searches for CatalogObject of any type by matching supported search attribute values
• square-pp-cli catalog update-image — Uploads a new image file to replace the existing one in the specified CatalogImage object.
• square-pp-cli catalog update-item-modifier-lists — Updates the CatalogModifierList objects that apply to the targeted [CatalogItem](entity
• square-pp-cli catalog update-item-taxes — Updates the CatalogTax objects that apply to the targeted CatalogItem
• square-pp-cli catalog upsert-object — Creates a new or updates the specified CatalogObject.

channels — Manage channels

• square-pp-cli channels bulk-retrieve — Bulk retrieve channels
• square-pp-cli channels list — List channels
• square-pp-cli channels retrieve — Retrieve channel

customers — Manage customers

• square-pp-cli customers bulk-create — Creates multiple customer profiles for a business.
• square-pp-cli customers bulk-delete — Deletes multiple customer profiles. The endpoint takes a list of customer IDs and returns a map of responses.
• square-pp-cli customers bulk-retrieve — Retrieves multiple customer profiles. This endpoint takes a list of customer IDs and returns a map of responses.
• square-pp-cli customers bulk-update — Updates multiple customer profiles.
• square-pp-cli customers bulk-upsert-custom-attributes — Creates or updates custom attributes for customer profiles as a bulk operation.
• square-pp-cli customers create — Creates a new customer for a business.
• square-pp-cli customers create-custom-attribute-definition — Creates a customer-related custom attribute definition for a Square seller account.
• square-pp-cli customers create-group — Creates a new customer group for a business. The request must include the name value of the group.
• square-pp-cli customers delete — Deletes a customer profile from a business.
• square-pp-cli customers delete-custom-attribute-definition — Deletes a customer-related custom attribute definition from a Square seller account.
• square-pp-cli customers delete-group — Deletes a customer group as identified by the group_id value.
• square-pp-cli customers list — Lists customer profiles associated with a Square account.
• square-pp-cli customers list-custom-attribute-definitions — Lists the customer-related custom attribute definitions
• square-pp-cli customers list-groups — Retrieves the list of customer groups of a business.
• square-pp-cli customers list-segments — Retrieves the list of customer segments of a business.
• square-pp-cli customers retrieve — Returns details for a single customer.
• square-pp-cli customers retrieve-custom-attribute-definition — Retrieves a customer-related custom attribute definition
• square-pp-cli customers retrieve-group — Retrieves a specific customer group as identified by the group_id value.
• square-pp-cli customers retrieve-segment — Retrieves a specific customer segment as identified by the segment_id value.
• square-pp-cli customers search — Searches the customer profiles associated with a Square account using one or more supported query filters.
• square-pp-cli customers update — Updates a customer profile.
• square-pp-cli customers update-custom-attribute-definition — Updates a customer-related custom attribute definition for a Square seller account.
• square-pp-cli customers update-group — Updates a customer group as identified by the group_id value.

devices — Manage devices

• square-pp-cli devices create-code — Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode.
• square-pp-cli devices get — Retrieves Device with the associated device_id.
• square-pp-cli devices get-code — Retrieves DeviceCode with the associated ID.
• square-pp-cli devices list — List devices associated with the merchant. Currently, only Terminal API devices are supported.
• square-pp-cli devices list-codes — Lists all DeviceCodes associated with the merchant.

disputes — Manage disputes

• square-pp-cli disputes list — Returns a list of disputes associated with a particular account.
• square-pp-cli disputes retrieve — Returns details about a specific dispute.

employees — Manage employees

• square-pp-cli employees list — List employees
• square-pp-cli employees retrieve — Retrieve employee

events — Manage events

• square-pp-cli events disable — Disables events to prevent them from being searchable. All events are disabled by default.
• square-pp-cli events enable — Enables events to make them searchable. Only events that occur while in the enabled state are searchable.
• square-pp-cli events list-types — Lists all event types that you can subscribe to as webhooks or query using the Events API.
• square-pp-cli events search — Search for Square API events that occur within a 28-day timeframe.

gift-cards — Manage gift cards

• square-pp-cli gift-cards create — Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card has a PENDING state.
• square-pp-cli gift-cards create-activity — Creates a gift card activity to manage the balance or state of a gift card.
• square-pp-cli gift-cards list — Lists all gift cards. You can specify optional filters to retrieve a subset of the gift cards.
• square-pp-cli gift-cards list-activities — Lists gift card activities. By default, you get gift card activities for all gift cards in the seller's account.
• square-pp-cli gift-cards retrieve — Retrieves a gift card using the gift card ID.
• square-pp-cli gift-cards retrieve-from-gan — Retrieves a gift card using the gift card account number (GAN).
• square-pp-cli gift-cards retrieve-from-nonce — Retrieves a gift card using a secure payment token that represents the gift card.

inventory — Manage inventory

• square-pp-cli inventory batch-change — Applies adjustments and counts to the provided item quantities.
• square-pp-cli inventory batch-retrieve-changes — Returns historical physical counts and adjustments based on the provided filter criteria.
• square-pp-cli inventory batch-retrieve-counts — Returns current counts for the provided CatalogObjects at the requested [Location](entity
• square-pp-cli inventory create-adjustment-reason — Creates a custom inventory adjustment reason.
• square-pp-cli inventory delete-adjustment-reason — Soft deletes a custom inventory adjustment reason.
• square-pp-cli inventory deprecated-batch-change — Deprecated version of BatchChangeInventory
• square-pp-cli inventory deprecated-batch-retrieve-changes — Deprecated version of BatchRetrieveInventoryChanges
• square-pp-cli inventory deprecated-batch-retrieve-counts — Deprecated version of BatchRetrieveInventoryCounts
• square-pp-cli inventory deprecated-retrieve-adjustment — Deprecated version of RetrieveInventoryAdjustment
• square-pp-cli inventory deprecated-retrieve-physical-count — Deprecated version of RetrieveInventoryPhysicalCount
• square-pp-cli inventory list-adjustment-reasons — Returns the standard and custom inventory adjustment reasons available to the seller.
• square-pp-cli inventory restore-adjustment-reason — Restores a soft-deleted custom inventory adjustment reason.
• square-pp-cli inventory retrieve-adjustment — Returns the InventoryAdjustment object with the provided adjustment_id.
• square-pp-cli inventory retrieve-adjustment-reason — Returns the inventory adjustment reason identified by the provided reason_id.
• square-pp-cli inventory retrieve-count — Retrieves the current calculated stock count for a given CatalogObject
• square-pp-cli inventory retrieve-physical-count — Returns the InventoryPhysicalCount object with the provided physical_count_id.
• square-pp-cli inventory update-adjustment — Applies an update to the provided adjustment. On success: returns the newly updated adjustment.
• square-pp-cli inventory update-adjustment-reason — Updates a custom inventory adjustment reason.

invoices — Manage invoices

• square-pp-cli invoices create — Creates a draft invoice for an order created using the Orders API.
• square-pp-cli invoices delete — Deletes the specified invoice. When an invoice is deleted, the associated order status changes to CANCELED.
• square-pp-cli invoices get — Retrieves an invoice by invoice ID.
• square-pp-cli invoices list — Returns a list of invoices for a given location. The response is paginated.
• square-pp-cli invoices search — Searches for invoices from a location specified in the filter.
• square-pp-cli invoices update — Updates an invoice.

labor — Manage labor

• square-pp-cli labor bulk-publish-scheduled-shifts — Publishes 1 - 100 scheduled shifts.
• square-pp-cli labor create-break-type — Creates a new BreakType. A BreakType is a template for creating Break objects.
• square-pp-cli labor create-scheduled-shift — Creates a scheduled shift by providing draft shift details such as job ID, team member assignment
• square-pp-cli labor create-shift — Creates a new Shift. A Shift represents a complete workday for a single team member.
• square-pp-cli labor create-timecard — Creates a new Timecard. A Timecard represents a complete workday for a single team member.
• square-pp-cli labor delete-break-type — Deletes an existing BreakType. A BreakType can be deleted even if it is referenced from a Shift.
• square-pp-cli labor delete-shift — Deletes a Shift.
• square-pp-cli labor delete-timecard — Deletes a Timecard.
• square-pp-cli labor get-break-type — Returns a single BreakType specified by id.
• square-pp-cli labor get-employee-wage — Returns a single EmployeeWage specified by id.
• square-pp-cli labor get-shift — Returns a single Shift specified by id.
• square-pp-cli labor get-team-member-wage — Returns a single TeamMemberWage specified by id.
• square-pp-cli labor list-break-types — Returns a paginated list of BreakType instances for a business.
• square-pp-cli labor list-employee-wages — Returns a paginated list of EmployeeWage instances for a business.
• square-pp-cli labor list-team-member-wages — Returns a paginated list of TeamMemberWage instances for a business.
• square-pp-cli labor list-workweek-configs — Returns a list of WorkweekConfig instances for a business.
• square-pp-cli labor publish-scheduled-shift — Publishes a scheduled shift.
• square-pp-cli labor retrieve-scheduled-shift — Retrieves a scheduled shift by ID.
• square-pp-cli labor retrieve-timecard — Returns a single Timecard specified by id.
• square-pp-cli labor search-scheduled-shifts — Returns a paginated list of scheduled shifts, with optional filter and sort settings.
• square-pp-cli labor search-shifts — Returns a paginated list of Shift records for a business.
• square-pp-cli labor search-timecards — Returns a paginated list of Timecard records for a business.
• square-pp-cli labor update-break-type — Updates an existing BreakType.
• square-pp-cli labor update-scheduled-shift — Updates the draft shift details for a scheduled shift.
• square-pp-cli labor update-shift — Updates an existing Shift.
• square-pp-cli labor update-timecard — Updates an existing Timecard.
• square-pp-cli labor update-workweek-config — Updates a WorkweekConfig.

locations — Manage locations

• square-pp-cli locations bulk-delete-custom-attributes — Deletes custom attributes for locations as a bulk operation.
• square-pp-cli locations bulk-upsert-custom-attributes — Creates or updates custom attributes for locations as a bulk operation.
• square-pp-cli locations create — Creates a location.
• square-pp-cli locations create-custom-attribute-definition — Creates a location-related custom attribute definition for a Square seller account.
• square-pp-cli locations delete-custom-attribute-definition — Deletes a location-related custom attribute definition from a Square seller account.
• square-pp-cli locations list — Provides details about all of the seller's [locations](https://developer.squareup.
• square-pp-cli locations list-custom-attribute-definitions — Lists the location-related custom attribute definitions
• square-pp-cli locations retrieve — Retrieves details of a single location.
• square-pp-cli locations retrieve-custom-attribute-definition — Retrieves a location-related custom attribute definition
• square-pp-cli locations update — Updates a location.
• square-pp-cli locations update-custom-attribute-definition — Updates a location-related custom attribute definition for a Square seller account.

loyalty — Manage loyalty

• square-pp-cli loyalty accumulate-points — Adds points earned from a purchase to a loyalty account.
• square-pp-cli loyalty adjust-points — Adds points to or subtracts points from a buyer's account.
• square-pp-cli loyalty calculate-points — Calculates the number of points a buyer can earn from a purchase.
• square-pp-cli loyalty cancel-promotion — Cancels a loyalty promotion.
• square-pp-cli loyalty create-account — Creates a loyalty account.
• square-pp-cli loyalty create-promotion — Creates a loyalty promotion for a loyalty program.
• square-pp-cli loyalty create-reward — Creates a loyalty reward.
• square-pp-cli loyalty delete-reward — Deletes a loyalty reward by doing the following: - Returns the loyalty points back to the loyalty account.
• square-pp-cli loyalty list-programs — Returns a list of loyalty programs in the seller's account.
• square-pp-cli loyalty list-promotions — Lists the loyalty promotions associated with a loyalty program.
• square-pp-cli loyalty redeem-reward — Redeems a loyalty reward. The endpoint sets the reward to the REDEEMED terminal state.
• square-pp-cli loyalty retrieve-account — Retrieves a loyalty account.
• square-pp-cli loyalty retrieve-program — Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword main.
• square-pp-cli loyalty retrieve-promotion — Retrieves a loyalty promotion.
• square-pp-cli loyalty retrieve-reward — Retrieves a loyalty reward.
• square-pp-cli loyalty search-accounts — Searches for loyalty accounts in a loyalty program.
• square-pp-cli loyalty search-events — Searches for loyalty events.
• square-pp-cli loyalty search-rewards — Searches for loyalty rewards.

merchants — Manage merchants

• square-pp-cli merchants bulk-delete-custom-attributes — Deletes custom attributes for a merchant as a bulk operation.
• square-pp-cli merchants bulk-upsert-custom-attributes — Creates or updates custom attributes for a merchant as a bulk operation.
• square-pp-cli merchants create-custom-attribute-definition — Creates a merchant-related custom attribute definition for a Square seller account.
• square-pp-cli merchants delete-custom-attribute-definition — Deletes a merchant-related custom attribute definition from a Square seller account.
• square-pp-cli merchants list — Provides details about the merchant associated with a given access token.
• square-pp-cli merchants list-custom-attribute-definitions — Lists the merchant-related custom attribute definitions
• square-pp-cli merchants retrieve — Retrieves the Merchant object for the given merchant_id.
• square-pp-cli merchants retrieve-custom-attribute-definition — Retrieves a merchant-related custom attribute definition
• square-pp-cli merchants update-custom-attribute-definition — Updates a merchant-related custom attribute definition for a Square seller account.

oauth2 — Manage oauth2

• square-pp-cli oauth2 obtain-token — Returns an OAuth access token and refresh token using the authorization_code or refresh_token grant type.
• square-pp-cli oauth2 retrieve-token-status — Returns information about an [OAuth access token](https://developer.squareup.
• square-pp-cli oauth2 revoke-token — Revokes an access token generated with the OAuth flow.

online-checkout — Manage online checkout

• square-pp-cli online-checkout create-payment-link — Creates a Square-hosted checkout page.
• square-pp-cli online-checkout delete-payment-link — Deletes a payment link.
• square-pp-cli online-checkout list-payment-links — Lists all payment links.
• square-pp-cli online-checkout retrieve-location-settings — Retrieves the location-level settings for a Square-hosted checkout page.
• square-pp-cli online-checkout retrieve-merchant-settings — Retrieves the merchant-level settings for a Square-hosted checkout page.
• square-pp-cli online-checkout retrieve-payment-link — Retrieves a payment link.
• square-pp-cli online-checkout update-location-settings — Updates the location-level settings for a Square-hosted checkout page.
• square-pp-cli online-checkout update-merchant-settings — Updates the merchant-level settings for a Square-hosted checkout page.
• square-pp-cli online-checkout update-payment-link — Updates a payment link.

orders — Manage orders

• square-pp-cli orders batch-retrieve — Retrieves a set of orders by their IDs.
• square-pp-cli orders bulk-delete-custom-attributes — Deletes order custom attributes as a bulk operation.
• square-pp-cli orders bulk-upsert-custom-attributes — Creates or updates order custom attributes as a bulk operation.
• square-pp-cli orders calculate — Enables applications to preview order pricing without creating an order.
• square-pp-cli orders clone — Creates a new order, in the DRAFT state, by duplicating an existing order.
• square-pp-cli orders create — Creates a new order
• square-pp-cli orders create-custom-attribute-definition — Creates an order-related custom attribute definition.
• square-pp-cli orders delete-custom-attribute-definition — Deletes an order-related custom attribute definition from a Square seller account.
• square-pp-cli orders list-custom-attribute-definitions — Lists the order-related custom attribute definitions
• square-pp-cli orders retrieve — Retrieves an Order by ID.
• square-pp-cli orders retrieve-custom-attribute-definition — Retrieves an order-related custom attribute definition from a Square seller account.
• square-pp-cli orders search — Search all orders for one or more locations.
• square-pp-cli orders update — Updates an open order by adding, replacing, or deleting fields.
• square-pp-cli orders update-custom-attribute-definition — Updates an order-related custom attribute definition for a Square seller account.

payments — Manage payments

• square-pp-cli payments cancel-by-idempotency-key — Cancels (voids) a payment identified by the idempotency key that is specified in the request.
• square-pp-cli payments create — Creates a payment using the provided source.
• square-pp-cli payments get — Retrieves details for a specific payment.
• square-pp-cli payments list — Retrieves a list of payments taken by the account making the request.
• square-pp-cli payments update — Updates a payment with the APPROVED status. You can update the amount_money and tip_money using this endpoint.

payouts — Manage payouts

• square-pp-cli payouts get — Retrieves details of a specific payout identified by a payout ID.
• square-pp-cli payouts list — Retrieves a list of all payouts for the default location.

refunds — Manage refunds

• square-pp-cli refunds get-payment — Retrieves a specific refund using the refund_id.
• square-pp-cli refunds list-payment — Retrieves a list of refunds for the account making the request.
• square-pp-cli refunds payment — Refunds a payment. You can refund the entire payment amount or a portion of it.

reporting — Manage reporting

• square-pp-cli reporting get-metadata — Returns available reporting cubes, measures, and dimensions.
• square-pp-cli reporting load-query — Runs a reporting query.

sites — Manage sites

• square-pp-cli sites — Lists the Square Online sites that belong to a seller. Sites are listed in descending order by the created_at date.

subscriptions — Manage subscriptions

• square-pp-cli subscriptions bulk-swap-plan — Schedules a plan variation change for all active subscriptions under a given plan variation.
• square-pp-cli subscriptions create — Enrolls a customer in a subscription.
• square-pp-cli subscriptions retrieve — Retrieves a specific subscription.
• square-pp-cli subscriptions search — Searches for subscriptions. Results are ordered chronologically by subscription creation date.
• square-pp-cli subscriptions update — Updates a subscription by modifying or clearing subscription field values. To clear a field, set its value to null.

team-members — Manage team members

• square-pp-cli team-members bulk-create — Creates multiple TeamMember objects. The created TeamMember objects are returned on successful creates.
• square-pp-cli team-members bulk-update — Updates multiple TeamMember objects. The updated TeamMember objects are returned on successful updates.
• square-pp-cli team-members create — Creates a single TeamMember object. The TeamMember object is returned on successful creates.
• square-pp-cli team-members create-job — Creates a job in a seller account. A job defines a title and tip eligibility.
• square-pp-cli team-members list-jobs — Lists jobs in a seller account. Results are sorted by title in ascending order.
• square-pp-cli team-members retrieve — Retrieves a TeamMember object for the given TeamMember.id.
• square-pp-cli team-members retrieve-job — Retrieves a specified job.
• square-pp-cli team-members search — Returns a paginated list of TeamMember objects for a business.
• square-pp-cli team-members update — Updates a single TeamMember object. The TeamMember object is returned on successful updates.
• square-pp-cli team-members update-job — Updates the title or tip eligibility of a job.

terminals — Manage terminals

• square-pp-cli terminals cancel-action — Cancels a Terminal action request if the status of the request permits it.
• square-pp-cli terminals cancel-checkout — Cancels a Terminal checkout request if the status of the request permits it.
• square-pp-cli terminals cancel-refund — Cancels an Interac Terminal refund request by refund request ID if the status of the request permits it.
• square-pp-cli terminals create-action — Creates a Terminal action request and sends it to the specified device.
• square-pp-cli terminals create-checkout — Creates a Terminal checkout request and sends it to the specified device to take a payment for the requested amount.
• square-pp-cli terminals create-refund — Creates a request to refund an Interac payment completed on a Square Terminal.
• square-pp-cli terminals dismiss-action — Dismisses a Terminal action request if the status and type of the request permits it.
• square-pp-cli terminals dismiss-checkout — Dismisses a Terminal checkout request if the status and type of the request permits it.
• square-pp-cli terminals dismiss-refund — Dismisses a Terminal refund request if the status and type of the request permits it.
• square-pp-cli terminals get-action — Retrieves a Terminal action request by action_id. Terminal action requests are available for 30 days.
• square-pp-cli terminals get-checkout — Retrieves a Terminal checkout request by checkout_id. Terminal checkout requests are available for 30 days.
• square-pp-cli terminals get-refund — Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days.
• square-pp-cli terminals search-actions — Retrieves a filtered list of Terminal action requests created by the account making the request.
• square-pp-cli terminals search-checkouts — Returns a filtered list of Terminal checkout requests created by the application making the request.
• square-pp-cli terminals search-refunds — Retrieves a filtered list of Interac Terminal refund requests created by the seller making the request.

transfer-orders — Manage transfer orders

• square-pp-cli transfer-orders create — Creates a new transfer order in DRAFT status.
• square-pp-cli transfer-orders delete — Deletes a transfer order in DRAFT status. Only draft orders can be deleted.
• square-pp-cli transfer-orders retrieve — Retrieves a specific TransferOrder by ID.
• square-pp-cli transfer-orders search — Searches for transfer orders using filters.
• square-pp-cli transfer-orders update — Updates an existing transfer order.

vendors — Manage vendors

• square-pp-cli vendors bulk-create — Creates one or more Vendor objects to represent suppliers to a seller.
• square-pp-cli vendors bulk-retrieve — Retrieves one or more vendors of specified Vendor IDs.
• square-pp-cli vendors bulk-update — Updates one or more of existing Vendor objects as suppliers to a seller.
• square-pp-cli vendors create — Creates a single Vendor object to represent a supplier to a seller.
• square-pp-cli vendors retrieve — Retrieves the vendor of a specified Vendor ID.
• square-pp-cli vendors search — Searches for vendors using a filter against supported Vendor properties and a supported sorter.
• square-pp-cli vendors update — Updates an existing Vendor object as a supplier to a seller.

webhooks — Manage webhooks

• square-pp-cli webhooks create-subscription — Creates a webhook subscription.
• square-pp-cli webhooks delete-subscription — Deletes a webhook subscription.
• square-pp-cli webhooks list-event-types — Lists all webhook event types that can be subscribed to.
• square-pp-cli webhooks list-subscriptions — Lists all webhook subscriptions owned by your application.
• square-pp-cli webhooks retrieve-subscription — Retrieves a webhook subscription identified by its ID.
• square-pp-cli webhooks test-subscription — Tests a webhook subscription by sending a test event to the notification URL.
• square-pp-cli webhooks update-subscription — Updates a webhook subscription.
• square-pp-cli webhooks update-subscription-signature-key — Updates a webhook subscription by replacing the existing signature key with a new one.

Finding the right command

When you know what you want to do but not which command does it, ask the CLI directly:

square-pp-cli which "<capability in your own words>"

which resolves a natural-language capability query to the best matching command from this CLI's curated feature index. Exit code 0 means at least one match; exit code 2 means no confident match — fall back to --help or use a narrower query.

Recipes

Explain yesterday's close

square-pp-cli reconcile close --since 24h --agent --select locations.location_name,locations.gross_sales,locations.gross_payments,locations.refunds,locations.net_collected,locations.payouts

Return only the location and settlement fields an agent needs to explain a discrepancy.

Review stock drift

square-pp-cli inventory drift --since 7d --agent

Compare retained catalog and inventory snapshots across locations.

Trace a customer

square-pp-cli customer timeline CUSTOMER_ABC123 --agent

Assemble connected customer activity into one chronological record.

Check webhook delivery

square-pp-cli webhook health --since 24h --agent

Analyze real webhook receipts previously captured with webhook ingest, plus retained subscription drift.

Validate a payment request offline

square-pp-cli request check --method POST --path /v2/payments --body payment-request.json --agent

Check the method and path against the shipped API contract, then inspect JSON readability, environment, API version, explicit mutation approval, and idempotency before sending anything.

Auth Setup

Use a Square sandbox token while learning or testing. Set SQUARE_ACCESS_TOKEN outside your shell history and set SQUARE_BASE_URL=https://connect.squareupsandbox.com for sandbox calls. Inspect mutation help and use --dry-run before explicitly approving any write. Production and sandbox tokens are not interchangeable.

Run square-pp-cli doctor to verify setup.

Agent Mode

Add --agent to any command. Expands to: --json --compact --no-input --no-color --yes.

• Pipeable — JSON on stdout, errors on stderr

• Filterable — --select keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs:

  square-pp-cli bank-accounts list --agent --select id,name,status
  

• Previewable — --dry-run shows the request without sending

• **Offline-

…(truncated)