Create and Manage Customer Custom Attributes

Customer-related custom attributes are used to store properties or metadata for a customer profile. A custom attribute is based on a custom attribute definition in a Square seller account. After the definition is created, the custom attribute can be set for customer profiles in the seller's Customer Directory. For an overview of how customer-related custom attributes work, see Custom Attributes for Customers.

Customer-related custom attributes are stored as a collection for a customer profile.

.../v2/customers/{customer_id}/custom-attributes

An individual custom attribute is accessed using the customer_id and key. If the requesting application isn't the definition owner, key is a qualified key.

.../v2/customers/{customer_id}/custom-attributes/{key}

A custom attribute is represented by a CustomAttribute object. Custom attributes obtain a key identifier, visibility setting, allowed data type, and other properties from a custom attribute definition, which is represented by a CustomAttributeDefinition object.

The following is an example custom attribute:

{
  "custom_attribute": {
    "key": "favoritebook",
    "version": 1,
    "updated_at": "2022-12-08T00:07:20Z",
    "value": "Dune",
    "created_at": "2022-12-08T00:07:20Z",
    "visibility": "VISIBILITY_READ_WRITE_VALUES"
  }
}

The following fields represent core properties of a custom attribute:

When working with custom attributes owned by other applications, you must provide a qualified key for the following endpoints:

• UpsertCustomerCustomAttribute
• BulkUpsertCustomerCustomAttributes
• RetrieveCustomerCustomAttribute
• DeleteCustomerCustomAttribute

Square generates a qualified key in the format {application ID}:{key}, using the application ID of the definition owner and the key that was provided when the definition was created. Custom attributes use the same key as the corresponding definition.

The following example is a qualified key generated for a third-party application:

sq0idp-BuahoY39o1X-GPxRRUWc0A:businessEmail

The following example is a qualified key for a seller-defined custom field created in the Customer Directory. In this case, the square application ID is combined with a GUID.

square:0460be56-6783-4482-8d55-634f9ae61684

You can find keys by calling the following endpoints. Square returns qualified keys for the custom attributes and definitions that aren't owned by the requesting application:

• ListCustomerCustomAttributeDefinitions

• ListCustomerCustomAttributes - Include the with_definitions query parameter to also return the corresponding custom attribute definitions. Only custom attributes that have a value are returned.

The following data types are supported for customer-related custom attributes:

For more examples and descriptions of supported data types, see Upsert request examples for each data type.

A custom attribute's data type is specified by the schema field of the corresponding definition. You can call the following endpoints to retrieve a definition using the key:

• RetrieveCustomerCustomAttributeDefinition

• RetrieveCustomerCustomAttribute with the with_definition query parameter set to true. For more information, see Retrieve a customer custom attribute.

In the definition, the schema field specifies the data type as a URL reference to an object hosted on the Square CDN. The Selection data type provides additional information.

The following is an example String-type custom attribute definition:

{
  "custom_attribute_definition": {
    "key": "favorite-drink",
    "name": "Favorite Drink",
    "description": "The favorite drink of the customer",
    "version": 1,
    "updated_at": "2022-05-20T02:41:37Z",
    "schema": {
      "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String"
    },
    "created_at": "2022-05-20T02:41:37Z",
    "visibility": "VISIBILITY_READ_WRITE_VALUES"
  }
}

The following is an excerpt of an example Selection-type custom attribute definition:

{
  "custom_attribute_definition": {
    ...
    "schema": {
      "$schema": "https://developer-production-s.squarecdn.com/meta-schemas/v1/selection.json",
      "maxItems": 3,
      "type": "array", 
      "uniqueItems": true,
      "items": {
        "names": [
          "Option 1",
          "Option 2",
          "Option 3"
        ],
        "enum": [
          "9492bdda-ab4d-4eeb-8496-0986c8f78499",   // UUID for "Option 1"
          "6b96fba7-d8a5-ae72-48f4-8c3ee875633f",   // UUID for "Option 2"
          "4032c1a2-d749-4c75-9c30-be6472cd2e08"    // UUID for "Option 3"
        ]
      }
    },
    ...
  }
}

Note the following:

• The maxItems field represents the maximum number of allowed selections for the custom attribute value.

