Webhook event

`merchant.restricted`

New orders are switched off for this merchant. Withdrawals to saved addresses still work.

Type: merchant.restricted
The object it carries: the merchant object
Subscribe with: merchant.restricted, merchant.* or *

Example payload

The body of the request your endpoint receives, shown here over several lines. On the wire it is compact JSON; check its signature over the bytes exactly as they arrive.

Example payload

{
  "id": "evt_cjxstjbt1hmqxy0de5fpv2y7",
  "object": "event",
  "livemode": true,
  "created": "2026-09-02T09:15:44.020Z",
  "type": "merchant.restricted",
  "api_version": "2026-10-11",
  "data": {
    "object": {
      "id": "mer_93r9sfyrrm5km287343znd4f",
      "object": "merchant",
      "livemode": true,
      "created": "2026-09-02T09:15:44.020Z",
      "name": "Acme Coffee Roasters",
      "slug": "acme",
      "profile_url": "https://pay.orrerie.com/m/acme",
      "country": "US",
      "business_type": "company",
      "support_email": "help@acme.example",
      "tier": "unverified",
      "restricted": true,
      "settlement": {
        "mode": "convert",
        "asset": "base:usdc"
      },
      "fee_bearer": "payer",
      "default_order_expiry_seconds": 3600,
      "rails": {
        "orrerie_app": true,
        "relay": true,
        "direct": true
      },
      "app_pay_allowed": true,
      "branding": {
        "logo": "file_xn5cz8fk5zmyx3kp37rvddgs",
        "accent_color": null
      },
      "limits": {
        "order_max": {
          "amount": "1000.00",
          "currency": "USD"
        },
        "rolling_30_days_max": {
          "amount": "5000.00",
          "currency": "USD"
        },
        "lifetime_max": {
          "amount": "20000.00",
          "currency": "USD"
        },
        "open_orders_max": 50,
        "outside_payouts_daily_max": {
          "amount": "1000.00",
          "currency": "USD"
        },
        "payout_batch_rows_max": 0,
        "members_max": 2,
        "live_keys_max": 2,
        "webhook_endpoints_max": 1,
        "requests_per_minute": 60
      },
      "usage": {
        "rolling_30_days_paid": {
          "amount": "1284.50",
          "currency": "USD"
        },
        "lifetime_paid": {
          "amount": "1284.50",
          "currency": "USD"
        },
        "open_orders": 3,
        "outside_payouts_today": {
          "amount": "0.00",
          "currency": "USD"
        },
        "members": 2,
        "live_keys": 1,
        "webhook_endpoints": 1
      }
    },
    "previous_attributes": {
      "restricted": false
    }
  },
  "request": {
    "id": null,
    "idempotency_key": null
  },
  "pending_webhooks": 1
}

Fields of data.object

Fields of data.object in merchant.restricted
Field	In this example
`id`	`"mer_93r9sfyrrm5km287343znd4f"`
`object`	`"merchant"`
`livemode`	`true`
`created`	`"2026-09-02T09:15:44.020Z"`
`name`	`"Acme Coffee Roasters"`
`slug`	`"acme"`
`profile_url`	`"https://pay.orrerie.com/m/acme"`
`country`	`"US"`
`business_type`	`"company"`
`support_email`	`"help@acme.example"`
`tier`	`"unverified"`
`restricted`	`true`
`settlement`	An object with `mode`, `asset`
`fee_bearer`	`"payer"`
`default_order_expiry_seconds`	`3600`
`rails`	An object with `orrerie_app`, `relay`, `direct`
`app_pay_allowed`	`true`
`branding`	An object with `logo`, `accent_color`
`limits`	An object with `order_max`, `rolling_30_days_max`, `lifetime_max`, `open_orders_max`, `outside_payouts_daily_max`, `payout_batch_rows_max`, `members_max`, `live_keys_max`, `webhook_endpoints_max`, `requests_per_minute`
`usage`	An object with `rolling_30_days_paid`, `lifetime_paid`, `open_orders`, `outside_payouts_today`, `members`, `live_keys`, `webhook_endpoints`

What each field means is on the page of the merchant object. data.previous_attributes holds the old values of exactly the fields that changed: here restricted.

Endpoints behind it

Calls that change merchant, team and keys. An event is also sent when a payer, the network, a timer or a person in the dashboard causes the change; the sentence above says which.