Receipt template variables reference

cart_cancel_and_continue_link

URL for continuing back to the store from the cart.

cart_config_hash

Used to validate the local storage version of FC.json.config is up to date.

cart_is_fullpage

true or false depending on whether the cart is the full-page cart.

context

Either cart, checkout, or receipt. Used for configuring display and functionality.

coupons / coupons.{coupon_code}.amount / .id / .is_applied / .is_taxable / .name

Coupons associated with this cart, keyed by the code the customer used. If shared codes are allowed, becomes a nested array with the same attributes.

custom_fields / custom_fields.{name}.is_hidden / .value

Custom fields associated with this transaction. is_hidden is true if passed via the h: prefix.

expires_in

Time in seconds until the first product in the cart expires.

future_coupons.{coupon_code}.amount / .id / .is_applied / .name

Same as coupons, but for products with a start date or next transaction date in the future.

future_subscription_totals_by_date.total / .total_item_price / .total_shipping / .total_tax / .total_weight

Totals for subscription products with a future start/next-transaction date, grouped for cart display.

gift_cards.{gift_card_code}.amount / .id / .code_id / .is_applied / .name / .current_balance

Gift cards associated with this cart. current_balance on the receipt reflects the discount from this transaction and any later uses; the email receipt reflects the balance at the time the transaction completed.

has_eligible_coupons

If the cart contains products that can have a coupon applied.

has_future_products

If the cart contains products with a future start date or next transaction date.

has_future_shipping

If the cart contains future products from shippable categories.

has_live_rate_shippable_products

If the cart contains products from categories that support live shipping rates.

has_location_dependant_taxes

If the cart contains products with location-based taxes. Used for third-party options like PayPal Express and Amazon FPS.

has_multiship

If the store has multiship turned on.

has_product_images

If any product in the cart uses the image option.

has_shippable_products

If the cart contains products from shippable categories.

has_subscriptions

If the cart contains subscription products.

has_taxes

If the cart contains taxable products.

is_future_shipping_only

If all products in the cart are future products (shipping calculations apply only to future products).

is_new_subscription

If the cart contains a new subscription.

is_subscription_cancel

If this transaction cancels an existing active subscription.

is_subscription_modification

If this transaction modifies an existing active subscription (usually means future-charging products are present).

is_updateinfo

If cart=updateinfo.

item_count

Sum of all product quantities in the cart.

language

The English name of the cart’s language, as set by the template set (e.g. english, french). Blank if using the default template set.

language_iso_code

The 2-character ISO code for the cart’s language (e.g. en, fr). Blank if using the default template set.

loading_coupons / loading_quantity / loading_shipping_results / loading_taxes

Whether a loading animation should currently display for each of these.

locale_code

The locale code for this cart, e.g. en_US.

locale_info

All data from PHP’s localeconv() — currency symbols, decimal point character, thousands separator.

messages.errors[].context / .message

Array of error messages and the form input context they relate to.

messages.info[].context / .message

Array of informational messages.

messages.warnings[].context / .message

Array of warning messages.

multiship_data

Currently empty for the cart; may be populated in the future.

payment_info_required

true if payment info is required (order total > 0, and not a subscription cancel).

session_id

The session ID of this cart.

session_name

The name of the Foxy session.

shipping_address / billing_address

Container for address info — see the Shipping / Billing Address table below.

shipping_and_handling_label

The label describing the shipping applied to this order.

show_address_entry

Whether the cart address entry form should display.

show_amazon_fps_payment_option

Whether the Amazon payment button should display (not shown if the cart contains subscriptions).

show_coupon_input_button

Whether the coupon input button should display.

show_multiship_details

Whether to toggle multiship details.

show_paypal_express_payment_option

Whether the PayPal payment button should display.

show_shipping_tbd

Whether to show a “TBD” indicator because live shipping rates haven’t been calculated yet.

store_id

The Foxy store ID for this store.

template_set

The code for the cart’s current template set.

total_discount

Total coupon discount applied to this transaction.

total_future_item_price / total_future_shipping / total_future_weight_shippable