• The items field contains two arrays: names and enum. The options in the names field map by index to the UUIDs in the enum field. The first option maps to the first UUID, the second option maps to the second UUID, and so on.

This mapping is used to set the custom attribute value. For example, the value of the following custom attribute maps to Option 2.

{
  "custom_attribute": {
    "key": "favoritebook",
    "version": 1,
    "updated_at": "2022-08-08T00:07:20Z",
    "value": [
      "6b96fba7-d8a5-ae72-48f4-8c3ee875633f"
    ],
    "created_at": "2022-08-08T00:07:20Z",
    "visibility": "VISIBILITY_READ_WRITE_VALUES"
  }
}

To set the value of a custom attribute for a customer profile, call UpsertCustomerCustomAttribute and provide the following information:

• customer_id - The id of the Customer object that represents the target customer profile.

• key - The key of the custom attribute to create or update.

  • If the requesting application is the definition owner, use the key that was provided when the definition was created.

  • If the requesting application isn't the definition owner, use the qualified key. The visibility of the custom attribute must be VISIBILITY_READ_WRITE_VALUES. For more information, see Qualified keys.

• custom_attribute - The custom attribute with the following fields:

  • value - The value of the custom attribute, which must conform to the schema specified by the definition and cannot exceed 5 KB. For more information, see Value data types.

  • version - The current version of the custom attribute, optionally included to enable optimistic concurrency control when updating a value that was previously set for the customer profile. If the specified version is less than the current version of the custom attribute, the request fails with a CONFLICT error. If the specified version is higher than the current version, Square returns a BAD_REQUEST error.

• idempotency_key - A unique ID for the request that can be optionally included to ensure idempotency.

The following example request sets the value for a String-type custom attribute. The key in this example is favoritebook.

The following is an example response:

{
  "custom_attribute": {
    "key": "favoritebook",
    "version": 1,
    "updated_at": "2022-12-08T00:07:20Z",
    "value": "Dune",
    "created_at": "2022-12-08T00:07:20Z",
    "visibility": "VISIBILITY_READ_WRITE_VALUES"
  }
}

During upsert operations, Square validates the provided value against the schema specified by the definition.

After a custom attribute is upserted, Square invokes the customer.custom_attribute.owned.updated and customer.custom_attribute.visible.updated webhook events.

You can set a custom attribute for a customer profile by providing a value that conforms to the schema specified by the corresponding custom attribute definition. For information about getting the schema, see Getting the data type of a custom attribute.

The following sections contain UpsertCustomerCustomAttribute requests for each supported data type.

A string with up to 1000 UTF-8 characters. Empty strings are allowed.

An email address consisting of ASCII characters that matches the regular expression for the HTML5 email type.

A string representation of a phone number in E.164 format. For example, +17895551234.

An Address object. For information about Address fields, see Working with Addresses. You must provide a complete Address object in every upsert request.

A date in ISO 8601 format: YYYY-MM-DD.

A true or false value. A Toggle custom field created by sellers in the Customer Directory is a Boolean.

A string representation of an integer or decimal with up to 5 digits of precision. Negative numbers are denoted using a - prefix. The absolute value cannot exceed (2^63-1)/10^5 or 92233720368547.

A selection from a set of named options.

When working with a Selection-type custom attribute, you need to get the schema from the custom attribute definition. The schema shows the mapping between the named options and Square-assigned UUIDs and the maximum number of allowed selections.

Reading the schema

The following is an excerpt of an example Selection-type custom attribute definition:

{
  "custom_attribute_definition": {
    ...
    "schema": {
      "$schema": "https://developer-production-s.squarecdn.com/meta-schemas/v1/selection.json",
      "maxItems": 3,
      "type": "array", 
      "uniqueItems": true,
      "items": {
        "names": [
          "Option 1",
          "Option 2",
          "Option 3"
        ],
        "enum": [
          "9492bdda-ab4d-4eeb-8496-0986c8f78499",   // UUID for "Option 1"
          "6b96fba7-d8a5-ae72-48f4-8c3ee875633f",   // UUID for "Option 2"
          "4032c1a2-d749-4c75-9c30-be6472cd2e08"    // UUID for "Option 3"
        ]
      }
    },
    ...
  }
}

Note the following:

• The maxItems field represents the maximum number of allowed selections for the custom attribute value.

