online_checkout merchant_settings updatedBeta

EVENT

online_checkout.merchant_settings.updated

Published when online checkout merchant settings are updated

Permissions:MERCHANT_PROFILE_WRITE, MERCHANT_PROFILE_READ

Link to section

Event payload

Example code

Link to section

merchant_id

string

The ID of the target merchant associated with the event.

Link to section

type

string

The type of event this represents, "online_checkout.merchant_settings.updated".

Link to section

event_id

string

A unique ID for the event.

Link to section

created_at

string

Read only RFC 3339 timestamp of when the event was created.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Link to section

data

Data associated with the event.

Link to section

Examples

Response JSON

{
  "merchant_id": "MLX0WMXAER48M",
  "type": "online_checkout.merchant_settings.updated",
  "event_id": "8bfc6b46-b274-376f-b5e7-0575827f6f29",
  "created_at": "2023-11-09T18:04:58.856036784Z",
  "data": {
    "type": "merchant_settings",
    "id": "MLX0WMXAER48M",
    "object": {
      "merchant_settings": {
        "payment_methods": {
          "afterpay_clearpay": {
            "available": true,
            "enabled": true,
            "item_eligibility_range": {
              "max": {
                "amount": 200000,
                "currency": "USD"
              },
              "min": {
                "amount": 200,
                "currency": "USD"
              }
            },
            "order_eligibility_range": {
              "max": {
                "amount": 200000,
                "currency": "USD"
              },
              "min": {
                "amount": 100,
                "currency": "USD"
              }
            }
          },
          "apple_pay": {
            "available": true,
            "enabled": false
          },
          "cash_app": {
            "available": true,
            "enabled": true
          },
          "google_pay": {
            "available": true,
            "enabled": true
          }
        },
        "updated_at": "2023-11-09 18:04:58 +0000 UTC"
      }
    }
  }
}