---
updatedAt: 2025-11-13T14:07:04.000Z
agentTools:
  siteIndex: https://docs.affirm.com/llms.txt
  projectIndex: https://docs.affirm.com/developers/llms.txt
---

# Platform Metadata

Include platform metadata in your Affirm checkout integration to ensure accurate tracking and compatibility. Define platform type, version, and Affirm extension details within the checkout object for seamless platform-specific processing.

## Overview

The following metadata information should be added to Affirm during checkout initialization for any platform integration. These are a hash of keys to values in addition to other metadata information that should be passed in the checkout object.

| Attribute             | Description                             | Example                               |
| :-------------------- | :-------------------------------------- | :------------------------------------ |
| **platform\_type**    | Name of the platform.                   | **"platform\_type":** "Magento".      |
| **platform\_version** | Version number of the platform.         | **"platform\_version":** "2.2.3"      |
| **platform\_affirm**  | Version number of the Affirm extension. | **"platform\_affirm":** "Affirm\_1.0" |

```javascript
affirm.checkout({
    "merchant": {
        .....
      },
      .....
"metadata": {
      "platform_type": "<Channel Name>",
      "platform_version": "<Channel Version>",
      "platform_affirm": "<Channel Extension Version>",
    }
  });
```