affirm · Schema

Affirm Checkout

Represents an Affirm checkout session containing all order details, customer information, and merchant configuration required to initiate the Affirm buy now pay later financing flow. Checkout objects are created via the Checkout API and result in a checkout token that is exchanged for a transaction authorization after customer confirmation.

Properties

Name Type Description
checkout_id string Unique identifier assigned to this checkout session by Affirm.
checkout_status string Current status of the checkout session.
checkout_flow_type string The checkout flow type used for this session (e.g., classic, direct).
merchant object
shipping object
billing object
store object
items array Array of item objects representing the products being purchased in this checkout.
discounts object Map of discount codes to discount objects applied to this checkout.
metadata object Arbitrary key-value metadata for merchant tracking. All values must be strings.
order_id string The merchant's internal order identifier stored for future reference and reconciliation.
currency string Three-letter ISO 4217 currency code in uppercase.
financing_program string A financing program code applied to this checkout that determines the loan terms presented to the customer.
financial_program_name string Internal financing program identifier applied to this checkout.
financial_program_external_name string Customer-facing financing program name.
shipping_amount integer The total shipping amount in cents.
tax_amount integer The total tax amount in cents.
total integer The total amount of the checkout in the smallest currency unit (cents for USD/CAD, pence for GBP).
checkout_expiration string ISO 8601 timestamp specifying when the checkout session expires.
expiration_time string Time-to-live deadline by which the customer must confirm the checkout.
billing_frequency string Loan billing frequency for the financing applied to this checkout.
api_version string Version of the Affirm API used to create this checkout.
View JSON Schema on GitHub