Square

Square MerchantCustomAttributes API

The MerchantCustomAttributes API from Square — 6 operation(s) for merchantcustomattributes.

GitHub OpenAPI

Operations 11

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

GET /v2/merchants/custom-attribute-definitions List merchant custom attribute definitions · Square List Merchant Custom Attribute Definitions #
Ask an LLM
“What custom fields have been defined for my seller account?”
“Can I list only merchant attribute definitions that are read-write visible?”
Tell an agent
List merchant custom attribute definitions.
List merchant attribute definitions with visibility {visibility_filter}.
POST /v2/merchants/custom-attribute-definitions Define a new merchant custom attribute · Square Create Merchant Custom Attribute Definition #
Ask an LLM
“How do I define a new custom field that can be stored on the merchant?”
“Can I control who can see a new merchant-level custom attribute?”
Tell an agent
Create merchant custom attribute definition {custom_attribute_definition}.
Define a new merchant-level attribute using {custom_attribute_definition}.
DELETE /v2/merchants/custom-attribute-definitions/{key} Delete a merchant custom attribute definition · Square Delete Merchant Custom Attribute Definition #
Ask an LLM
“Does deleting a merchant attribute definition also remove its stored values?”
“How do I retire a merchant-level custom field entirely?”
Tell an agent destructive · confirm first
Delete merchant custom attribute definition {key}.
Remove merchant attribute definition {key} and all its values.
GET /v2/merchants/custom-attribute-definitions/{key} Get a merchant custom attribute definition · Square Retrieve Merchant Custom Attribute Definition #
Ask an LLM
“What schema and visibility does a merchant custom attribute definition have?”
“Can I fetch a specific version of a merchant attribute definition?”
Tell an agent
Get merchant custom attribute definition {key}.
Show merchant attribute definition {key} at version {version}.
PUT /v2/merchants/custom-attribute-definitions/{key} Update a merchant custom attribute definition · Square Update Merchant Custom Attribute Definition #
Ask an LLM
“Can I rename or change the visibility of a merchant attribute definition?”
“Which fields on a merchant custom attribute definition are editable?”
Tell an agent
Update merchant custom attribute definition {key} with {custom_attribute_definition}.
Change the description of merchant attribute definition {key} per {custom_attribute_definition}.
POST /v2/merchants/custom-attributes/bulk-delete Delete many merchant custom attributes · Square Bulk Delete Merchant Custom Attributes #
Ask an LLM
“Can I clear several merchant custom attribute values in one call?”
“What visibility is needed to delete a merchant attribute another app owns?”
Tell an agent destructive · confirm first
Bulk delete merchant custom attributes {values}.
Clear all the merchant attribute values listed in {values}.
POST /v2/merchants/custom-attributes/bulk-upsert Set many merchant custom attributes · Square Bulk Upsert Merchant Custom Attributes #
Ask an LLM
“Can I set several custom attribute values on merchants at once?”
“Is there a bulk way to write merchant-level custom fields?”
Tell an agent
Bulk upsert merchant custom attributes {values}.
Write all the merchant attribute values in {values} in one request.
GET /v2/merchants/{merchant_id}/custom-attributes List a merchant's custom attributes · Square List Merchant Custom Attributes #
Ask an LLM
“What custom attribute values are stored on a merchant?”
“Can I get the definitions along with a merchant's attribute values?”
Tell an agent
List custom attributes for merchant {merchant_id}.
List merchant {merchant_id}'s custom attributes with definitions {with_definitions}.
DELETE /v2/merchants/{merchant_id}/custom-attributes/{key} Delete one merchant custom attribute · Square Delete Merchant Custom Attribute #
Ask an LLM
“Can I remove a single custom attribute value from a merchant?”
“Why would deleting a merchant attribute owned by another app fail?”
Tell an agent destructive · confirm first
Delete custom attribute {key} from merchant {merchant_id}.
Clear merchant {merchant_id}'s value for attribute {key}.
GET /v2/merchants/{merchant_id}/custom-attributes/{key} Get one merchant custom attribute · Square Retrieve Merchant Custom Attribute #
Ask an LLM
“What value does a specific custom attribute hold for a merchant?”
“Can I read one merchant attribute together with its definition?”
Tell an agent
Get custom attribute {key} for merchant {merchant_id}.
Read merchant {merchant_id}'s value for attribute {key}.
POST /v2/merchants/{merchant_id}/custom-attributes/{key} Set one merchant custom attribute · Square Upsert Merchant Custom Attribute #
Ask an LLM
“How do I set a single custom attribute value on a merchant?”
“Does writing a merchant attribute overwrite an existing value?”
Tell an agent
Set attribute {key} on merchant {merchant_id} to {custom_attribute}.
Upsert merchant {merchant_id}'s custom attribute {key} with {custom_attribute}.

