Square

Square Loyalty API

The Loyalty API from Square — 16 operation(s) for loyalty.

Documentation GitHub OpenAPI

Business capability

Loyalty & Retention Management BC-420.40

Operations 18

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v2/loyalty/accounts Enroll a buyer in the loyalty program · Square Create Loyalty Account #

Ask an LLM

“How do I sign a customer up for my Square loyalty program using their phone number?”

“What do I need to open a new loyalty account for a buyer?”

Tell an agent

Create a loyalty account from {loyalty_account}.

Enroll this buyer in my loyalty program using {loyalty_account}, with idempotency key {idempotency_key}.

POST /v2/loyalty/accounts/search Find loyalty accounts by phone or customer · Square Search Loyalty Accounts #

Ask an LLM

“Can I look up a loyalty member by their phone number?”

“Which loyalty accounts are tied to a given customer ID?”

Tell an agent

Search loyalty accounts matching {query}.

Find up to {limit} loyalty accounts in my program.

GET /v2/loyalty/accounts/{account_id} Get a loyalty account · Square Retrieve Loyalty Account #

Ask an LLM

“How can I see the point balance on one specific loyalty account?”

“What details come back for a single loyalty account by its ID?”

Tell an agent

Show me loyalty account {account_id}.

Pull up the balance and details of loyalty account {account_id}.

POST /v2/loyalty/accounts/{account_id}/accumulate Award points earned from a purchase · Square Accumulate Loyalty Points #

Ask an LLM

“How do I give a loyalty member the points they earned on an order?”

“Can points be credited from a purchase at a specific location?”

Tell an agent

Add the points earned from {accumulate_points} to loyalty account {account_id} at location {location_id}.

Credit purchase points to loyalty account {account_id} for the sale at {location_id}.

POST /v2/loyalty/accounts/{account_id}/adjust Manually add or subtract loyalty points · Square Adjust Loyalty Points #

Ask an LLM

“How do I manually correct a buyer's loyalty point balance?”

“Can a manual points adjustment leave an account with a negative balance?”

Tell an agent

Adjust the points on loyalty account {account_id} by {adjust_points}.

Deduct points from loyalty account {account_id} with {adjust_points}, allowing a negative balance: {allow_negative_balance}.

POST /v2/loyalty/events/search Search the loyalty points ledger · Square Search Loyalty Events #

Ask an LLM

“Where can I see the history of points earned and redeemed on loyalty accounts?”

“Can I filter loyalty events by type or date range?”

Tell an agent

Search loyalty events matching {query}.

Show the last {limit} loyalty ledger events.

GET /v2/loyalty/programs List the seller's loyalty programs · Square List Loyalty Programs #

Ask an LLM

“What loyalty program does my Square account have set up?”

“Is there a call that returns my loyalty programs without knowing the program ID?”

Tell an agent

List my loyalty programs.

Show every loyalty program on this seller account.

GET /v2/loyalty/programs/{program_id} Get a loyalty program's rules · Square Retrieve Loyalty Program #

Ask an LLM

“How do I read the earning rules and reward tiers of my loyalty program?”

“Can I fetch the loyalty program using the keyword main instead of an ID?”

Tell an agent

Get loyalty program {program_id} with its reward tiers.

Show the accrual rules for loyalty program {program_id}.

POST /v2/loyalty/programs/{program_id}/calculate Preview points a purchase would earn · Square Calculate Loyalty Points #

Ask an LLM

“How many loyalty points would a buyer earn on this purchase?”

“Can I estimate points from a transaction amount without an order?”

Tell an agent

Calculate the points order {order_id} would earn in program {program_id}.

Estimate loyalty points for a {transaction_amount_money} purchase in program {program_id}.

GET /v2/loyalty/programs/{program_id}/promotions List a loyalty program's promotions · Square List Loyalty Promotions #

Ask an LLM

“Which bonus-point promotions are running on my loyalty program?”

“Can I list only scheduled or canceled loyalty promotions?”

Tell an agent

List promotions for loyalty program {program_id}.

Show {status} promotions in loyalty program {program_id}.

