Checkout variables reference

The checkout view data in FC.json includes everything in the cart<br>including the following values:<br>anonymous_checkout_selected

Used for determining if a customer opted to check out anonymously.

auth_token_is_valid

Used for determining if the Single Sign On (SSO) authorization token is valid.

authentication_is_in_progress

If the customer is currently authenticating.

authentication_is_not_successful

If customer authentication failed.

authentication_is_successful

If customer authentication is successful.

billing_address

(See cart shipping_address)

cc_cvv2

Credit card Card Security Code for new cards.

cc_cvv2_saved

Credit card Card Security Code for existing cards.

cc_exp_month

Credit card expiration date month.

cc_exp_year

Credit card expiration date year.

cc_number

Credit card number.

cc_number_masked

Masked credit card number.

cc_type

Credit card type (Visa, MasterCard, Amex, etc)

change_password

If the customer as opted to change their password.

checkout_date

The date this checkout took place, formatted based on the locale (see checkout_timestamp for a raw value)

checkout_type

The type of checkout taking place which can be either default_account, default_guest, guest_only, account_only

checkout_timestamp

The timestamp of when this checkout took place.

continue_url

The URL used on the receipt to continue back to your store’s website.

create_account

Whether or not the customer chose to create an account during checkout.

customer_email

The customer email address.

customer_id_encoded

Used for determining which customer just logged in.

customer_is_authenticated

Used for determining if the current customer is authenticated via Single Sign On (SSO).

customer_password

The customer password entered by the user.

email_is_checking

If the checkout is currently checking to see if the email address given belongs to an existing customer.

email_is_found

Indicates if the email address given belongs to an existing customer.

email_is_valid

Indicates if the email address given is valid.

fc_auth_token

The Single Sign On (SSO) authentication token.

fc_customer_id

The Single Sign On (SSO) passed in customer id.

first_receipt_display

If the receipt is being displayed for the very first time which can be helpful for displaying specific conversion tracking code.

force_password_reset

If the customer requires a password reset because they logged in with a temporary password.

force_saved_account

If the cart contains subscriptions, the customer will be forced to checkout as a named account.

geoip

Used in the emails sent to store administrators to display the GEO IP lookup details for the country based on the ip address of the customer checking out. This will not be available for the checkout or receipt context.

has_discounts

If the cart contains coupon discounts.

has_downloadables

If the cart contains downloadable products.

has_saved_cc

If the customer has a saved credit card.

has_visible_custom_fields

If the checkout has custom fields which are not hidden custom fields.

hosted_payment_gateways

Array of hosted payment gateways available for this checkout.

hosted_payment_gateways.lang_pay_with

Language and logo used on the checkout page to tell the customer they can pay with this method.

hosted_payment_gateways.lang_payment_method

Additional information for the customer indicating what happens next, such as if they will be redirected to another site to confirm payment.

hosted_payment_gateways.supports_subscriptions

Whether or not this hosted payment method supports subscriptions.

hosted_payment_gateways.type

The type of this hosted solution such as bitpay, dwolla, etc.

html_downloadable_links

The links for downloading products purchased as FoxyCart downloadables.

ip_address

The ip address of the customer.

is_anonymous

If the customer checked out as an anonymous user.

is_uoe

If the customer is currently logged in using Unified Order Entry.

loading_submit

Used for determining if an animation should be displayed near the submit button.

multiship_data

Array of shipments for each multiship customer shipment (in addition to address data found in shipping_address)

multiship_data.address_name

The name given to this shipto address. This will be the same as the “shipto” value in the cart.

multiship_data.checkout_total_tax

The tax total for this shipment used during checkout.

multiship_data.custom_fields

Custom fields for this shipment.

multiship_data.has_live_rate_shippable_products

Whether or not this shipment has products from a category which uses live shipping rates.

multiship_data.has_shipping_or_handling_cost

Whether or not this shipment has products from a category which has any shipping or handling costs.

multiship_data.has_visible_custom_fields

Whether or not any of the custom fields in this shipment are visible.

multiship_data.number

The shipto number used for visual organization.

multiship_data.total_future_shipping

The total future shipping amount in this shipment

multiship_data.total_item_price

The total amount of all the items in this shipment

multiship_data.total_price

The total price in this shipment

multiship_data.total_shipping

The total shipping amount in this shipment

multiship_data.total_tax

The total tax amount in this shipment

new_customer_password

When creating a new customer or changing an existing password, this will contain the new password entered by the customer.

order_id

The transaction id of this order.

password_expired

True if the password this customer used has expired, such as when using a temporary password.

payer_id

Used by 3D Secure systems.

payment_is_pending

If the customer checked out with a hosted gateway which first marks the payment as pending, this boolean can be used for special messaging to the customer on the receipt.

payment_method_type

Either plastic_saved, plastic_new, or the type of the hosted payment gateway being used.

payment_type

The payment type usually being plastic, hosted (as in a hosted payment gateway), purchase_order, paypal or other.

processor_response

The payment gateway response value used on the receipt.

purchase_order

The purchase order value submitted by the customer.

receipt_url

The canonical url of the transaction receipt.

required_fields

Array of required field names as configured in the FoxyCart admin template configuration page.

shipping_and_handling_label

The default label for the shipping and/or handling fees charged for this order.

show_message_for_testing

Used to indicate if a testing informational message is to be displayed. This can be useful for styling purposes and can be triggered by passing in a fc_show_info custom field.

status

Used in some situations such as with hosted gateways to specify the status of the current transaction. Values include approved, authorized, declined, pending, or rejected.

subscriptions

Array of subscription data for this transaction.

subscriptions.description

The textual description of this subscription including the frequency.

subscriptions.sub_token_url

The subscription token url which can be used by the customer to modify or cancel this subscription or by the store to adjust the subscription via the API.

subscriptions.html_links

The links needed by the customer to modify or cancel this subscription in html format.

subscriptions.text_links

The links needed by the customer to modify or cancel this subscription in text format.

temporary_password_sent

Indicates whether the temporary password has been sent to the customer.

text_downloadable_links

Text links for downloading the products purchased.

timestamp

Used by the Single Sign On (SSO) feature to ensure the token is only valid for a specific amount of time.

token

Used by 3D Secure systems.

tos_agreement

The state of the terms of service checkbox, if being used by the checkout.

use_alternate_shipping_address

A boolean state of the checkbox for using an alternate shipping address other than the billing address.

use_different_addresses

The state of the checkbox for using an alternate shipping address other than the billing address.

utils

Custom twig macros we’ve added which we’ve also ported to twig.js

utils.get_error_string

Get a specific error string from the array of errors by context key.

utils.get_info_string

Get a specific info string from the array of informational strings by context key.

utils.shipping_results

Macro for formatting shipping rate results into radio buttons.

utils.use_different_addresses

Macro for displaying the use alternate address checkbox.

alert_test_gateway

Used for FoxyCart test stores.

base_directory

Used for determining the correct base directory for this store version.

cc_expiration_months

An array of months for displaying the credit card expiration month select box.

cc_expiration_years

An array of years for displaying the credit card expiration year select box.

has_multiple_payment_options

A boolean used for display logic when there are more than one payment options enabled by the store for the checkout page.

lang

Includes language strings from cart config lang as well as additional strings for checkout, email and receipt contexts.

supports_pay_with_plastic

A boolean used for display logic on the checkout page for if the store supports paying with a debit or credit card.

supports_purchase_order

A boolean used for display logic on the checkout page for if the store supports paying by purchase order.