Affirm · Schema

Checkout

Represents an Affirm checkout session with full order details, customer information, and current checkout status.

FintechBNPLLendingPaymentsConsumer

Properties

Name Type Description
checkout_id string Unique identifier for this checkout session.
checkout_status string Current status of the checkout session.
checkout_flow_type string The checkout flow type used for this session.
currency string ISO 4217 currency code for the checkout.
total integer Total checkout amount in cents.
shipping_amount integer Shipping cost in cents.
tax_amount integer Tax amount in cents.
order_id string Merchant's internal order identifier.
financial_program_name string Internal financing program identifier applied to this checkout.
financial_program_external_name string Customer-facing financing program name.
billing_frequency string Loan billing frequency for the financing applied.
api_version string Version of the Affirm API used to create this checkout.
product_type string Product category associated with this checkout, if set.
billing object
shipping object
merchant object
metadata object Additional checkout metadata.
meta object Affirm internal tracking information.
View JSON Schema on GitHub

JSON Schema

checkout-checkout-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/affirm/refs/heads/main/json-schema/checkout-checkout-schema.json",
  "title": "Checkout",
  "description": "Represents an Affirm checkout session with full order details, customer information, and current checkout status.",
  "type": "object",
  "properties": {
    "checkout_id": {
      "type": "string",
      "description": "Unique identifier for this checkout session.",
      "example": "500123"
    },
    "checkout_status": {
      "type": "string",
      "description": "Current status of the checkout session.",
      "enum": [
        "pending",
        "confirmed",
        "failed",
        "expired"
      ],
      "example": "pending"
    },
    "checkout_flow_type": {
      "type": "string",
      "description": "The checkout flow type used for this session.",
      "example": "classic"
    },
    "currency": {
      "type": "string",
      "description": "ISO 4217 currency code for the checkout.",
      "example": "USD"
    },
    "total": {
      "type": "integer",
      "description": "Total checkout amount in cents.",
      "example": 1
    },
    "shipping_amount": {
      "type": "integer",
      "description": "Shipping cost in cents.",
      "example": 1
    },
    "tax_amount": {
      "type": "integer",
      "description": "Tax amount in cents.",
      "example": 1
    },
    "order_id": {
      "type": "string",
      "description": "Merchant's internal order identifier.",
      "example": "500123"
    },
    "financial_program_name": {
      "type": "string",
      "description": "Internal financing program identifier applied to this checkout.",
      "example": "Example Merchant"
    },
    "financial_program_external_name": {
      "type": "string",
      "description": "Customer-facing financing program name.",
      "example": "Example Merchant"
    },
    "billing_frequency": {
      "type": "string",
      "description": "Loan billing frequency for the financing applied.",
      "example": "example_value"
    },
    "api_version": {
      "type": "string",
      "description": "Version of the Affirm API used to create this checkout.",
      "example": "example_value"
    },
    "product_type": {
      "type": "string",
      "nullable": true,
      "description": "Product category associated with this checkout, if set.",
      "example": "standard"
    },
    "billing": {
      "$ref": "#/components/schemas/ContactObject"
    },
    "shipping": {
      "$ref": "#/components/schemas/ContactObject"
    },
    "merchant": {
      "$ref": "#/components/schemas/MerchantObject"
    },
    "metadata": {
      "type": "object",
      "description": "Additional checkout metadata.",
      "additionalProperties": {
        "type": "string"
      },
      "example": {}
    },
    "meta": {
      "type": "object",
      "description": "Affirm internal tracking information.",
      "properties": {
        "user_timezone": {
          "type": "string",
          "description": "The user's timezone at time of checkout."
        },
        "tracking_uuid": {
          "type": "string",
          "description": "Internal tracking UUID for this checkout session."
        }
      },
      "example": {
        "user_timezone": "2025-03-15T14:30:00Z",
        "tracking_uuid": "550e8400-e29b-41d4-a716-446655440000"
      }
    }
  }
}