POST /v2/loyalty/programs/{program_id}/promotions Create a bonus-points promotion · Square Create Loyalty Promotion #

Ask an LLM

“How do I run a double-points promotion on my loyalty program?”

“Can buyers earn extra points on top of the base program for a limited time?”

Tell an agent

Create loyalty promotion {loyalty_promotion} on program {program_id}.

Set up a bonus-points promotion in program {program_id} using {loyalty_promotion}.

GET /v2/loyalty/programs/{program_id}/promotions/{promotion_id} Get a loyalty promotion · Square Retrieve Loyalty Promotion #

Ask an LLM

“What are the details and status of one loyalty promotion?”

“Can I check when a specific points promotion ends?”

Tell an agent

Get promotion {promotion_id} from loyalty program {program_id}.

Show me the settings of loyalty promotion {promotion_id} in program {program_id}.

POST /v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel Cancel a loyalty promotion · Square Cancel Loyalty Promotion #

Ask an LLM

“How do I end an active points promotion before its end date?”

“Can I cancel a loyalty promotion that is only scheduled?”

Tell an agent destructive · confirm first

Cancel loyalty promotion {promotion_id} in program {program_id}.

Stop promotion {promotion_id} early on loyalty program {program_id}.

POST /v2/loyalty/rewards Create a loyalty reward and lock points · Square Create Loyalty Reward #

Ask an LLM

“How do I turn a buyer's points into a reward they can use?”

“Does creating a reward lock the points for the chosen reward tier?”

Tell an agent

Create loyalty reward {reward}.

Lock points for a reward tier by creating reward {reward}.

POST /v2/loyalty/rewards/search Search loyalty rewards · Square Search Loyalty Rewards #

Ask an LLM

“Which rewards has a loyalty account issued or redeemed?”

“Can I filter loyalty rewards by status for one account?”

Tell an agent

Search loyalty rewards matching {query}.

List up to {limit} loyalty rewards across all accounts.

DELETE /v2/loyalty/rewards/{reward_id} Delete a reward and return its points · Square Delete Loyalty Reward #

Ask an LLM

“How do I undo a loyalty reward and give the points back to the buyer?”

“Does deleting a reward remove its discount from the order?”

Tell an agent destructive · confirm first

Delete loyalty reward {reward_id}.

Remove reward {reward_id} and return its points to the account.

GET /v2/loyalty/rewards/{reward_id} Get a loyalty reward · Square Retrieve Loyalty Reward #

Ask an LLM

“What state is a particular loyalty reward in?”

“Can I look up one reward by its ID to see its points?”

Tell an agent

Get loyalty reward {reward_id}.

Show me the details of reward {reward_id}.

POST /v2/loyalty/rewards/{reward_id}/redeem Redeem a loyalty reward · Square Redeem Loyalty Reward #

Ask an LLM

“How do I mark a loyalty reward as redeemed after the buyer uses it?”

“Is redeeming a reward final once it is in the redeemed state?”

Tell an agent

Redeem loyalty reward {reward_id} at location {location_id}.

Mark reward {reward_id} as used at {location_id}.

Documentation

https://developer.squareup.com/docs/payments-overview

https://developer.squareup.com/reference/square/payments-api

https://developer.squareup.com/docs/orders-api/what-it-does

https://developer.squareup.com/reference/square/orders-api

https://developer.squareup.com/docs/catalog-api/what-it-does

https://developer.squareup.com/reference/square/catalog-api

https://developer.squareup.com/docs/inventory-api/what-it-does

https://developer.squareup.com/reference/square/inventory-api

https://developer.squareup.com/docs/customers

https://developer.squareup.com/reference/square/customers-api

https://developer.squareup.com/docs/locations-api

https://developer.squareup.com/reference/square/locations-api

https://developer.squareup.com/docs/team/overview

https://developer.squareup.com/reference/square/team-api

https://developer.squareup.com/docs/labor-api/what-it-does

https://developer.squareup.com/reference/square/labor-api

https://developer.squareup.com/docs/bookings-api/what-it-is