Documentation

📖
Documentation
https://developer.squareup.com/docs/payments-overview
📖
APIReference
https://developer.squareup.com/reference/square/payments-api
📖
Documentation
https://developer.squareup.com/docs/orders-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/orders-api
📖
Documentation
https://developer.squareup.com/docs/catalog-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/catalog-api
📖
Documentation
https://developer.squareup.com/docs/inventory-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/inventory-api
📖
Documentation
https://developer.squareup.com/docs/customers
📖
APIReference
https://developer.squareup.com/reference/square/customers-api
📖
Documentation
https://developer.squareup.com/docs/locations-api
📖
APIReference
https://developer.squareup.com/reference/square/locations-api
📖
Documentation
https://developer.squareup.com/docs/team/overview
📖
APIReference
https://developer.squareup.com/reference/square/team-api
📖
Documentation
https://developer.squareup.com/docs/labor-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/labor-api
📖
Documentation
https://developer.squareup.com/docs/bookings-api/what-it-is
📖
APIReference
https://developer.squareup.com/reference/square/bookings-api
📖
Documentation
https://developer.squareup.com/docs/loyalty-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/loyalty-api
📖
Documentation
https://developer.squareup.com/docs/gift-cards/using-gift-cards-api
📖
APIReference
https://developer.squareup.com/reference/square/gift-cards-api
📖
Documentation
https://developer.squareup.com/docs/invoices-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/invoices-api
📖
Documentation
https://developer.squareup.com/docs/subscriptions-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/subscriptions-api
📖
Documentation
https://developer.squareup.com/docs/checkout-api
📖
APIReference
https://developer.squareup.com/reference/square/checkout-api
📖
Documentation
https://developer.squareup.com/docs/terminal-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/terminal-api
📖
Documentation
https://developer.squareup.com/docs/payments-refunds
📖
APIReference
https://developer.squareup.com/reference/square/refunds-api
📖
Documentation
https://developer.squareup.com/docs/disputes-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/disputes-api
📖
Documentation
https://developer.squareup.com/docs/merchants-api
📖
APIReference
https://developer.squareup.com/reference/square/merchants-api
📖
Documentation
https://developer.squareup.com/docs/cards-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/cards-api
📖
Documentation
https://developer.squareup.com/docs/vendors-api/manage-vendors-in-apps
📖
APIReference
https://developer.squareup.com/reference/square/vendors-api
📖
Documentation
https://developer.squareup.com/docs/cashdrawershift-api/reporting
📖
APIReference
https://developer.squareup.com/reference/square/cash-drawers-api
📖
Documentation
https://developer.squareup.com/docs/bank-accounts-api
📖
APIReference
https://developer.squareup.com/reference/square/bank-accounts-api
📖
Documentation
https://developer.squareup.com/docs/payouts-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/payouts-api
📖
Documentation
https://developer.squareup.com/docs/web-payments/apple-pay
📖
APIReference
https://developer.squareup.com/reference/square/apple-pay-api
📖
Documentation
https://developer.squareup.com/docs/sites-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/sites-api
📖
Documentation
https://developer.squareup.com/docs/snippets-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/snippets-api
📖
Documentation
https://developer.squareup.com/docs/oauth-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/oauth-api
📖
Documentation
https://developer.squareup.com/docs/webhooks/overview
📖
APIReference
https://developer.squareup.com/reference/square/webhook-subscriptions-api
📖
Documentation
https://developer.squareup.com/docs/events-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/events-api
📖
Documentation
https://developer.squareup.com/docs/devices-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/devices-api
📖
Documentation
https://developer.squareup.com/docs/customer-groups-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/customer-groups-api
📖
Documentation
https://developer.squareup.com/docs/customer-segments-api/what-it-does
📖
APIReference
https://developer.squareup.com/reference/square/customer-segments-api
📖
Documentation
https://developer.squareup.com/docs/gift-cards/using-gift-card-activities-api
📖
APIReference
https://developer.squareup.com/reference/square/gift-card-activities-api
📖
Documentation
https://developer.squareup.com/docs/customer-custom-attributes-api/overview
📖
APIReference
https://developer.squareup.com/reference/square/customer-custom-attributes-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-merchantcustomattributes-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/asyncapi/square-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-list-merchant-custom-attribute-definitions-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-update-merchant-custom-attribute-definition-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-list-merchant-custom-attributes-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-create-merchant-custom-attribute-definition-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-upsert-merchant-custom-attribute-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-bulk-upsert-merchant-custom-attributes-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-merchantcustomattributes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

square-merchantcustomattributes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: '2.0'
  title: Square Merchant Custom Attributes 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 (102 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-merchantcustomattributes-api-openapi.yml