Totals for future items in the cart.

total_item_price

Total price of items in the cart.

total_order

The order total.

total_shipping

The shipping total.

total_tax

The tax total.

total_weight / total_weight_shippable

Total product weight / total weight of shippable products.

transaction_id

The Foxy transaction ID for the contents of the cart.

with_controls

Whether the current display includes cart controls (quantity, coupon entry, etc).

items[].alt_name

Used in the alt attribute of the product link.

items[].base_price

Product price before option modifiers.

items[].category

Product category code.

items[].code / .parent_code

Product code/SKU, and parent product code/SKU.

items[].delivery_type

The delivery type of this product.

items[].downloadable_id

The downloadable ID, if this product is a downloadable.

items[].expires

Timestamp for when this product expires.

items[].height / .length / .width

Reserved for future use.

items[].id

Unique internal ID for this product.

items[].image

The image URL for this product.

items[].is_parent

Whether this product is a parent product.

items[].item_number

Used for organizing item display and the product update process.

items[].multiship

The multiship group number used to organize products into shipments.

items[].name

The product name.

items[].options[].class / .name / .value

Product options: class is the name stripped to letters/numbers/dashes/underscores for use as an HTML class.

items[].price

The price extension (price_each * quantity).

items[].price_each

The actual price of one unit after option modifiers.

items[].quantity / .quantity_max / .quantity_min

Quantity in cart, and the max/min allowed.

items[].shipto

The shipto name of this product, used for multiship.

items[].sub_enddate / .sub_frequency / .sub_nextdate / .sub_startdate

Subscription end date, frequency, next processing date, and start date.

items[].url

The URL of this product.

items[].weight / .weight_each

Weight extension (weight_each * quantity), and weight of one unit.

.address1 / .address2

Address lines.

.address_name

The address name (mainly for multiship).

.city

City.

.city_option_selected

The city/region string used in the select option.

.city_options[].city / .region

Array of options returned from postal code lookup.

.company

Company.

.country / .country_name

Two-character country code, and country name.

.first_name / .last_name

Name.

.phone

Phone.

.postal_code

Postal code.

.prefix

Prefix (used for multiship).

.region / .region_label / .region_name

State/province code, label, and name.

.shipping_results[].method / .price / .service_id / .service_name

Live shipping rate calculation results.

.shipping_service_description

Description of the selected shipping service.

.shipping_service_id

The shipping service ID the customer selected.

.taxes[].amount / .applies_to_handling / .applies_to_shipping / .default_amount / .is_error / .is_live / .name / .rate / .tax_id

Taxes associated with this address.

.total_future_shipping / .total_shipping / .total_tax

Totals for products shipping to this address.

.type

Either billing or shipping.

cache_path

Path used for caching images in the Foxy system.

cart_config_hash

Validates the local storage version of FC.json.config.

cdn_base_path / cdn_static_path

Base path of the store’s files / static files served via the CDN.

css_file

Full path to the versioned store-specific stylesheet served by the CDN.

currency_format

The store’s configured currency format, used for Twig money formatting.

lang / lang.{code}

All customizable language strings, starting from a base configuration. View the full set via FC.json.config.lang in the browser console.

locations / locations.{country_code}.*

Complete listing of valid countries/states used by the FoxyComplete lookup system — see subfields below.

locations_billing / locations_shipping

Locations used for billing-only / shipping-only address forms.

paypal_checkout_button_url

Locale-specific PayPal payment button URL.

post_url

URL for posting cart and checkout forms.

store_domain

The store’s Foxy domain (the example part of example.foxycart.com).

store_logo_url

The store logo URL as configured in the admin.

store_name

The store name as configured in the admin.

store_url

The store’s website URL as configured in the admin.

template_config

All admin-configured settings under Configuration, exposed for use in Twig customizations — see subfields below.

weight_uom

Unit of measure used for calculating shipping weights.

.active

Whether this country is actively used by FoxyComplete.

.alt

Alternative/local spellings of this location name.

.boost

Used to boost certain spellings over others in search.

.cc2 / .cc3 / .ccnum