• The items field contains two arrays: names and enum. The options in the names field map by index to the UUIDs in the enum field. The first option maps to the first UUID, the second option maps to the second UUID, and so on.

Setting a selection value

To set a selection value for a customer profile, you provide the target UUID (that maps to the target named option) in the value field. For Selection-type custom attributes, value is an array that can contain zero or more UUIDs, up to the number specified in maxItems.

The following example request sets two selections for a custom attribute by providing two UUIDs:

The following example request sets an empty selection by providing an empty array:

To create or update one or more custom attributes for one or more customer profiles, call BulkUpsertCustomerCustomAttributes. This endpoint accepts a values map with 1 to 25 objects that each contain:

• An arbitrary ID for the individual upsert request, which corresponds to an entry in the response that has the same ID. The ID must be unique within the BulkUpsertCustomerCustomAttributes request.
• An individual upsert request with the information needed to create or update a custom attribute for a customer profile.

The following example includes two upsert requests that set two custom attributes for two customer profiles:

{
  "values": {
    "id1": {
      "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM",
      "custom_attribute": {
        "key": "favoritebook",
        "value": "Alice in Wonderland"
      },
      "idempotency_key": "{UNIQUE_KEY}"
    },
    "id2": {
      "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8",
      "custom_attribute": {
        "key": "favoritemovie",
        "value": "Brazil",
        "version": 3   // Only supported when updating an existing value
      },
      "idempotency_key": "{UNIQUE_KEY}"
    }
  }
}

During upsert operations, Square validates each provided value against the schema specified by the definition. The optional version field is only supported for update operations.

An individual upsert request contains the information needed to set the value of a custom attribute for a customer profile. Each request includes the following fields:

• customer_id - The id of the Customer object that represents the target customer profile.

• custom_attribute - The custom attribute with following fields:

  • key - The key of the custom attribute to create or update.

    • If the requesting application is the definition owner, use the key that was provided when the definition was created.

    • If the requesting application isn't the definition owner, use the qualified key. The visibility of the custom attribute must be VISIBILITY_READ_WRITE_VALUES. For more information, see Qualified keys.

  • value - The value of the custom attribute, which must conform to the schema specified by the definition and cannot exceed 5 KB. For more information, see Value data types.

  • version - The current version of the custom attribute, optionally included to enable optimistic concurrency control when updating a value that was previously set for the customer profile. If the specified version is less than the current version of the custom attribute, the request fails with a CONFLICT error. If the specified version is higher than the current version, Square returns a BAD_REQUEST error.

• idempotency_key - A unique ID for the individual request that can be optionally included to ensure idempotency.

The following example BulkUpsertCustomerCustomAttributes request includes five individual upsert requests:

The following is an example response. Note that the errors field is returned for any individual requests that fail.

{
  "values": {
    "id2": {
      "customer_id": "SY8EMWRNDN3TQDP2H4KS1QWMMM",
      "custom_attribute": {
        "key": "favoritebook",
        "version": 3,
        "updated_at": "2022-05-30T00:16:23Z",
        "value": "Through the Looking Glass",
        "created_at": "2022-05-20T20:20:35Z",
        "visibility": "VISIBILITY_READ_WRITE_VALUES"
      }
    },
    "id1": {
      "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8",
      "custom_attribute": {
        "key": "favoritebook",
        "version": 1,
        "updated_at": "2022-05-30T00:16:23Z",
        "value": "Dune",
        "created_at": "2022-05-30T00:16:23Z",
        "visibility": "VISIBILITY_READ_WRITE_VALUES"
      }
    },
    "id3": {
      "errors": [
        {
          "code": "CONFLICT",
          "detail": "Attempting to write to version 3, but current version is 4",
          "field": "version",
          "category": "INVALID_REQUEST_ERROR"
        }
      ]
    },
    "id4": {
      "customer_id": "N3NCVYY3WS27HF0HKANA3R9FP8",
      "custom_attribute": {
        "key": "square:a0f1505a-2aa1-490d-91a8-8d31ff181808",
        "version": 1,
        "updated_at": "2022-05-30T00:16:23Z",
        "value": "10.5",
        "created_at": "2021-11-08T23:14:47Z",
        "visibility": "VISIBILITY_READ_WRITE_VALUES"
      }
    },
    "id5": {
      "customer_id": "70548QG1HN43B05G0KCZ4MMC1G",
      "custom_attribute": {
        "key": "sq0ids-0evKIskIGaY45fCyNL66aw:backupemail",
        "version": 2,
        "updated_at": "2022-05-30T00:16:23Z",
        "value": "[email protected]",
        "created_at": "2022-05-29T03:51:18Z",
        "visibility": "VISIBILITY_READ_WRITE_VALUES"
      }
    }
  }
}

