CreatePaymentLinkResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/square/main/json-schema/square-create-payment-link-response-schema.json",
  "title": "CreatePaymentLinkResponse",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/square-checkout-api-openapi.yml#/components/schemas/CreatePaymentLinkResponse",
  "type": "object",
  "x-release-status": "PUBLIC",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Error"
      },
      "description": "Any errors that occurred during the request."
    },
    "payment_link": {
      "$ref": "#/$defs/PaymentLink",
      "description": "The created payment link."
    },
    "related_resources": {
      "$ref": "#/$defs/PaymentLinkRelatedResources",
      "description": "The list of related objects."
    }
  },
  "$defs": {
    "AcceptedPaymentMethods": {
      "type": "object",
      "x-release-status": "PUBLIC",
      "properties": {
        "apple_pay": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Whether Apple Pay is accepted at checkout."
        },
        "google_pay": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Whether Google Pay is accepted at checkout."
        },
        "cash_app_pay": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Whether Cash App Pay is accepted at checkout."
        },
        "afterpay_clearpay": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Whether Afterpay/Clearpay is accepted at checkout."
        }
      }
    },
    "AdditionalRecipient": {
      "type": "object",
      "description": "Represents an additional recipient (other than the merchant) receiving a portion of this tender.",
      "x-release-status": "DEPRECATED",
      "required": [
        "location_id",
        "amount_money"
      ],
      "properties": {
        "location_id": {
          "type": "string",
          "description": "The location ID for a recipient (other than the merchant) receiving a portion of this tender.",
          "minLength": 1,
          "maxLength": 50
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "The description of the additional recipient.",
          "maxLength": 100
        },
        "amount_money": {
          "$ref": "#/$defs/Money",
          "description": "The amount of money distributed to the recipient."
        },
        "receivable_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The unique ID for the RETIRED `AdditionalRecipientReceivable` object. This field should be empty for any `AdditionalRecipient` objects created after the retirement.",
          "maxLength": 192
        }
      }
    },
    "Address": {
      "type": "object",
      "description": "Represents a postal address in a country. \nFor more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses).",
      "x-release-status": "PUBLIC",
      "properties": {
        "address_line_1": {
          "type": [
            "string",
            "null"
          ],
          "description": "The first line of the address.\n\nFields that start with `address_line` provide the address's most specific\ndetails, like street number, street name, and building name. They do *not*\nprovide less specific details like city, state/province, or country (these\ndetails are provided in other fields)."
        },
        "address_line_2": {
          "type": [
            "string",
            "null"
          ],
          "description": "The second line of the address, if any."
        },
        "address_line_3": {
          "type": [
            "string",
            "null"
          ],
          "description": "The third line of the address, if any."
        },
        "locality": {
          "type": [
            "string",
            "null"
          ],
          "description": "The city or town of the address. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)."
        },
        "sublocality": {
          "type": [
            "string",
            "null"
          ],
          "description": "A civil region within the address's `locality`, if any."
        },
        "sublocality_2": {
          "type": [
            "string",
            "null"
          ],
          "description": "A civil region within the address's `sublocality`, if any."
        },
        "sublocality_3": {
          "type": [
            "string",
            "null"
          ],
          "description": "A civil region within the address's `sublocality_2`, if any."
        },
        "administrative_district_level_1": {
          "type": [
            "string",
            "null"
          ],
          "description": "A civil entity within the address's country. In the US, this\nis the state. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)."
        },
        "administrative_district_level_2": {
          "type": [
            "string",
            "null"
          ],
          "description": "A civil entity within the address's `administrative_district_level_1`.\nIn the US, this is the county."
        },
        "administrative_district_level_3": {
          "type": [
            "string",
            "null"
          ],
          "description": "A civil entity within the address's `administrative_district_level_2`,\nif any."
        },
        "postal_code": {
          "type": [
            "string",
            "null"
          ],
          "description": "The address's postal code. For a full list of field meanings by country, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses)."
        },
        "country": {
          "$ref": "#/$defs/Country",
          "description": "The address's country, in the two-letter format of ISO 3166. For example, `US` or `FR`.\nSee [Country](#type-country) for possible values"
        },
        "first_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Optional first name when it's representing recipient."
        },
        "last_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Optional last name when it's representing recipient."
        }
      }
    },
    "Card": {
      "type": "object",
      "description": "Represents the payment details of a card to be used for payments. These\ndetails are determined by the payment token generated by Web Payments SDK.",
      "x-release-status": "PUBLIC",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique ID for this card. Generated by Square.",
          "maxLength": 64,
          "readOnly": true
        },
        "card_brand": {
          "$ref": "#/$defs/CardBrand",
          "description": "The card's brand.\nSee [CardBrand](#type-cardbrand) for possible values",
          "readOnly": true
        },
        "last_4": {
          "type": "string",
          "description": "The last 4 digits of the card number.",
          "maxLength": 4,
          "readOnly": true
        },
        "exp_month": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The expiration month of the associated card as an integer between 1 and 12.",
          "format": "int64"
        },
        "exp_year": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The four-digit year of the card's expiration date.",
          "format": "int64"
        },
        "cardholder_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the cardholder.",
          "maxLength": 96
        },
        "billing_address": {
          "$ref": "#/$defs/Address",
          "description": "The billing address for this card."
        },
        "fingerprint": {
          "type": "string",
          "description": "Intended as a Square-assigned identifier, based\non the card number, to identify the card across multiple locations within a\nsingle application.",
          "maxLength": 255,
          "readOnly": true
        },
        "customer_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "**Required** The ID of a customer created using the Customers API to be associated with the card."
        },
        "merchant_id": {
          "type": "string",
          "description": "The ID of the merchant associated with the card.",
          "readOnly": true
        },
        "reference_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "An optional user-defined reference ID that associates this card with\nanother entity in an external system. For example, a customer ID from an\nexternal customer management system.",
          "maxLength": 128
        },
        "enabled": {
          "type": "boolean",
          "description": "Indicates whether or not a card can be used for payments.",
          "readOnly": true
        },
        "card_type": {
          "$ref": "#/$defs/CardType",
          "description": "The type of the card.\nThe Card object includes this field only in response to Payments API calls.\nSee [CardType](#type-cardtype) for possible values",
          "readOnly": true
        },
        "prepaid_type": {
          "$ref": "#/$defs/CardPrepaidType",
          "description": "Indicates whether the Card is prepaid or not.\nThe Card object includes this field only in response to Payments API calls.\nSee [CardPrepaidType](#type-cardprepaidtype) for possible values",
          "readOnly": true
        },
        "bin": {
          "type": "string",
          "description": "The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API\nreturns this field.",
          "maxLength": 6,
          "readOnly": true
        },
        "version": {
          "type": "integer",
          "description": "Current version number of the card. Increments with each card update. Requests to update an\nexisting Card object will be rejected unless the version in the request matches the current\nversion for the Card.",
          "format": "int64"
        },
        "card_co_brand": {
          "$ref": "#/$defs/CardCoBrand",
          "description": "The card's co-brand if available. For example, an Afterpay virtual card would have a\nco-brand of AFTERPAY.\nSee [CardCoBrand](#type-cardcobrand) for possible values",
          "readOnly": true
        }
      }
    },
    "CardBrand": {
      "type": "string",
      "enum": [
        "OTHER_BRAND",
        "VISA",
        "MASTERCARD",
        "AMERICAN_EXPRESS",
        "DISCOVER",
        "DISCOVER_DINERS",
        "JCB",
        "CHINA_UNIONPAY",
        "SQUARE_GIFT_CARD",
        "SQUARE_CAPITAL_CARD",
        "INTERAC",
        "EFTPOS",
        "FELICA",
        "EBT"
      ],
      "x-enum-elements": [
        {
          "name": "OTHER_BRAND",
          "description": ""
        },
        {
          "name": "VISA",
          "description": ""
        },
        {
          "name": "MASTERCARD",
          "description": ""
        },
        {
          "name": "AMERICAN_EXPRESS",
          "description": ""
        },
        {
          "name": "DISCOVER",
          "description": ""
        },
        {
          "name": "DISCOVER_DINERS",
          "description": ""
        },
        {
          "name": "JCB",
          "description": ""
        },
        {
          "name": "CHINA_UNIONPAY",
          "description": ""
        },
        {
          "name": "SQUARE_GIFT_CARD",
          "description": ""
        },
        {
          "name": "SQUARE_CAPITAL_CARD",
          "description": ""
        },
        {
          "name": "INTERAC",
          "description": ""
        },
        {
          "name": "EFTPOS",
          "description": ""
        },
        {
          "name": "FELICA",
          "description": ""
        },
        {
          "name": "EBT",
          "description": ""
        }
      ],
      "description": "Indicates a card's brand, such as `VISA` or `MASTERCARD`.",
      "x-release-status": "PUBLIC"
    },
    "CardCoBrand": {
      "type": "string",
      "enum": [
        "UNKNOWN",
        "AFTERPAY",
        "CLEARPAY"
      ],
      "x-enum-elements": [
        {
          "name": "UNKNOWN",
          "description": ""
        },
        {
          "name": "AFTERPAY",
          "description": ""
        },
        {
          "name": "CLEARPAY",
          "description": ""
        }
      ],
      "description": "Indicates the brand for a co-branded card.",
      "x-release-status": "PUBLIC"
    },
    "CardPrepaidType": {
      "type": "string",
      "enum": [
        "UNKNOWN_PREPAID_TYPE",
        "NOT_PREPAID",
        "PREPAID"
      ],
      "x-enum-elements": [
        {
          "name": "UNKNOWN_PREPAID_TYPE",
          "description": ""
        },
        {
          "name": "NOT_PREPAID",
          "description": ""
        },
        {
          "name": "PREPAID",
          "description": ""
        }
      ],
      "description": "Indicates a card's prepaid type, such as `NOT_PREPAID` or `PREPAID`.",
      "x-release-status": "PUBLIC"
    },
    "CardType": {
      "type": "string",
      "enum": [
        "UNKNOWN_CARD_TYPE",
        "CREDIT",
        "DEBIT"
      ],
      "x-enum-elements": [
        {
          "name": "UNKNOWN_CARD_TYPE",
          "description": ""
        },
        {
          "name": "CREDIT",
          "description": ""
        },
        {
          "name": "DEBIT",
          "description": ""
        }
      ],
      "description": "Indicates a card's type, such as `CREDIT` or `DEBIT`.",
      "x-release-status": "PUBLIC"
    },
    "CatalogAvailabilityPeriod": {
      "type": "object",
      "description": "Represents a time period of availability.",
      "x-release-status": "BETA",
      "properties": {
        "start_local_time": {
          "type": [
            "string",
            "null"
          ],
          "description": "The start time of an availability period, specified in local time using partial-time\nRFC 3339 format. For example, `8:30:00` for a period starting at 8:30 in the morning.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC."
        },
        "end_local_time": {
          "type": [
            "string",
            "null"
          ],
          "description": "The end time of an availability period, specified in local time using partial-time\nRFC 3339 format. For example, `21:00:00` for a period ending at 9:00 in the evening.\nNote that the seconds value is always :00, but it is appended for conformance to the RFC."
        },
        "day_of_week": {
          "$ref": "#/$defs/DayOfWeek",
          "description": "The day of the week for this availability period.\nSee [DayOfWeek](#type-dayofweek) for possible values"
        }
      }
    },
    "CatalogCategory": {
      "type": "object",
      "description": "A category to which a `CatalogItem` instance belongs.",
      "x-release-status": "PUBLIC",
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The category name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.",
          "maxLength": 255
        },
        "image_ids": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "The IDs of images associated with this `CatalogCategory` instance.\nCurrently these images are not displayed by Square, but are free to be displayed in 3rd party applications."
        },
        "category_type": {
          "$ref": "#/$defs/CatalogCategoryType",
          "description": "The type of the category.\nSee [CatalogCategoryType](#type-catalogcategorytype) for possible values"
        },
        "parent_category": {
          "$ref": "#/$defs/CatalogObjectCategory",
          "description": "The ID of the parent category of this category instance."
        },
        "is_top_level": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Indicates whether a category is a top level category, which does not have any parent_category."
        },
        "channels": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "A list of IDs representing channels, such as a Square Online site, where the category can be made visible."
        },
        "availability_period_ids": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "The IDs of the `CatalogAvailabilityPeriod` objects associated with the category."
        },
        "online_visibility": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Indicates whether the category is visible (`true`) or hidden (`false`) on all of the seller's Square Online sites."
        },
        "root_category": {
          "type": "string",
          "description": "The top-level category in a category hierarchy.",
          "readOnly": true
        },
        "ecom_seo_data": {
          "$ref": "#/$defs/CatalogEcomSeoData",
          "description": "The SEO data for a seller's Square Online store."
        },
        "path_to_root": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/CategoryPathToRootNode"
          },
          "description": "The path from the category to its root category. The first node of the path is the parent of the category\nand the last is the root category. The path is empty if the category is a root category."
        }
      }
    },
    "CatalogCategoryType": {
      "type": "string",
      "enum": [
        "REGULAR_CATEGORY",
        "MENU_CATEGORY",
        "KITCHEN_CATEGORY"
      ],
      "x-enum-elements": [
        {
          "name": "REGULAR_CATEGORY",
          "description": "The regular category."
        },
        {
          "name": "MENU_CATEGORY",
          "description": "The menu category."
        },
        {
          "name": "KITCHEN_CATEGORY",
          "description": "Kitchen categories are used by KDS (Kitchen Display System) to route items to specific clients"
        }
      ],
      "description": "Indicates the type of a category.",
      "x-release-status": "PUBLIC"
    },
    "CatalogCustomAttributeDefinition": {
      "type": "object",
      "description": "Contains information defining a custom attribute. Custom attributes are\nintended to store additional information about a catalog object or to associate a\ncatalog object with an entity in another system. Do not use custom attributes\nto store any sensitive information (personally identifiable information, card details, etc.).\n[Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes)",
      "x-release-status": "PUBLIC",
      "required": [
        "type",
        "name",
        "allowed_object_types"
      ],
      "properties": {
        "type": {
          "$ref": "#/$defs/CatalogCustomAttributeDefinitionType",
          "description": "The type of this custom attribute. Cannot be modified after creation.\nRequired.\nSee [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values"
        },
        "name": {
          "type": "string",
          "description": " The name of this definition for API and seller-facing UI purposes.\nThe name must be unique within the (merchant, application) pair. Required.\nMay not be empty and may not exceed 255 characters. Can be modified after creation.",
          "minLength": 1,
          "maxLength": 255
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "Seller-oriented description of the meaning of this Custom Attribute,\nany constraints that the seller should observe, etc. May be displayed as a tooltip in Square UIs.",
          "maxLength": 255
        },
        "source_application": {
          "$ref": "#/$defs/SourceApplication",
          "description": "__Read only.__ Contains information about the application that\ncreated this custom attribute definition."
        },
        "allowed_object_types": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CatalogObjectType"
          },
          "description": "The set of `CatalogObject` types that this custom atttribute may be applied to.\nCurrently, only `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, and `CATEGORY` are allowed. At least one type must be included.\nSee [CatalogObjectType](#type-catalogobjecttype) for possible values"
        },
        "seller_visibility": {
          "$ref": "#/$defs/CatalogCustomAttributeDefinitionSellerVisibility",
          "description": "The visibility of a custom attribute in seller-facing UIs (including Square Point\nof Sale applications and Square Dashboard). May be modified.\nSee [CatalogCustomAttributeDefinitionSellerVisibility](#type-catalogcustomattributedefinitionsellervisibility) for possible values"
        },
        "app_visibility": {
          "$ref": "#/$defs/CatalogCustomAttributeDefinitionAppVisibility",
          "description": "The visibility of a custom attribute to applications other than the application\nthat created the attribute.\nSee [CatalogCustomAttributeDefinitionAppVisibility](#type-catalogcustomattributedefinitionappvisibility) for possible values"
        },
        "string_config": {
          "$ref": "#/$defs/CatalogCustomAttributeDefinitionStringConfig",
          "description": "Optionally, populated when `type` = `STRING`, unset otherwise."
        },
        "number_config": {
          "$ref": "#/$defs/CatalogCustomAttributeDefinitionNumberConfig",
          "description": "Optionally, populated when `type` = `NUMBER`, unset otherwise."
        },
        "selection_config": {
          "$ref": "#/$defs/CatalogCustomAttributeDefinitionSelectionConfig",
          "description": "Populated when `type` is set to `SELECTION`, unset otherwise."
        },
        "custom_attribute_usage_count": {
          "type": "integer",
          "description": "The number of custom attributes that reference this\ncustom attribute definition. Set by the server in response to a ListCatalog\nrequest with `include_counts` set to `true`.  If the actual count is greater\nthan 100, `custom_attribute_usage_count` will be set to `100`.",
          "readOnly": true
        },
        "key": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the desired custom attribute key that can be used to access\nthe custom attribute value on catalog objects. Cannot be modified after the\ncustom attribute definition has been created.\nMust be between 1 and 60 characters, and may only contain the characters `[a-zA-Z0-9_-]`.",
          "minLength": 1,
          "maxLength": 60,
          "pattern": "^[a-zA-Z0-9_-]*$"
        }
      }
    },
    "CatalogCustomAttributeDefinitionAppVisibility": {
      "type": "string",
      "enum": [
        "APP_VISIBILITY_HIDDEN",
        "APP_VISIBILITY_READ_ONLY",
        "APP_VISIBILITY_READ_WRITE_VALUES"
      ],
      "x-enum-elements": [
        {
          "name": "APP_VISIBILITY_HIDDEN",
          "description": "Other applications cannot read this custom attribute."
        },
        {
          "name": "APP_VISIBILITY_READ_ONLY",
          "description": "Other applications can read this custom attribute definition and\nvalues."
        },
        {
          "name": "APP_VISIBILITY_READ_WRITE_VALUES",
          "description": "Other applications can read and write custom attribute values on objects.\nThey can read but cannot edit the custom attribute definition."
        }
      ],
      "description": "Defines the visibility of a custom attribute to applications other than their\ncreating application.",
      "x-release-status": "PUBLIC"
    },
    "CatalogCustomAttributeDefinitionNumberConfig": {
      "type": "object",
      "x-release-status": "PUBLIC",
      "properties": {
        "precision": {
          "type": [
            "integer",
            "null"
          ],
          "description": "An integer between 0 and 5 that represents the maximum number of\npositions allowed after the decimal in number custom attribute values\nFor example:\n\n- if the precision is 0, the quantity can be 1, 2, 3, etc.\n- if the precision is 1, the quantity can be 0.1, 0.2, etc.\n- if the precision is 2, the quantity can be 0.01, 0.12, etc.\n\nDefault: 5",
          "maximum": 5
        }
      }
    },
    "CatalogCustomAttributeDefinitionSelectionConfig": {
      "type": "object",
      "description": "Configuration associated with `SELECTION`-type custom attribute definitions.",
      "x-release-status": "PUBLIC",
      "properties": {
        "max_allowed_selections": {
          "type": [
            "integer",
            "null"
          ],
          "description": "The maximum number of selections that can be set. The maximum value for this\nattribute is 100. The default value is 1. The value can be modified, but changing the value will not\naffect existing custom attribute values on objects. Clients need to\nhandle custom attributes with more selected values than allowed by this limit.",
          "maximum": 100
        },
        "allowed_selections": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection"
          },
          "description": "The set of valid `CatalogCustomAttributeSelections`. Up to a maximum of 100\nselections can be defined. Can be modified."
        }
      }
    },
    "CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection": {
      "type": "object",
      "description": "A named selection for this `SELECTION`-type custom attribute definition.",
      "x-release-status": "PUBLIC",
      "required": [
        "name"
      ],
      "properties": {
        "uid": {
          "type": [
            "string",
            "null"
          ],
          "description": "Unique ID set by Square."
        },
        "name": {
          "type": "string",
          "description": "Selection name, unique within `allowed_selections`.",
          "minLength": 1,
          "maxLength": 255
        }
      }
    },
    "CatalogCustomAttributeDefinitionSellerVisibility": {
      "type": "string",
      "enum": [
        "SELLER_VISIBILITY_HIDDEN",
        "SELLER_VISIBILITY_READ_WRITE_VALUES"
      ],
      "x-enum-elements": [
        {
          "name": "SELLER_VISIBILITY_HIDDEN",
          "description": "Sellers cannot read this custom attribute in Square client\napplications or Square APIs."
        },
        {
          "name": "SELLER_VISIBILITY_READ_WRITE_VALUES",
          "description": "Sellers can read and write this custom attribute value in catalog objects,\nbut cannot edit the custom attribute definition."
        }
      ],
      "description": "Defines the visibility of a custom attribute to sellers in Square\nclient applications, Square APIs or in Square UIs (including Square Point\nof Sale applications and Square Dashboard).",
      "x-release-status": "PUBLIC"
    },
    "CatalogCustomAttributeDefinitionStringConfig": {
      "type": "object",
      "description": "Configuration associated with Custom Attribute Definitions of type `STRING`.",
      "x-release-status": "PUBLIC",
      "properties": {
        "enforce_uniqueness": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "If true, each Custom Attribute instance associated with this Custom Attribute\nDefinition must have a unique value within the seller's catalog. For\nexample, this may be used for a value like a SKU that should not be\nduplicated within a seller's catalog. May not be modified after the\ndefinition has been created."
        }
      }
    },
    "CatalogCustomAttributeDefinitionType": {
      "type": "string",
      "enum": [
        "STRING",
        "BOOLEAN",
        "NUMBER",
        "SELECTION"
      ],
      "x-enum-elements": [
        {
          "name": "STRING",
          "description": "A free-form string containing up to 255 characters."
        },
        {
          "name": "BOOLEAN",
          "description": "A `true` or `false` value."
        },
        {
          "name": "NUMBER",
          "description": "A decimal string representation of a number. Can support up to 5 digits after the decimal point."
        },
        {
          "name": "SELECTION",
          "description": "One or more choices from `allowed_selections`."
        }
      ],
      "description": "Defines the possible types for a custom attribute.",
      "x-release-status": "PUBLIC"
    },
    "CatalogCustomAttributeValue": {
      "type": "object",
      "description": "An instance of a custom attribute. Custom attributes can be defined and\nadded to `ITEM` and `ITEM_VARIATION` type catalog objects.\n[Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes).",
      "x-release-status": "PUBLIC",
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The name of the custom attribute."
        },
        "string_value": {
          "type": [
            "string",
            "null"
          ],
          "description": "The string value of the custom attribute.  Populated if `type` = `STRING`."
        },
        "custom_attribute_definition_id": {
          "type": "string",
          "description": "The id of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) this value belongs to.",
          "readOnly": true
        },
        "type": {
          "$ref": "#/$defs/CatalogCustomAttributeDefinitionType",
          "description": "A copy of type from the associated `CatalogCustomAttributeDefinition`.\nSee [CatalogCustomAttributeDefinitionType](#type-catalogcustomattributedefinitiontype) for possible values",
          "readOnly": true
        },
        "number_value": {
          "type": [
            "string",
            "null"
          ],
          "description": "Populated if `type` = `NUMBER`. Contains a string\nrepresentation of a decimal number, using a `.` as the decimal separator."
        },
        "boolean_value": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "A `true` or `false` value. Populated if `type` = `BOOLEAN`."
        },
        "selection_uid_values": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`."
        },
        "key": {
          "type": "string",
          "description": "If the associated `CatalogCustomAttributeDefinition` object is defined by another application, this key is prefixed by the defining application ID.\nFor example, if the CatalogCustomAttributeDefinition has a key attribute of \"cocoa_brand\" and the defining application ID is \"abcd1234\", this key is \"abcd1234:cocoa_brand\"\nwhen the application making the request is different from the application defining the custom attribute definition. Otherwise, the key is simply \"cocoa_brand\".",
 

# --- truncated at 32 KB (376 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-create-payment-link-response-schema.json