The interface that defines the styles available for customizing the appearance of the checkout.

Properties

fontFacesFontFace[]

An array of FontFace objects to specify custom fonts to be used in the checkout.

FontFace

fontFamilystring

A string that defines the font family of the text.

srcstring

A string that defines the location of the font file.

unicodeRangestring

A string that defines the Unicode range of the font.

fontVariantstring

A string that defines the variant of the font.

fontFeatureSettingsstring

A string that defines the feature settings of the font.

fontVariationSettingsstring

A string that defines the variation settings of the font.

fontStretchstring

A string that defines the stretch of the font.

fontWeightstring

A string that defines the weight of the font.

fontStylestring

A string that defines the style of the font.

stylesheetsStylesheet[]

An array of Stylesheet objects to specify custom stylesheets to be used in the checkout.

Stylesheet

hrefstring

Url of the stylesheet.

loadingScreenLoadingScreenStyle

An object of type LoadingScreenStyle to configure the loading screen that appears during checkout processing.

LoadingScreenStyle

colorstring

Color of the loading screen.

inputInputStyles

An object of type InputStyles to configure the appearance of input fields in the checkout.

InputStyles

baseInputStyle

An object of type InputStyle describing the base style of the input.

errorInputStyle

An object of type InputStyle describing the style of the input in an error state.

inputLabelTextStyle

An object of type TextStyle to configure the appearance of input field labels in the checkout.

TextStyle

colorstring

An optional string that defines the color of the text.

fontFamilystring

An optional string that defines the font family of the text.

fontWeightstring

An optional string that defines the weight of the text.

fontSizestring

An optional string that defines the size of the text.

fontSmoothingstring

An optional string that defines the smoothing of the font.

lineHeightstring

An optional string that defines the height of the line.

textTransformstring

An optional string that defines the transformation of the text.

letterSpacingstring

An optional string that defines the spacing between letters in the text.

inputErrorTextTextStyle & TextAlignmentStyle

An object of type TextStyle & TextAlignmentStyle to configure the appearance of error text that appears below input fields.

TextStyle

colorstring

An optional string that defines the color of the text.

fontFamilystring

An optional string that defines the font family of the text.

fontWeightstring

An optional string that defines the weight of the text.

fontSizestring

An optional string that defines the size of the text.

fontSmoothingstring

An optional string that defines the smoothing of the font.

lineHeightstring

An optional string that defines the height of the line.

textTransformstring

An optional string that defines the transformation of the text.

letterSpacingstring

An optional string that defines the spacing between letters in the text.
TextAlignmentStyle

textAlignstring

A string that defines the alignment of text.

formSpacingsFormSpacings

An object of type FormSpacings to configure the spacing between form elements in the checkout.

FormSpacings

betweenLabelAndInputstring

Specifies the amount of space between a form label and its corresponding input element. The value is a string representing a CSS length, such as "10px" or "1em".

betweenInputsstring

Specifies the amount of space between different input elements within a form. The value is a string representing a CSS length, such as "10px" or "1em".

showMorePaymentMethodsButtonShowMorePaymentMethodsButtonStyles

An object of type ShowMorePaymentMethodsButtonStyles to configure the appearance of the "Show More Payment Methods" button in the checkout.

ShowMorePaymentMethodsButtonStyles

baseTextStyle

Defines the base style for the button. The value is an object of type TextStyle.

disabledTextStyle

Defines the style for the button when it's disabled. The value is an object of type TextStyle.

networkErrorNetworkErrorStyles

An object of type NetworkErrorStyles to configure the appearance of the network error message that appears when the checkout cannot connect to the server.

NetworkErrorStyles

buttonobject

Properties

baseBlockStyle & TextStyle

Properties

colorstring

An optional string that defines the color of the text.

fontFamilystring

An optional string that defines the font family of the text.

fontWeightstring

An optional string that defines the weight of the text.

fontSizestring

An optional string that defines the size of the text.

fontSmoothingstring

An optional string that defines the smoothing of the font.

lineHeightstring

An optional string that defines the height of the line.

textTransformstring

An optional string that defines the transformation of the text.

letterSpacingstring

An optional string that defines the spacing between letters in the text.

backgroundstring

A string that defines the background color or image of the box element.

borderRadiusnumber | string

A number or string that defines the radius of the box element's corners.

boxShadowstring

A string that defines the shadow effect of the box element.

borderStylestring

A string that defines the style of the box element's border.

borderColornumber | string