Individual upsert requests aren't guaranteed to be returned in the same order. Each upsert response has the same ID as the corresponding upsert request, so you can use the ID to map individual requests and responses.

After each custom attribute is upserted, Square invokes the customer.custom_attribute.owned.updated and customer.custom_attribute.visible.updated webhook events.

To list the custom attributes that are set for a customer profile, call ListCustomerCustomAttributes and provide the following information:

• customer_id - The id of the Customer object that represents the target customer profile.

• with_definitions - Indicates whether to return the custom attribute definition in the definition field of each custom attribute. Set this parameter to true to get the name and description of each custom attribute, information about the data type, or other definition details. The default value is false.

• limit - The maximum page size of 1 to 100 results to return in the response. The default value is 20.

  If the results are paged, the cursor field in the response contains a value that you can send with the cursor query parameter to get the next page of results.

The following example request includes the limit query parameter:

When all pages are retrieved, the results include:

• All custom attributes owned by the requesting application that have a value. The key for these custom attributes is the key that was provided for the definition.

• All custom attributes owned by other applications that have a value and a visibility setting of VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES. The key for these custom attributes is a qualified key. For more information, see Qualified keys.

  A custom attribute is owned by the application that created the corresponding definition.

The following is an example response:

{
  "custom_attributes": [
    {
      "key": "entity-id",
      "version": 1,
      "updated_at": "2022-05-30T09:44:42Z",
      "value": "mbj_004508",
      "created_at": "2022-05-30T09:44:42Z",
      "visibility": "VISIBILITY_HIDDEN"
    },
    {
      "key": "favoritebook",
      "version": 3,
      "updated_at": "2022-05-30T00:16:23Z",
      "value": "Through the Looking Glass",
      "created_at": "2022-05-20T20:20:35Z",
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    },
    {
      "key": "sq0idp-BuahoY39o1X-GPxRRUWc0A:businessAddress",
      "version": 2,
      "updated_at": "2022-05-31T17:40:28Z",
      "value": {
        "address_line_1": "1455 Market Street",
        "postal_code": "94103",
        "country": "US",
        "administrative_district_level_1": "California",
        "locality": "San Francisco"
      },
      "created_at": "2022-05-26T17:08:57Z",
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    },
    {
      "key": "square:a0f1505a-2aa1-490d-91a8-8d31ff181808",
      "version": 4,
      "updated_at": "2022-05-16T00:16:23Z",
      "value": "10.5",
      "created_at": "2021-11-08T23:14:47Z",
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    }
  ],
  "cursor": "O5tF0DmcskdGTrPOAPjlIL...BxACXlOQYbdKq0RC4LZ"
}

The following example request includes the with_definitions query parameter set to true:

The following is an excerpt of an example response that shows the custom attribute definition in the definition field:

{
  "custom_attributes": [
    {
      "key": "entity-id",
      "version": 1,
        "definition": {
          "key": "entity-id",
          "name": "Entity ID",
          "version": 1,
          "updated_at": "2022-05-13T23:23:30Z",
          "schema": {
            "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.String"
          },
          "created_at": "2022-05-13T23:23:30Z",
          "visibility": "VISIBILITY_HIDDEN"
      },
      "updated_at": "2022-05-30T09:44:42Z",
      "value": "mbj_004508",
      "created_at": "2022-05-30T09:44:42Z",
      "visibility": "VISIBILITY_HIDDEN"
    },
    ...
  ]
}

If no custom attributes are found, Square returns an empty object.

{}

To retrieve a custom attribute from a customer profile, call RetrieveCustomerCustomAttribute and provide the following information:

• customer_id - The id of the Customer object that represents the target customer profile.

• key - The key of the custom attribute to retrieve.

  • If the requesting application is the definition owner, use the key that was provided when the definition was created.

  • If the requesting application isn't the definition owner, use the qualified key. The visibility of the custom attribute must be VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES. For more information, see Qualified keys.

