• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
PaymentLink

Properties

Name Description
id
string

Read only The Square-assigned ID of the payment link.

version
integer (32-bit)

Required

The Square-assigned version number, which is incremented each time an update is committed to the payment link.

Max 65535
description
string

The optional description of the payment_link object. It is primarily for use by your application and is not used anywhere.

Max Length 4096
order_id
string

Read only The ID of the order associated with the payment link.

Max Length 192
checkout_options
CheckoutOptions

The checkout options configured for the payment link. For more information, see Optional Checkout Configurations.

pre_populated_data
PrePopulatedData

Describes buyer data to prepopulate on the checkout page.

url
string

Read only The URL of the payment link.

Max Length 255
created_at
string

The timestamp when the payment link 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

updated_at
string

The timestamp when the payment link was last updated, 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

payment_note
string

An optional note. After Square processes the payment, this note is added to the
resulting Payment.

Max Length 500