CheckoutSession

Object

Data required to display the hosted checkout page.

Fields

companyNameRequirement CheckoutFieldRequirement!: Whether the checkout includes a company-name field, and whether it is required.
Possible enum values
DISABLED
The field is not shown or collected during checkout.
OPTIONAL
The field is shown but a value is not required.
REQUIRED
The field is shown and a value must be provided.
companyVatNumberRequirement CheckoutFieldRequirement!: Whether the checkout includes a company VAT-number field.
Possible enum values
DISABLED
The field is not shown or collected during checkout.
OPTIONAL
The field is shown but a value is not required.
REQUIRED
The field is shown and a value must be provided.
favicon Media: The variant media.
logo Media: The logo.
marketingConsent Boolean!: Whether the hosted checkout should display a marketing-consent checkbox.
nameRequirement CheckoutNameRequirement!: Whether the checkout requires both first and last name, or only the last name.
Possible enum values
FIRST_AND_LAST_NAME
Requires both a first name and a last name.
LAST_NAME_ONLY
Requires only a last name.
redirectUri String: Optional storefront URL used when customers leave hosted checkout.
shippingPhoneNumberRequirement CheckoutFieldRequirement!: Whether the checkout includes a shipping phone-number field, and whether it is required.
Possible enum values
DISABLED
The field is not shown or collected during checkout.
OPTIONAL
The field is shown but a value is not required.
REQUIRED
The field is shown and a value must be provided.
token String!: The token of the checkout session.

Queries

checkoutSession: Retrieves the data required to display the hosted checkout page for a checkout session token.