RetrieveMerchantCustomAttributeDefinition
Retrieves a merchant-related custom attribute definition from a Square seller account. To retrieve a custom attribute definition created by another application, the visibility setting must be VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.
Path parameters
The key of the custom attribute definition to retrieve. If the requesting application is not the definition owner, you must use the qualified key.
Query parameters
The current version of the custom attribute definition, which is used for strongly consistent reads to guarantee that you receive the most up-to-date data. When included in the request, Square returns the specified version or a higher version if one exists. If the specified version is higher than the current version, Square returns a BAD_REQUEST error.
Response
Success
Example response
{
"custom_attribute_definition": {
"created_at": "2023-05-05T19:06:36.559Z",
"description": "This is the other name this merchant goes by.",
"key": "alternative_seller_name",
"name": "Alternative Merchant Name",
"schema": {
"$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String"
},
"updated_at": "2023-05-05T19:06:36.559Z",
"version": 1,
"visibility": "VISIBILITY_READ_ONLY"
}
}