A number or string that defines the color of the box element's border.

borderWidthnumber | string

A number or string that defines the width of the box element's border.

submitButtonSubmitButtonStyles

An object of type SubmitButtonStyles to configure the appearance of the checkout's submit button.

SubmitButtonStyles

baseSubmitButtonStyle

Defines the base style for the submit button. The value is an object of type SubmitButtonStyle.

disabledSubmitButtonStyle

Defines the style for the submit button when it's loading. The value is an object of type SubmitButtonStyle.

loadingSubmitButtonStyle

Defines the style for the submit button when it's loading. The value is an object of type SubmitButtonStyle.

vaultTitleTextStyle

An object of type TextStyle to configure the appearance of the "Saved Payment Methods" title in the checkout.

TextStyle

colorstring

An optional string that defines the color of the text.

fontFamilystring

An optional string that defines the font family of the text.

fontWeightstring

An optional string that defines the weight of the text.

fontSizestring

An optional string that defines the size of the text.

fontSmoothingstring

An optional string that defines the smoothing of the font.

lineHeightstring

An optional string that defines the height of the line.

textTransformstring

An optional string that defines the transformation of the text.

letterSpacingstring

An optional string that defines the spacing between letters in the text.

savedPaymentMethodButtonSavedPaymentMethodButtonStyles

An object of type SavedPaymentMethodButtonStyles to configure the appearance of the buttons that represent saved payment methods in the checkout.

SavedPaymentMethodButtonStyles

baseSavedPaymentMethodButtonStyle

An object of type SavedPaymentMethodButtonStyle that defines the style for the saved payment method button.

selectedSavedPaymentMethodButtonStyle

An object of type SavedPaymentMethodButtonStyle that defines the style for the saved payment method button when it's selected'.

paymentMethodButtonPaymentMethodButtonStyle

An object of type PaymentMethodButtonStyle to configure the appearance of the buttons that represent payment methods in the checkout.

PaymentMethodButtonStyle

heightnumber

The height of the payment method button.

minHeightnumber

The minimum height of the payment method button.

maxHeightnumber

The maximum height of the payment method button.

primaryTextTextStyle

An object of type Textstyle which describes the styling properties for the primary text in the payment method button.

logoColor"DARK" | "LIGHT" | "COLORED"

The color of the payment method logo, which can be "DARK", "LIGHT", or "COLORED".

marginTopstring

The top margin of the payment method button.

backgroundstring

A string that defines the background color or image of the box element.

borderRadiusnumber | string

A number or string that defines the radius of the box element's corners.

boxShadowstring

A string that defines the shadow effect of the box element.

borderStylestring

A string that defines the style of the box element's border.

borderColornumber | string

A number or string that defines the color of the box element's border.

borderWidthnumber | string

A number or string that defines the width of the box element's border.

errorMessageErrorMessageStyle

An object of type ErrorMessageStyle to configure the appearance of error messages that appear in the checkout.

ErrorMessageStyle

colorstring

The color of the error message.

colorstring

An optional string that defines the color of the text.

fontFamilystring

An optional string that defines the font family of the text.

fontWeightstring

An optional string that defines the weight of the text.

fontSizestring

An optional string that defines the size of the text.

fontSmoothingstring

An optional string that defines the smoothing of the font.

lineHeightstring

An optional string that defines the height of the line.

textTransformstring

An optional string that defines the transformation of the text.

letterSpacingstring

An optional string that defines the spacing between letters in the text.

backgroundstring

A string that defines the background color or image of the box element.

borderRadiusnumber | string

A number or string that defines the radius of the box element's corners.

boxShadowstring

A string that defines the shadow effect of the box element.

borderStylestring

A string that defines the style of the box element's border.

borderColornumber | string

A number or string that defines the color of the box element's border.

borderWidthnumber | string

A number or string that defines the width of the box element's border.

smallPrintTextStyle

An object of type TextStyle to configure the appearance of the small print that appears at the bottom of the checkout.

TextStyle

colorstring

An optional string that defines the color of the text.

fontFamilystring

An optional string that defines the font family of the text.

fontWeightstring

An optional string that defines the weight of the text.

fontSizestring

An optional string that defines the size of the text.

fontSmoothingstring

An optional string that defines the smoothing of the font.

lineHeightstring

An optional string that defines the height of the line.

textTransformstring

An optional string that defines the transformation of the text.

letterSpacingstring

An optional string that defines the spacing between letters in the text.