{
  "opencollection": "1.0.0",
  "info": {
    "name": "Affirm Checkout Authorization Promos API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Promos",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Affirm Get Promotional Messaging",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.affirm.com/api/v1/",
            "params": [
              {
                "name": "amount",
                "value": "1",
                "type": "query",
                "description": "Purchase amount in the smallest currency unit (e.g., cents for USD or CAD). The API uses this to calculate available financing terms and monthly payment messaging."
              },
              {
                "name": "page_type",
                "value": "homepage",
                "type": "query",
                "description": "The type of page on which the promotional messaging will be displayed. Controls which financing messaging template is returned."
              },
              {
                "name": "template_field",
                "value": "en_US",
                "type": "query",
                "description": "Locale identifier controlling the language and currency of the returned promotional content."
              },
              {
                "name": "field",
                "value": "ala",
                "type": "query",
                "description": "Specifies which content fields to include in the response. Use \"ala\" for as-low-as messaging only, \"modal\" for modal content only, or \"all\" for both."
              },
              {
                "name": "use_best_terms",
                "value": "true",
                "type": "query",
                "description": "When true, returns the most favorable available financing terms for the given amount rather than the default program terms."
              },
              {
                "name": "show_cta",
                "value": "true",
                "type": "query",
                "description": "When true, includes a call-to-action element in the modal content response."
              },
              {
                "name": "items",
                "value": "example_value",
                "type": "query",
                "description": "Stringified JSON array of item objects to enable item-level financing evaluation. Each item should include sku, display_name, qty, and unit_price fields."
              }
            ]
          },
          "docs": "Returns dynamic promotional financing messaging and modal content for a given purchase amount. The response includes \"as low as\" (ALA) payment text, APR rates, available installment term offers, and Affirm-hosted modal content for the specified page type and locale. Merchants display this content inline on product, cart, and landing pages to inform customers about available buy now pay later financing options before reaching checkout."
        }
      ]
    }
  ],
  "bundled": true
}