<- Merchant Custom Attributes API

Merchant Custom Attributes API

Create merchant custom attribute definitionBeta



Use this endpoint to define a custom attribute that can be associated with a merchant connecting to your application. A custom attribute definition specifies the key, visibility, schema, and other properties for a custom attribute. After the definition is created, you can call UpsertMerchantCustomAttribute or BulkUpsertMerchantCustomAttributes to set the custom attribute for a merchant.

Link to section

Request body

Example code

Link to section



The custom attribute definition to create. Note the following:

  • With the exception of the Selection data type, the schema is specified as a simple URL to the JSON schema definition hosted on the Square CDN. For more information, including supported values and constraints, see Supported data types.
  • name is required unless visibility is set to VISIBILITY_HIDDEN.
Link to section



A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

Link to section

Response fields

Link to section


The new custom attribute definition.

Link to section


Any errors that occurred during the request.