https://developer.squareup.com/reference/square/bookings-api

https://developer.squareup.com/docs/loyalty-api/overview

https://developer.squareup.com/reference/square/loyalty-api

https://developer.squareup.com/docs/gift-cards/using-gift-cards-api

https://developer.squareup.com/reference/square/gift-cards-api

https://developer.squareup.com/docs/invoices-api/overview

https://developer.squareup.com/reference/square/invoices-api

https://developer.squareup.com/docs/subscriptions-api/overview

https://developer.squareup.com/reference/square/subscriptions-api

https://developer.squareup.com/docs/checkout-api

https://developer.squareup.com/reference/square/checkout-api

https://developer.squareup.com/docs/terminal-api/overview

https://developer.squareup.com/reference/square/terminal-api

https://developer.squareup.com/docs/payments-refunds

https://developer.squareup.com/reference/square/refunds-api

https://developer.squareup.com/docs/disputes-api/overview

https://developer.squareup.com/reference/square/disputes-api

https://developer.squareup.com/docs/merchants-api

https://developer.squareup.com/reference/square/merchants-api

https://developer.squareup.com/docs/cards-api/overview

https://developer.squareup.com/reference/square/cards-api

https://developer.squareup.com/docs/vendors-api/manage-vendors-in-apps

https://developer.squareup.com/reference/square/vendors-api

https://developer.squareup.com/docs/cashdrawershift-api/reporting

https://developer.squareup.com/reference/square/cash-drawers-api

https://developer.squareup.com/docs/bank-accounts-api

https://developer.squareup.com/reference/square/bank-accounts-api

https://developer.squareup.com/docs/payouts-api/overview

https://developer.squareup.com/reference/square/payouts-api

https://developer.squareup.com/docs/web-payments/apple-pay

https://developer.squareup.com/reference/square/apple-pay-api

https://developer.squareup.com/docs/sites-api/overview

https://developer.squareup.com/reference/square/sites-api

https://developer.squareup.com/docs/snippets-api/overview

https://developer.squareup.com/reference/square/snippets-api

https://developer.squareup.com/docs/oauth-api/overview

https://developer.squareup.com/reference/square/oauth-api

https://developer.squareup.com/docs/webhooks/overview

https://developer.squareup.com/reference/square/webhook-subscriptions-api

https://developer.squareup.com/docs/events-api/overview

https://developer.squareup.com/reference/square/events-api

https://developer.squareup.com/docs/devices-api/overview

https://developer.squareup.com/reference/square/devices-api

https://developer.squareup.com/docs/customer-groups-api/what-it-does

https://developer.squareup.com/reference/square/customer-groups-api

https://developer.squareup.com/docs/customer-segments-api/what-it-does

https://developer.squareup.com/reference/square/customer-segments-api

https://developer.squareup.com/docs/gift-cards/using-gift-card-activities-api

https://developer.squareup.com/reference/square/gift-card-activities-api

https://developer.squareup.com/docs/customer-custom-attributes-api/overview

https://developer.squareup.com/reference/square/customer-custom-attributes-api

Specifications

https://artifacts.apis.io/square/openapi/square-loyalty-api-openapi.yml

https://artifacts.apis.io/square/asyncapi/square-webhooks-asyncapi.yml

Schemas & Data

https://artifacts.apis.io/square/json-schema/square-list-loyalty-promotions-response-schema.json

https://artifacts.apis.io/square/json-schema/square-search-loyalty-rewards-response-schema.json

https://artifacts.apis.io/square/json-schema/square-search-loyalty-events-response-schema.json

https://artifacts.apis.io/square/json-schema/square-calculate-loyalty-points-request-schema.json

https://artifacts.apis.io/square/json-schema/square-list-loyalty-programs-response-schema.json

https://artifacts.apis.io/square/json-schema/square-retrieve-loyalty-program-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/square:square-loyalty-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: '2.0'
  title: Square Loyalty API
  description: Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen.
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:


# --- truncated at 32 KB (179 KB total) ---
# Full source: https://artifacts.apis.io/square/openapi/square-loyalty-api-openapi.yml