ISO 3166-1 alpha-2, alpha-3, and numeric country codes.

.cn

Country name (currently English only).

.pc.int

Whether the postal code is numeric only.

.pc.lang

Language key for the postal code description.

.pc.regex

Validation regex for the postal code format.

.pc.req

Whether the postal code is required.

.pc.search

Whether this country supports postal-code-based search.

.r.lang

Language key for this country’s region name (e.g. “state”).

.r.options.{region_code}.active

Whether this region is actively used by FoxyComplete.

.r.options.{region_code}.alt

Alternative/local spellings of this region name.

.r.options.{region_code}.boost

Boost value for this region’s spellings.

.r.options.{region_code}.c

ISO 3166-1 alpha-2 country code.

.r.options.{region_code}.n

Region name (currently English only).

.r.options.{region_code}.req

Whether regions are required for this country.

.analytics_config.google_analytics.account_id / .account_key / .usage

Google Analytics configuration (under construction).

.analytics_config.segment_io.account_key / .usage

Segment.io configuration (under construction).

.cart_display_config.show_product_category / .show_product_code / .show_product_options / .show_product_weight / .usage

Toggles for what displays in cart line items.

.checkout_type

default_account, default_guest, guest_only, or account_only — determines guest vs. named-account checkout behavior.

.colors.primary / .secondary / .tertiary / .usage

Main site colors, used to adjust template CSS via SASS.

.csc_requirements

When the Card Security Code is required: all_cards, sso_only, or new_cards_only.

.custom_checkout_field_requirements.billing_*

Per-field settings (hidden, required, optional, or default for region) for billing address fields.

.custom_checkout_field_requirements.cart_controls

Whether to allow cart controls on the checkout page.

.custom_checkout_field_requirements.coupon_entry

Whether to allow the coupon entry form on the checkout page.

.custom_config

Freeform custom configuration values for use in Twig template logic.

.custom_script_values.footer

Custom JavaScript added above </body> on cart, checkout, and receipt templates. Supports full Twig syntax; commonly gated by first_receipt_display for conversion tracking.

.custom_script_values.header

Custom CSS (or JS) added to <head> on cart, checkout, and receipt templates. Supports full Twig syntax.

.custom_script_values.checkout_fields

Custom HTML added inside the checkout <form> tag; submits with the checkout form as custom fields on the transaction.

.debug.usage

Whether debugging output is shown in the browser console.

.foxycomplete.combobox_close / .combobox_open

Icons for closing/opening the address autocomplete combo box.

.foxycomplete.show_combobox / .show_flags / .usage

Whether to show the combo box, country flags, and current usage configuration.

.newsletter_subscribe.usage

Configuration for the “Subscribe Me” checkout checkbox.

.ssl_receipt

If enabled, requires the receipt page to load over HTTPS.

.supported_payment_cards

Array of accepted card types (Visa, MasterCard, etc.); controls which logos display on checkout.

.tos_checkbox_settings.initial_state / .url / .usage

Terms-of-service checkbox default state, linked document URL, and usage (none/required/optional).

.use_checkout_confirmation_window.usage

Configuration for the order confirmation popup (under construction).

anonymous_checkout_selected

Whether the customer opted to check out anonymously.

auth_token_is_valid

Whether the SSO authorization token is valid.

authentication_is_in_progress / _is_not_successful / _is_successful

Current state of customer authentication.

billing_address

See Shipping / Billing Address above.

cc_cvv2 / cc_cvv2_saved

Card Security Code for new / existing cards.

cc_exp_month / cc_exp_year

Card expiration date.

cc_number / cc_number_masked

Card number, and masked card number.

cc_type

Card type (Visa, MasterCard, Amex, etc).

change_password

Whether the customer opted to change their password.

checkout_date

Checkout date, formatted per locale.

checkout_timestamp

Raw timestamp of checkout.

checkout_type

default_account, default_guest, guest_only, or account_only.

continue_url

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

create_account

Whether the customer chose to create an account.

customer_email

The customer’s email address.

customer_id_encoded

Identifies which customer just logged in.

customer_is_authenticated

