• 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.

Max Length 2
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.

app_fee_money
Money

The amount of money that the developer is taking as a fee for facilitating the payment on behalf of the seller.

The amount cannot be more than 90% of the total amount of the payment.

The amount must be specified in the smallest denomination of the applicable currency (for example, US dollar amounts are specified in cents). For more information, see Working with Monetary Amounts.

The fee currency code must match the currency associated with the seller that is accepting the payment. The application must be from a developer account in the same country and using the same currency code as the seller. For more information about the application fee scenario, see Take Payments and Collect Fees.

To set this field, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS OAuth permission is required. For more information, see Permissions.

shipping_fee
ShippingFee

The fee associated with shipping to be applied to the Order as a service charge.