payment.succeeded

A payment completed successfully.

stablev1paymentsscope: payments:read

Payload

Webhook deliveries use the common event envelope. The event-specific object is available at data.object.

events/public/payloads/payment.succeeded.v1.schema.jsonevents/public/examples/payment.succeeded.v1.json

data.object fields

Field	Type	Required	Description
`id`	`string \| null`	optional
`object`	`string \| null`	optional
`metadata`	`object \| null`	optional
`owner_type`	`string \| null`	optional	appointment_payment, checkout_payment, invoice_payment, order_payment, subscription_payment, None

dynamic data.object fields

Loading documentation...

Field	Type	Required	Description
`(_id\|^id)$`	`string \| null`	optional
`.*_at$`	`string \| null`	optional	format: date-time

Example

Event body

{
  "api_version": "2026-06-09",
  "created": "2026-06-09T12:00:00Z",
  "data": {
    "object": {
      "event": "payment.succeeded",
      "id": "pay_example",
      "metadata": {
        "example": true
      },
      "object": "payment"
    }
  },
  "environment": "test",
  "id": "wevt_Abcdef1234567890Ghijk",
  "livemode": false,
  "object": "event",
  "type": "payment.succeeded"
}

data.object

{
  "event": "payment.succeeded",
  "id": "pay_example",
  "metadata": {
    "example": true
  },
  "object": "payment"
}