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

Object Index

You are viewing an old version of the API
CheckoutOptions

Properties

Name Description
allow_tipping
boolean

Indicates whether the payment allows tipping.

custom_fields
CustomField [ ]

The custom fields requesting information from the buyer.

subscription_plan_id
string

The ID of the subscription plan for the buyer to pay and subscribe. For more information, see Subscription Plan Checkout.

Max Length 255
redirect_url
string

The confirmation page URL to redirect the buyer to after Square processes the payment.

Max Length 2048
merchant_support_email
string

The email address that buyers can use to contact the seller.

Max Length 256
ask_for_shipping_address
boolean

Indicates whether to include the address fields in the payment form.

accepted_payment_methods
AcceptedPaymentMethods

The methods allowed for buyers during checkout