Webhook event

`payment_link.created`

A link was created.

Type: payment_link.created
The object it carries: the payment_link object
Subscribe with: payment_link.created, payment_link.* 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_db11dwvjtyw38fzpznd9hqqf",
  "object": "event",
  "livemode": true,
  "created": "2026-09-10T10:05:00.000Z",
  "type": "payment_link.created",
  "api_version": "2026-10-11",
  "data": {
    "object": {
      "id": "plink_gg6as78pk82ndt25m36vjeey",
      "object": "payment_link",
      "livemode": true,
      "created": "2026-09-10T10:05:00.000Z",
      "updated": "2026-09-10T10:05:00.000Z",
      "active": true,
      "name": "Ethiopia Yirgacheffe, 1 kg",
      "url": "https://pay.orrerie.com/l/plink_gg6as78pk82ndt25m36vjeey",
      "amount_type": "fixed",
      "amount": "21.99",
      "currency": "USD",
      "min_amount": null,
      "max_amount": null,
      "line_items": [
        {
          "price": "price_mbk5s5r45kwheaq89dbmk2gz",
          "quantity": 1,
          "adjustable_quantity": {
            "enabled": true,
            "minimum": 1,
            "maximum": 10
          }
        }
      ],
      "collect": {
        "email": "required",
        "name": "optional",
        "shipping_address": "hidden"
      },
      "success_url": "https://acme.example/thanks",
      "allow_publishable_key": true,
      "order_expiry_seconds": 3600,
      "max_uses": null,
      "uses": 0,
      "paid_uses": 0,
      "expires_at": null,
      "metadata": {}
    }
  },
  "request": {
    "id": "req_c454pdhvpfr55c7br4jvzqep",
    "idempotency_key": "a3f1c2de-7b0e-4a55-9d0c-2f6f1f0b8e11"
  },
  "pending_webhooks": 1
}

Fields of data.object

Fields of data.object in payment_link.created
Field	In this example
`id`	`"plink_gg6as78pk82ndt25m36vjeey"`
`object`	`"payment_link"`
`livemode`	`true`
`created`	`"2026-09-10T10:05:00.000Z"`
`updated`	`"2026-09-10T10:05:00.000Z"`
`active`	`true`
`name`	`"Ethiopia Yirgacheffe, 1 kg"`
`url`	`"https://pay.orrerie.com/l/plink_gg6as78pk82ndt25m36vjeey"`
`amount_type`	`"fixed"`
`amount`	`"21.99"`
`currency`	`"USD"`
`min_amount`	`null`
`max_amount`	`null`
`line_items`	A list of 1 item
`collect`	An object with `email`, `name`, `shipping_address`
`success_url`	`"https://acme.example/thanks"`
`allow_publishable_key`	`true`
`order_expiry_seconds`	`3600`
`max_uses`	`null`
`uses`	`0`
`paid_uses`	`0`
`expires_at`	`null`
`metadata`	An object with no fields

What each field means is on the page of the payment_link object. This event carries no data.previous_attributes.

Endpoints behind it

Calls that change payment links. 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.