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

# The Metadata Object

## Attributes

<Table align={["left","left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Attribute
      </th>

      <th style={{ textAlign: "left" }}>
        Data type
      </th>

      <th style={{ textAlign: "left" }}>
        Description
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        **shipping\_type** 
      </td>

      <td style={{ textAlign: "left" }}>
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Customer contact information.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **entity\_name** 
      </td>

      <td style={{ textAlign: "left" }}>
        *string* 
      </td>

      <td style={{ textAlign: "left" }}>
        Internal sub-brand name.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **platform\_type** 
      </td>

      <td style={{ textAlign: "left" }}>
        *string* 
      </td>

      <td style={{ textAlign: "left" }}>
        Name of the platform the merchant is on (e.g Shopify, etc.).
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **platform\_version**
      </td>

      <td style={{ textAlign: "left" }}>
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Version of the platform the merchant is on.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **platform\_affirm**
      </td>

      <td style={{ textAlign: "left" }}>
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Version of the Affirm module or extension being used to integrate with the platform.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **webhook\_session\_id** 
      </td>

      <td style={{ textAlign: "left" }}>
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Customer or session specific ID that's used to reconcile incoming webhooks. Optional unless Affirm webhooks are used.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **mode** 
      </td>

      <td style={{ textAlign: "left" }}>
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        Set to modal to enable the modal checkout flow (default uses redirect checkout flow). Possible values:  

        * modal  
        * redirect\
          For more [details](https://docs.affirm.com/developers/docs/modal-vs-redirect-checkout).
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **customer**
      </td>

      <td style={{ textAlign: "left" }}>
        *object*
      </td>

      <td style={{ textAlign: "left" }}>
        A customer object containing additional information.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **itinerary** 
      </td>

      <td style={{ textAlign: "left" }}>
        *array*
      </td>

      <td style={{ textAlign: "left" }}>
        An array of itinerary item. Each itinerary contained within this array will define a portion of a trip. For instance, in a roundtrip booking, each flight should be defined in its own.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **checkout\_channel\_type**
      </td>

      <td style={{ textAlign: "left" }}>
        *string*
      </td>

      <td style={{ textAlign: "left" }}>
        This is a checkout channel type.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **BOPIS**
      </td>

      <td style={{ textAlign: "left" }}>
        *boolean*
      </td>

      <td style={{ textAlign: "left" }}>
        Indicates whether or not the checkout includes a BOPIS order.
      </td>
    </tr>
  </tbody>
</Table>

```json
{ 
  "shipping_type":"UPS ground",
  "entity_name":"affirm-x",
  "platform_type":"shopify",
  "webhook_session_id":"1234-4321-2324-1233",
  "mode":"modal",
  "checkout_channel_type":""
}
```

# Sibling pages

* [The Merchant Object](https://docs.affirm.com/developers/reference/the-merchant-object.md)
* [The Discount Object](https://docs.affirm.com/developers/reference/the-discount-object.md)
* [The Store Object](https://docs.affirm.com/developers/reference/the-store-object.md)
* [The Item Object](https://docs.affirm.com/developers/reference/the-item-object.md)
* [The Itinerary Object](https://docs.affirm.com/developers/reference/the-itinerary-object.md)
* [Shipping & Billing Objects](https://docs.affirm.com/developers/reference/shipping-billing-object.md)
* [Name Object](https://docs.affirm.com/developers/reference/name.md)
* [Address Object](https://docs.affirm.com/developers/reference/address.md)