Whether the customer is authenticated via SSO.

customer_password

The password entered by the customer.

email_is_checking / _is_found / _is_valid

Status of checking whether the entered email belongs to an existing customer, and whether it’s valid.

fc_auth_token

The SSO authentication token.

fc_customer_id

The SSO passed-in customer ID.

first_receipt_display

Whether the receipt is being displayed for the very first time — useful for gating conversion tracking.

force_password_reset

Whether the customer must reset their password (used a temporary one).

force_saved_account

If the cart has subscriptions, the customer is forced to check out with a named account.

geoip

GeoIP lookup for admin notification emails. Not available in checkout or receipt context.

has_discounts

Whether the cart has coupon discounts.

has_downloadables

Whether the cart has downloadable products.

has_saved_cc

Whether the customer has a saved card.

has_visible_custom_fields

Whether checkout has non-hidden custom fields.

hosted_payment_gateways[].lang_pay_with / .lang_payment_method / .supports_subscriptions / .type

Available hosted payment gateways and their display/behavior info.

html_downloadable_links / text_downloadable_links

Download links for purchased digital products, in HTML / plain text.

ip_address

The customer’s IP address.

is_anonymous

Whether the customer checked out as anonymous.

is_uoe

Whether the customer is logged in via Unified Order Entry.

loading_submit

Whether a loading animation should show near the submit button.

multiship_data[].address_name / .checkout_total_tax / .custom_fields / .has_live_rate_shippable_products / .has_shipping_or_handling_cost / .has_visible_custom_fields / .number / .total_future_shipping / .total_item_price / .total_price / .total_shipping / .total_tax

Per-shipment data for multiship orders.

new_customer_password

New password entered when creating/changing an account.

order_id

The transaction ID of this order.

password_expired

Whether the customer’s temporary password has expired.

payer_id

Used by 3D Secure systems.

payment_is_pending

Whether payment is pending (hosted gateway) — useful for receipt messaging.

payment_method_type

plastic_saved, plastic_new, or the hosted gateway type.

payment_type

plastic, hosted, purchase_order, paypal, or other.

processor_response

The payment gateway response, used on the receipt.

purchase_order

Purchase order value submitted by the customer.

receipt_url

Canonical URL of the transaction receipt.

required_fields

Array of required field names, as configured in the admin.

shipping_and_handling_label

Default label for shipping/handling fees.

show_message_for_testing

Whether to show a testing informational message (triggered via fc_show_info custom field).

status

approved, authorized, declined, pending, or rejected.

subscriptions[].description / .sub_token_url / .html_links / .text_links

Subscription data for this transaction, including the token URL and links for the customer to modify/cancel.

temporary_password_sent

Whether a temporary password was sent to the customer.

timestamp

Used by SSO to limit how long a token is valid.

token

Used by 3D Secure systems.

tos_agreement

State of the terms-of-service checkbox, if used.

use_alternate_shipping_address / use_different_addresses

State of the checkbox for using a different shipping address.

utils.get_error_string / .get_info_string / .shipping_results / .use_different_addresses

Custom Twig macros (also ported to twig.js) for formatting errors, info strings, shipping results, and the alternate-address checkbox.

alert_test_gateway

Used for Foxy test stores.

base_directory

Determines the correct base directory for this store version.

cc_expiration_months / cc_expiration_years

Arrays used for the card expiration select boxes.

has_multiple_payment_options

Whether more than one payment option is enabled for checkout.

lang

Cart language strings, plus additional strings for checkout, email, and receipt contexts.

supports_pay_with_plastic

Whether the store supports paying by debit/credit card.

supports_purchase_order

Whether the store supports paying by purchase order.

days_since_first_failed_transaction

Days since this subscription first failed — used for dunning reminder emails.

is_order

Whether this email is for a normal transaction.

is_expiring_payment_reminder

Whether this email is an expiring-payment-method reminder (dunning).

is_subscription_dunning_cancellation

Whether this email is for a subscription just cancelled via dunning.

is_subscription_dunning_reminder

Whether this email is a past-due subscription reminder (dunning).