How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Square

Square MerchantCustomAttributes API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Square MerchantCustomAttributes API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include MerchantCustomAttributes. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 11 operations across 6 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://connect.squareup.com.

11 operations 6 paths 27 schemas 2 DELETE4 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Server
https://connect.squareup.com
Authentication
OAuth 2.0, API Key
Contact
Square Developer Platform
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Square MerchantCustomAttributes API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes. An API key is passed in the header as Authorization (oauth2ClientSecret).

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 2 DELETE, 4 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

MerchantCustomAttributes 11
GET
/v2/merchants/custom-attribute-definitions
Square List Merchant Custom Attribute Definitions
ListMerchantCustomAttributeDefinitions 3 params → 200
POST
/v2/merchants/custom-attribute-definitions
Square Create Merchant Custom Attribute Definition
CreateMerchantCustomAttributeDefinition body → 200
DELETE
/v2/merchants/custom-attribute-definitions/{key}
Square Delete Merchant Custom Attribute Definition
DeleteMerchantCustomAttributeDefinition 1 param → 200
GET
/v2/merchants/custom-attribute-definitions/{key}
Square Retrieve Merchant Custom Attribute Definition
RetrieveMerchantCustomAttributeDefinition 2 params → 200
PUT
/v2/merchants/custom-attribute-definitions/{key}
Square Update Merchant Custom Attribute Definition
UpdateMerchantCustomAttributeDefinition 1 param body → 200
POST
/v2/merchants/custom-attributes/bulk-delete
Square Bulk Delete Merchant Custom Attributes
BulkDeleteMerchantCustomAttributes body → 200
POST
/v2/merchants/custom-attributes/bulk-upsert
Square Bulk Upsert Merchant Custom Attributes
BulkUpsertMerchantCustomAttributes body → 200
GET
/v2/merchants/{merchant_id}/custom-attributes
Square List Merchant Custom Attributes
ListMerchantCustomAttributes 5 params → 200
DELETE
/v2/merchants/{merchant_id}/custom-attributes/{key}
Square Delete Merchant Custom Attribute
DeleteMerchantCustomAttribute 2 params → 200
GET
/v2/merchants/{merchant_id}/custom-attributes/{key}
Square Retrieve Merchant Custom Attribute
RetrieveMerchantCustomAttribute 4 params → 200
POST
/v2/merchants/{merchant_id}/custom-attributes/{key}
Square Upsert Merchant Custom Attribute
UpsertMerchantCustomAttribute 2 params body → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are CustomAttributeDefinition (8 properties), CustomAttribute (7 properties), Error (4 properties), ListMerchantCustomAttributesResponse (3 properties). Each schema is shown below with its type and property counts.

RetrieveMerchantCustomAttributeResponse
object
Represents a [RetrieveMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttribute) response. Either customattributedefinitio…
2 properties
CustomAttributeDefinition
object
Represents a definition for custom attribute values. A custom attribute definition specifies the key, visibility, schema, and other properties for a custom att…
8 properties
UpdateMerchantCustomAttributeDefinitionRequest
object
Represents an [UpdateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-UpdateMerchantCustomAttributeDefinition) request.
2 properties 1 required
CustomAttribute
object
A custom attribute value. Each custom attribute value has a corresponding CustomAttributeDefinition object.
7 properties
CustomAttributeDefinitionVisibility
string
The level of permission that a seller or other applications requires to view this custom attribute definition. The Visibility field controls who can read and w…
DeleteMerchantCustomAttributeDefinitionResponse
object
Represents a response from a delete request containing error messages if there are any.
1 property
BulkDeleteMerchantCustomAttributesResponseMerchantCustomAttributeDeleteResponse
object
Represents an individual delete response in a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) re…
1 property
DeleteMerchantCustomAttributeResponse
object
Represents a [DeleteMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-DeleteMerchantCustomAttribute) response. Either an empty object {} (for a su…
1 property
ListMerchantCustomAttributesResponse
object
Represents a [ListMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-ListMerchantCustomAttributes) response. Either customattributes, an empty obj…
3 properties
BulkUpsertMerchantCustomAttributesResponseMerchantCustomAttributeUpsertResponse
object
Represents a response for an individual upsert request in a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustom…
3 properties
BulkDeleteMerchantCustomAttributesRequestMerchantCustomAttributeDeleteRequest
object
Represents an individual delete request in a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) req…
1 property
CreateMerchantCustomAttributeDefinitionResponse
object
Represents a [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) response. Either customat…
2 properties
CreateMerchantCustomAttributeDefinitionRequest
object
Represents a [CreateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-CreateMerchantCustomAttributeDefinition) request.
2 properties 1 required
VisibilityFilter
string
Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions.
UpsertMerchantCustomAttributeResponse
object
Represents an [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) response. Either customattributedefinition o…
2 properties
ListMerchantCustomAttributeDefinitionsResponse
object
Represents a [ListMerchantCustomAttributeDefinitions](api-endpoint:MerchantCustomAttributes-ListMerchantCustomAttributeDefinitions) response. Either customattr…
3 properties
BulkUpsertMerchantCustomAttributesRequest
object
Represents a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) request.
1 property 1 required
BulkUpsertMerchantCustomAttributesResponse
object
Represents a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) response, which contains a map of r…
2 properties
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties 2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
BulkDeleteMerchantCustomAttributesResponse
object
Represents a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) response, which contains a map of r…
2 properties 1 required
UpsertMerchantCustomAttributeRequest
object
Represents an [UpsertMerchantCustomAttribute](api-endpoint:MerchantCustomAttributes-UpsertMerchantCustomAttribute) request.
2 properties 1 required
BulkUpsertMerchantCustomAttributesRequestMerchantCustomAttributeUpsertRequest
object
Represents an individual upsert request in a [BulkUpsertMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkUpsertMerchantCustomAttributes) req…
3 properties 2 required
BulkDeleteMerchantCustomAttributesRequest
object
Represents a [BulkDeleteMerchantCustomAttributes](api-endpoint:MerchantCustomAttributes-BulkDeleteMerchantCustomAttributes) request.
1 property 1 required
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
UpdateMerchantCustomAttributeDefinitionResponse
object
Represents an [UpdateMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-UpdateMerchantCustomAttributeDefinition) response. Either customa…
2 properties
RetrieveMerchantCustomAttributeDefinitionResponse
object
Represents a [RetrieveMerchantCustomAttributeDefinition](api-endpoint:MerchantCustomAttributes-RetrieveMerchantCustomAttributeDefinition) response. Either cust…
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-merchantcustomattributes-api-openapi.yml Raw ↑

Other APIs Square publishes across the network.

Square Reporting API
AE Profile APIs.io
Square Channels API
AE Profile APIs.io
Square Transfer Orders API
AE Profile APIs.io
Square ApplePay API
AE Profile APIs.io
Square BankAccounts API
AE Profile APIs.io
Square BookingCustomAttributes API
AE Profile APIs.io
Square Bookings API
AE Profile APIs.io
Square Cards API
AE Profile APIs.io
Square CashDrawers API
AE Profile APIs.io
Square Catalog API
AE Profile APIs.io
Square Checkout API
AE Profile APIs.io
Square CustomerCustomAttributes API
AE Profile APIs.io
#MerchantCustomAttributes
← Back to S APIs
API Details
ID
square:square-merchantcustomattributes-api
Server
https://connect.squareup.com
Docs
https://developer.squareup.com/docs/payments-overview
Provider
Square
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=square-merchantcustomattributes-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/square-merchantcustomattributes-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Square MerchantCustomAttributes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.