• with_definition - Indicates whether to return the custom attribute definition in the definition field of the custom attribute. Set this parameter to true to get the name and description of the custom attribute, information about the data type, or other definition details. The default value is false.

• version - The current version of the custom attribute, optionally included 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 400 BAD_REQUEST error.

The following is an example request:

The following is an example response for an Address-type custom attribute. The value field contains the value of the custom attribute.

{
  "custom_attribute": {
    "key": "sq0idp-BuahoY39o1X-GPxRRUWc0A:businessAddress",
    "version": 1,
    "updated_at": "2022-05-26T17:08:57Z",
    "value": {
      "address_line_1": "43 Main Street",
      "address_line_2": "The Liberties",
      "locality": "Dublin 20",
      "administrative_district_level_1": "Co. Dublin",
      "postal_code": "D08XK58",
      "country": "IE"
    },
    "created_at": "2022-05-26T17:08:57Z",
    "visibility": "VISIBILITY_READ_WRITE_VALUES"
  }
}

The following example request includes the with_definition query parameter:

The following example response shows the custom attribute definition in the definition field. This example defines a Selection-type custom attribute. The mapping information in the schema.items field is used to determine the custom attribute value.

The names field contains the named options and the enum field contains the corresponding Square-assigned UUIDs. The named options map by index to the UUIDs. The first option maps to the first UUID, the second option maps to the second UUID, and so on. Therefore, the UUID in the value field of this custom attribute maps to the Small option.

{
  "custom_attribute": {
    "key": "shirt-size",
    "version": 1,
    "definition": {
      "key": "shirt-size",
      "name": "Default shirt size",
      "description": "The default shirt size ordered by the customer.",
      "version": 1,
      "updated_at": "2022-05-20T00:27:17Z",
      "schema": {
        "$schema": "https://developer-production-s.squarecdn.com/meta-schemas/v1/selection.json",
        "maxItems": 1,
        "type": "array",
        "uniqueItems": true,
        "items": {
          "names": [
            "Small",
            "Medium",
            "Large"
          ],
          "enum": [
            "1a052285-7224-4d25-9232-69f941bb0612",
            "4034d1bb-ff6c-4f7f-9108-a01625e8aadd",
            "fb27f80b-24e1-463b-9aa1-d32fcec6b22a"
          ]
        }
      },
      "created_at": "2022-05-20T00:27:17Z",
      "visibility": "VISIBILITY_READ_WRITE_VALUES"
    },
    "updated_at": "2022-05-26T16:19:07Z",
    "value": [
      "1a052285-7224-4d25-9232-69f941bb0612"
    ],
    "created_at": "2022-05-26T16:19:07Z",
    "visibility": "VISIBILITY_READ_WRITE_VALUES"
  }
}

If the custom attribute isn't set for the specified customer profile, Square returns the following response:

{
  "errors": [
    {
      "code": "NOT_FOUND",
      "detail": "The requested Value `{key}` is not found",
      "category": "INVALID_REQUEST_ERROR"
    }
  ]
}

If the custom attribute isn't available for customer profiles in the directory, Square returns the following response:

{
  "errors": [ 
    {
      "code": "BAD_REQUEST",
      "detail": "No matching definition found for value",
      "field": "key",
      "category": "INVALID_REQUEST_ERROR"
    }
  ]
}

To delete a custom attribute from a customer profile, call DeleteCustomerCustomAttribute and provide the following information:

• customer_id - The id of the Customer object that represents the target customer profile.

• key - The key of the custom attribute to delete.

  • If the requesting application is the definition owner, use the key that was provided when the definition was created.

  • If the requesting application isn't the definition owner, use the qualified key. The visibility of the custom attribute must be VISIBILITY_READ_WRITE_VALUES. For more information, see Qualified keys.

The following is an example request:

If the operation is successful, Square returns an empty object:

{}

After a custom attribute is deleted, Square invokes the customer.custom_attribute.owned.deleted and customer.custom_attribute.visible.deleted webhook events.

• Custom Attributes for Customers
• Create and Manage Customer Custom Attribute Definitions
• Custom Attributes Overview
• API Reference: Customer Custom Attributes API