--- title: "Read Checkout" method: GET path: "/checkout/{checkout_id}" tags: ["Checkout"] --- # Read Checkout `GET /checkout/{checkout_id}` ## Request - Base URL: `https://sandbox.affirm.com/api/v2` - URL: `https://sandbox.affirm.com/api/v2/checkout/{checkout_id}` - Auth: HTTP basic Returns the checkout details. ## Path parameters - `checkout_id` string, required ## Response `200` HTTP 200 OK - ReadCheckout - `billing_frequency` string: The billing frequency for the loan. - `currency` string: The local currency of the charge with its being a valid subset of the ISO 4217 currency code. - `meta` object: Additional checkout metadata. - `release` string: The release of the funds. - `user_timezone` string: The user's timezone. - `_affirm_tracking_uuid` string: A uuid used for Affirm tracking. - `total` integer: The total amount of the checkout, less any discounts applied. This determines the total amount charged to the user. All numerical values must be passed as integer USD cents. - `financial_program_external_name` string: The external name of the financing program. - `financial_program_name` string: The name of the financing program. - `checkout_flow_type` string: The type of checkout flow used by the customer. - `billing` object: The customer billing information. - `name` object - `full` unknown - `last` string: The last name of the customer. - `first` string: The first name of the customer. - `phone_number` string, nullable: The phone number of the customer. It must be a valid U.S. phone number represented as a 10-digit string without any delimiters. - `email` string, nullable: The email address of the customer. - `shipping_amount` integer: The amount to ship the item. - `config` string: Needs description - `product_type` string, nullable: The type of product for the purchase - `api_version` string: The version of the API - `metadata` object: Metadata containing any additional data. - `checkout_channel_type` string: The type of channel for the checkout. - `mode` string: The type of mode for the checkout. - `merchant` object: A list of items specific to the merchant. - `public_api_key` string: The merchant's public api key. - `user_cancel_url` string: On customer cancellation redirect them to this merchant URL. - `user_confirmation_url` string: On customer confirmation redirect them to this merchant URL. - `user_confirmation_url_action` string: Supported values -'GET' -'POST' - `name` string: If you have multiple sites operating under a single Affirm account, you can override the external company/brand name that the customer sees. This affects all references to your company name in the Affirm UI. - `use_vcn` boolean: A flag to enable virtual card integration (default is 'false'). - `product` string: The Affirm product. - `order_id` string: Your internal order id. This is stored for your own reference. - `suppress_expiration_declination_messaging` boolean: Determines if the expiration declination messaging is surpressed. - `mfp_rule_input_data` object: An item object containing data for multiple finance programs. - `items` object: An array of items based on the cart contents - `sku_number` object: The unique identifier (SKU) of the product. - `sku` integer: The unique identifier (SKU) of the product. - `item_url` string: The item's product description page URL. - `display_name` string: The display name of the product. - `unit_price` integer: The item individual price. - `qty` integer: The item quantity expressed as an integer. - `item_type` string: The type of product in the cart. - `item_image_url` string: The item's product image URL. - `total` integer: The total amount of the checkout, less any discounts applied. This determines the total amount charged to the user. All numerical values must be passed as integer USD cents. - `metadata` object: Metadata containing any additional data. - `checkout_channel_type` string: The type of channel for the checkout. - `mode` string: The type of mode for the checkout. - `financing_program` string: A unique financing program name that is provided to you by Affirm. If you have a custom financing program available, you can enter the name of it in this field. - `loan_type` string: The type of loan selected. - `chekcout_type` string: The type of checkout selected. - `tax_amount` integer: The total tax amount computed after all discounts have been applied. Defaults to 0. - `checkout_status` string: The status of the checkout. - `shipping` object: The shipping information. Required for scenarios where goods are shipped. - `name` object - `full` string: The customer's name. - `first` string: The customer's first name. - `last` string: The customer's last name. - `address` object - `city` string: The name of the city. - `country` string: The abbreviated name of the country. - `line1` string: A U.S. street address. - `line2` string: The apartment number, floor or suite that complements the street address. - `state` string: The 2-letter postal abbreviation or full name of the U.S. state. - `zipcode` string: The 5-digit postal code of the address. - `email` string, nullable: The email address of the customer. - `phone_number` string, nullable: The phone number of the customer. It must be a valid U.S. phone number represented as a 10-digit string without any delimiters. - `use_adaptive` boolean: Determines if the product is using Adaptive Checkout - `financing_program` string: The applicable Affirm financing program - `merchant_external_reference` string: A unique identifier that can be used to link to a merchant's internal systems, (ie - cart ID or order ID). ## Other responses - `400`: HTTP 400 Bad Request - `401`: HTTP 401 Unauthorized - `404`: HTTP 404 Not Found --- [API](https://skmtc.dev/affirm/apis/checkout-api.md) - [All operations](https://skmtc.dev/affirm/apis/checkout-api/llms.txt) - [OpenAPI document](https://skmtc.dev/affirm/apis/checkout-api/revisions/6f74c90a66df?raw)