Skip to main content

 

Affirm Merchant Help

Metadata object


 "metadata": {
        "shipping_type":        "UPS Ground",
        "entity_name":          "internal-sub_brand-name",
        "platform_type":        "your-platform-name",
        "webhook_session_id":    "A1b2C3"
      },
shipping_type

required string.

Customer contact information.

entity_name

optional string.

Internal sub-brand name.

platform_type

optional string.

Name of your platform Ex: Magento.

webhook_session_id

optional string.

Customer or session specific ID that's used to reconcile incoming webhooks. Optional unless Affirm webhooks are used.

mode

optional string.

Value can be 'modal'. Enables modal checkout. See implementation details and restrictions here.