<- Object

Object

All versions ->

CheckoutOptions

Link to section

Properties

Link to section

allow_tipping

boolean

Indicates whether the payment allows tipping.

Link to section

custom_fields

The custom fields requesting information from the buyer.

Link to section

subscription_plan_id

string

Link to section

redirect_url

string

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

Link to section

merchant_support_email

string

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

Link to section

ask_for_shipping_address

boolean

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

Link to section

accepted_payment_methods

The methods allowed for buyers during checkout.

Link to section

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

Link to section

shipping_fee

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

Link to section

enable_coupon

boolean

Indicates whether to include the Add coupon section for the buyer to provide a Square marketing coupon in the payment form.

Link to section

enable_loyalty

boolean

Indicates whether to include the REWARDS section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both.