affirm · Schema
CheckoutRequest
Request body for creating or updating an Affirm checkout session, containing all order and customer information required to initiate the Affirm financing flow.
Properties
| Name | Type | Description |
|---|---|---|
| merchant | object | |
| shipping | object | |
| billing | object | |
| store | object | |
| items | array | Array of item objects representing the products being purchased in this checkout. |
| discounts | object | A map of discount codes to discount objects. Each key is the discount code and each value contains the discount amount and name. |
| metadata | object | Arbitrary key-value metadata for merchant tracking. 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. Supported values are USD, CAD, and GBP. |
| financing_program | string | Financing program code to apply to this checkout, if applicable. Determines the available loan terms presented to the customer. |
| 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 cents (USD, CAD) or pence (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. |