Development
  • Guides
  • API Reference
  • API Explorer
  • SDKs
  • Sample apps
  • System status
Support
  • Developer forums
  • Developer blog
  • YouTube
  • X
More
  • Square Home
  • Square Developer
  • App Marketplace
  • Partner with Square
  • Solutions Partner Program
  • Pricing
  • Sales

© 2026 Square, Inc.

  • Developer terms of service
  • Developer Integration and Marketing Agreement
  • Privacy policy
  • Partnerships
  • Sign In
  • Sign In

    Merchant Custom Attributes

  • List merchant custom attribute definitions

  • Create merchant custom attribute definition

  • Delete merchant custom attribute definition

  • Retrieve merchant custom attribute definition

  • Update merchant custom attribute definition

  • Bulk delete merchant custom attributes

  • Bulk upsert merchant custom attributes

  • List merchant custom attributes

  • Delete merchant custom attribute

  • Retrieve merchant custom attribute

  • Upsert merchant custom attribute

  • Webhooks

  • merchant.custom_attribute_definition.owned.created

  • merchant.custom_attribute_definition.owned.deleted

  • merchant.custom_attribute_definition.owned.updated

  • merchant.custom_attribute_definition.visible.created

  • merchant.custom_attribute_definition.visible.deleted

  • merchant.custom_attribute_definition.visible.updated

  • merchant.custom_attribute.owned.deleted

  • merchant.custom_attribute.owned.updated

  • merchant.custom_attribute.visible.deleted

  • merchant.custom_attribute.visible.updated

<- Merchant Custom Attributes webhooks

Merchant Custom Attributes webhooks

All versions ->

merchant custom_attribute_definition owned updatedBeta

EVENT

 merchant.custom_attribute_definition.owned.updated

Published when a merchant custom attribute definition is updated by the subscribing application. Subscribe to this event to be notified when your application updates a merchant custom attribute definition.

Permissions:MERCHANT_PROFILE_READ
Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of the seller associated with the event that triggered the event notification.

Link to section

type

string

The type of this event. The value is "merchant.custom_attribute_definition.owned.updated".

Link to section

event_id

string

A unique ID for the event notification.

Link to section

created_at

string

Read only The timestamp that indicates when the event notification was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

data

The data associated with the event that triggered the event notification.

Link to section

Examples

All versions ->

Response JSON

{ "merchant_id": "DM7VKY8Q63GNP", "type": "merchant.custom_attribute_definition.owned.updated", "event_id": "d914e6ef-9e37-4bca-a663-ecc55f5d98d3", "created_at": "2022-01-26T01:22:29Z", "data": { "type": "custom_attribute_definition", "id": "sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:has_seen_tutorial", "object": { "created_at": "2022-1-26T21:57:39Z", "description": "Has seen the merchant seen the tutorial screen for using the app?", "key": "sq0idp-LJ1Kr4Iim0hGDvAwrv8HIB:has_seen_tutorial", "name": "Seen tutorial screen", "schema": { "$ref": "https://developer-production-s.squarecdn.com/schemas/v1/common.json#squareup.common.Boolean" }, "updated_at": "2022-01-26T01:22:29Z", "version": 2, "visibility": "VISIBILITY_HIDDEN" } } }