FlintflintDocs

Webhook event types

Flint delivers these events as signed HTTP POSTs to your registered endpoints. Subscribe to specific types when creating an endpoint, or omit enabled_events to receive everything. See the webhooks guide for signature verification and retry behavior.

Balance

balance.updatedThe merchant's available or pending balance changed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "balance_id": {
      "type": "string"
    }
  },
  "required": [
    "balance_id"
  ],
  "type": "object"
}
Example
{
  "balance_id": "bal_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "updated"
}

Balance transaction

balance_transaction.createdA new balance transaction (charge, refund, payout, fee, or adjustment) was recorded.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "balance_transaction_id": {
      "type": "string"
    }
  },
  "required": [
    "balance_transaction_id"
  ],
  "type": "object"
}
Example
{
  "balance_transaction_id": "btxn_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "created"
}
balance_transaction.updatedA balance transaction changed state.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "balance_transaction_id": {
      "type": "string"
    }
  },
  "required": [
    "balance_transaction_id"
  ],
  "type": "object"
}
Example
{
  "balance_transaction_id": "btxn_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "updated"
}

Capability

capability.updatedA merchant capability (such as card payments or payouts) changed status.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "capability": {
      "type": "string"
    }
  },
  "required": [
    "capability"
  ],
  "type": "object"
}
Example
{
  "capability": "card_payments",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "updated"
}

Checkout session

checkout_session.completedA hosted checkout session finished and its payment succeeded.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "checkout_session_id": {
      "type": "string"
    }
  },
  "required": [
    "checkout_session_id"
  ],
  "type": "object"
}
Example
{
  "checkout_session_id": "cs_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "completed"
}
checkout_session.closedA hosted checkout session was closed before payment completed.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "checkout_session_id": {
      "type": "string"
    },
    "expired_at": {
      "format": "date-time",
      "type": "string"
    },
    "invoice_id": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "payment_link_id": {
      "type": "string"
    },
    "reason": {
      "enum": [
        "api"
      ],
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "closed"
      ],
      "type": "string"
    },
    "superseding_checkout_session_id": {
      "type": "string"
    }
  },
  "required": [
    "checkout_session_id",
    "status",
    "reason",
    "resource_updated_at"
  ],
  "type": "object"
}
Example
{
  "checkout_session_id": "cs_123",
  "reason": "api",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "closed"
}
checkout_session.expiredA hosted checkout session expired.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "checkout_session_id": {
      "type": "string"
    },
    "expired_at": {
      "format": "date-time",
      "type": "string"
    },
    "invoice_id": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "payment_link_id": {
      "type": "string"
    },
    "reason": {
      "enum": [
        "expired"
      ],
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "expired"
      ],
      "type": "string"
    },
    "superseding_checkout_session_id": {
      "type": "string"
    }
  },
  "required": [
    "checkout_session_id",
    "status",
    "reason",
    "resource_updated_at"
  ],
  "type": "object"
}
Example
{
  "checkout_session_id": "cs_123",
  "expired_at": "2026-07-03T14:30:00Z",
  "reason": "expired",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "expired"
}
checkout_session.invalidatedA hosted checkout session was invalidated because its source order or payment link changed.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "checkout_session_id": {
      "type": "string"
    },
    "expired_at": {
      "format": "date-time",
      "type": "string"
    },
    "invoice_id": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "payment_link_id": {
      "type": "string"
    },
    "reason": {
      "enum": [
        "order_mutated",
        "payment_link_updated",
        "superseded"
      ],
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "invalidated"
      ],
      "type": "string"
    },
    "superseding_checkout_session_id": {
      "type": "string"
    }
  },
  "required": [
    "checkout_session_id",
    "status",
    "reason",
    "resource_updated_at"
  ],
  "type": "object"
}
Example
{
  "checkout_session_id": "cs_123",
  "order_id": "ord_123",
  "reason": "superseded",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "invalidated",
  "superseding_checkout_session_id": "cs_456"
}

Customer

customer.createdA customer record was created.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "customer_id": {
      "type": "string"
    }
  },
  "required": [
    "customer_id"
  ],
  "type": "object"
}
Example
{
  "customer_id": "cus_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "created"
}
customer.updatedA customer record was updated.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "customer_id": {
      "type": "string"
    }
  },
  "required": [
    "customer_id"
  ],
  "type": "object"
}
Example
{
  "customer_id": "cus_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "updated"
}

Dispute

dispute.closedA dispute was closed without further merchant action.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "dispute_id": {
      "type": "string"
    }
  },
  "required": [
    "dispute_id"
  ],
  "type": "object"
}
Example
{
  "dispute_id": "du_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "closed"
}
dispute.createdA payment dispute was opened.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "dispute_id": {
      "type": "string"
    }
  },
  "required": [
    "dispute_id"
  ],
  "type": "object"
}
Example
{
  "dispute_id": "du_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "created"
}
dispute.lostA dispute was resolved against the merchant.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "dispute_id": {
      "type": "string"
    }
  },
  "required": [
    "dispute_id"
  ],
  "type": "object"
}
Example
{
  "dispute_id": "du_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "lost"
}
dispute.needs_responseA dispute needs a merchant response.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "dispute_id": {
      "type": "string"
    }
  },
  "required": [
    "dispute_id"
  ],
  "type": "object"
}
Example
{
  "dispute_id": "du_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "needs_response"
}
dispute.preventedA dispute warning was resolved before becoming a dispute.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "dispute_id": {
      "type": "string"
    }
  },
  "required": [
    "dispute_id"
  ],
  "type": "object"
}
Example
{
  "dispute_id": "du_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "prevented"
}
dispute.updatedA dispute changed status or details.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "dispute_id": {
      "type": "string"
    }
  },
  "required": [
    "dispute_id"
  ],
  "type": "object"
}
Example
{
  "dispute_id": "du_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "updated"
}
dispute.warning_closedA dispute warning was closed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "dispute_id": {
      "type": "string"
    }
  },
  "required": [
    "dispute_id"
  ],
  "type": "object"
}
Example
{
  "dispute_id": "du_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "warning_closed"
}
dispute.wonA dispute was resolved in favor of the merchant.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "dispute_id": {
      "type": "string"
    }
  },
  "required": [
    "dispute_id"
  ],
  "type": "object"
}
Example
{
  "dispute_id": "du_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "won"
}

Invoice

invoice.collection_block_resolvedAn invoice collection block was resolved and the invoice can be collected again.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "amount_due_money": {
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        }
      },
      "required": [
        "amount",
        "currency"
      ],
      "type": "object"
    },
    "collection_block_reason": {
      "enum": [
        "inventory_restored"
      ],
      "type": "string"
    },
    "collection_block_status": {
      "enum": [
        "resolved"
      ],
      "type": "string"
    },
    "collection_block_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "customer_id": {
      "type": "string"
    },
    "invoice_id": {
      "type": "string"
    },
    "invoice_number": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "refund_status": {
      "enum": [
        "none",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "draft",
        "open",
        "partially_paid",
        "paid",
        "void"
      ],
      "type": "string"
    },
    "subscription_id": {
      "type": "string"
    }
  },
  "required": [
    "invoice_id",
    "status",
    "resource_updated_at",
    "collection_block_status"
  ],
  "type": "object"
}
Example
{
  "amount_due_money": {
    "amount": 5000,
    "currency": "USD"
  },
  "collection_block_reason": "inventory_restored",
  "collection_block_status": "resolved",
  "collection_block_updated_at": "2026-07-03T14:30:00Z",
  "invoice_id": "inv_123",
  "invoice_number": "1001",
  "order_id": "ord_123",
  "refund_status": "none",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "open",
  "subscription_id": "sub_123"
}
invoice.collection_blockedInvoice collection was blocked because a prerequisite such as inventory changed.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "amount_due_money": {
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        }
      },
      "required": [
        "amount",
        "currency"
      ],
      "type": "object"
    },
    "collection_block_reason": {
      "enum": [
        "inventory_unavailable"
      ],
      "type": "string"
    },
    "collection_block_status": {
      "enum": [
        "inventory_blocked"
      ],
      "type": "string"
    },
    "collection_block_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "customer_id": {
      "type": "string"
    },
    "invoice_id": {
      "type": "string"
    },
    "invoice_number": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "refund_status": {
      "enum": [
        "none",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "draft",
        "open",
        "partially_paid",
        "paid",
        "void"
      ],
      "type": "string"
    },
    "subscription_id": {
      "type": "string"
    }
  },
  "required": [
    "invoice_id",
    "status",
    "resource_updated_at",
    "collection_block_status"
  ],
  "type": "object"
}
Example
{
  "amount_due_money": {
    "amount": 5000,
    "currency": "USD"
  },
  "collection_block_reason": "inventory_unavailable",
  "collection_block_status": "inventory_blocked",
  "collection_block_updated_at": "2026-07-03T14:30:00Z",
  "invoice_id": "inv_123",
  "invoice_number": "1001",
  "order_id": "ord_123",
  "refund_status": "none",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "open",
  "subscription_id": "sub_123"
}
invoice.createdAn invoice was created.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "amount_due_money": {
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        }
      },
      "required": [
        "amount",
        "currency"
      ],
      "type": "object"
    },
    "customer_id": {
      "type": "string"
    },
    "invoice_id": {
      "type": "string"
    },
    "invoice_number": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "refund_status": {
      "enum": [
        "none",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "draft",
        "open",
        "partially_paid",
        "paid",
        "void"
      ],
      "type": "string"
    }
  },
  "required": [
    "invoice_id",
    "status",
    "resource_updated_at"
  ],
  "type": "object"
}
Example
{
  "amount_due_money": {
    "amount": 5000,
    "currency": "USD"
  },
  "invoice_id": "inv_123",
  "invoice_number": "1001",
  "order_id": "ord_123",
  "refund_status": "none",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "draft"
}
invoice.delivery_failedAn invoice email could not be delivered.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "invoice_id": {
      "type": "string"
    }
  },
  "required": [
    "invoice_id"
  ],
  "type": "object"
}
Example
{
  "invoice_id": "inv_123",
  "resource_updated_at": "2026-07-03T14:30:00Z"
}
invoice.delivery_succeededAn invoice email was delivered.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "invoice_id": {
      "type": "string"
    }
  },
  "required": [
    "invoice_id"
  ],
  "type": "object"
}
Example
{
  "invoice_id": "inv_123",
  "resource_updated_at": "2026-07-03T14:30:00Z"
}
invoice.manual_payment_recordedA manual (offline) payment was recorded against an invoice.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "invoice_id": {
      "type": "string"
    }
  },
  "required": [
    "invoice_id"
  ],
  "type": "object"
}
Example
{
  "invoice_id": "inv_123",
  "resource_updated_at": "2026-07-03T14:30:00Z"
}
invoice.manual_payment_reversedA previously recorded manual payment was reversed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "invoice_id": {
      "type": "string"
    }
  },
  "required": [
    "invoice_id"
  ],
  "type": "object"
}
Example
{
  "invoice_id": "inv_123",
  "resource_updated_at": "2026-07-03T14:30:00Z"
}
invoice.openedAn invoice became open for collection.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "amount_due_money": {
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        }
      },
      "required": [
        "amount",
        "currency"
      ],
      "type": "object"
    },
    "customer_id": {
      "type": "string"
    },
    "invoice_id": {
      "type": "string"
    },
    "invoice_number": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "refund_status": {
      "enum": [
        "none",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "draft",
        "open",
        "partially_paid",
        "paid",
        "void"
      ],
      "type": "string"
    }
  },
  "required": [
    "invoice_id",
    "status",
    "resource_updated_at"
  ],
  "type": "object"
}
Example
{
  "amount_due_money": {
    "amount": 5000,
    "currency": "USD"
  },
  "invoice_id": "inv_123",
  "invoice_number": "1001",
  "order_id": "ord_123",
  "refund_status": "none",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "open"
}
invoice.paidAn invoice was paid in full.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "invoice_id": {
      "type": "string"
    }
  },
  "required": [
    "invoice_id"
  ],
  "type": "object"
}
Example
{
  "invoice_id": "inv_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "paid"
}
invoice.payment_attempt_canceledAn invoice payment attempt was canceled.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "amount_due_money": {
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        }
      },
      "required": [
        "amount",
        "currency"
      ],
      "type": "object"
    },
    "checkout_session_id": {
      "type": "string"
    },
    "customer_id": {
      "type": "string"
    },
    "invoice_id": {
      "type": "string"
    },
    "invoice_number": {
      "type": "string"
    },
    "invoice_payment_attempt_id": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "payment_attempt_expires_at": {
      "format": "date-time",
      "type": "string"
    },
    "payment_attempt_status": {
      "enum": [
        "canceled"
      ],
      "type": "string"
    },
    "payment_attempt_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "payment_intent_id": {
      "type": "string"
    },
    "payment_rail": {
      "enum": [
        "card",
        "bank_transfer",
        "manual"
      ],
      "type": "string"
    },
    "refund_status": {
      "enum": [
        "none",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "draft",
        "open",
        "partially_paid",
        "paid",
        "void"
      ],
      "type": "string"
    },
    "target_amount_money": {
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        }
      },
      "required": [
        "amount",
        "currency"
      ],
      "type": "object"
    }
  },
  "required": [
    "invoice_id",
    "status",
    "resource_updated_at",
    "invoice_payment_attempt_id",
    "payment_attempt_status",
    "payment_attempt_updated_at"
  ],
  "type": "object"
}
Example
{
  "amount_due_money": {
    "amount": 5000,
    "currency": "USD"
  },
  "checkout_session_id": "cs_123",
  "invoice_id": "inv_123",
  "invoice_number": "1001",
  "invoice_payment_attempt_id": "invpa_123",
  "order_id": "ord_123",
  "payment_attempt_status": "canceled",
  "payment_attempt_updated_at": "2026-07-03T14:30:00Z",
  "payment_rail": "card",
  "refund_status": "none",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "open",
  "target_amount_money": {
    "amount": 5000,
    "currency": "USD"
  }
}
invoice.payment_attempt_expiredAn invoice payment attempt expired.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "amount_due_money": {
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        }
      },
      "required": [
        "amount",
        "currency"
      ],
      "type": "object"
    },
    "checkout_session_id": {
      "type": "string"
    },
    "customer_id": {
      "type": "string"
    },
    "invoice_id": {
      "type": "string"
    },
    "invoice_number": {
      "type": "string"
    },
    "invoice_payment_attempt_id": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "payment_attempt_expires_at": {
      "format": "date-time",
      "type": "string"
    },
    "payment_attempt_status": {
      "enum": [
        "expired"
      ],
      "type": "string"
    },
    "payment_attempt_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "payment_intent_id": {
      "type": "string"
    },
    "payment_rail": {
      "enum": [
        "card",
        "bank_transfer",
        "manual"
      ],
      "type": "string"
    },
    "refund_status": {
      "enum": [
        "none",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "draft",
        "open",
        "partially_paid",
        "paid",
        "void"
      ],
      "type": "string"
    },
    "target_amount_money": {
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        }
      },
      "required": [
        "amount",
        "currency"
      ],
      "type": "object"
    }
  },
  "required": [
    "invoice_id",
    "status",
    "resource_updated_at",
    "invoice_payment_attempt_id",
    "payment_attempt_status",
    "payment_attempt_updated_at"
  ],
  "type": "object"
}
Example
{
  "amount_due_money": {
    "amount": 5000,
    "currency": "USD"
  },
  "invoice_id": "inv_123",
  "invoice_number": "1001",
  "invoice_payment_attempt_id": "invpa_123",
  "order_id": "ord_123",
  "payment_attempt_expires_at": "2026-07-03T14:30:00Z",
  "payment_attempt_status": "expired",
  "payment_attempt_updated_at": "2026-07-03T14:30:00Z",
  "payment_rail": "card",
  "refund_status": "none",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "open",
  "target_amount_money": {
    "amount": 5000,
    "currency": "USD"
  }
}
invoice.payment_failedAn invoice payment attempt failed.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "amount_due_money": {
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        }
      },
      "required": [
        "amount",
        "currency"
      ],
      "type": "object"
    },
    "checkout_session_id": {
      "type": "string"
    },
    "customer_id": {
      "type": "string"
    },
    "failure_code": {
      "enum": [
        "card_declined",
        "insufficient_funds",
        "authentication_required",
        "expired_card",
        "incorrect_cvc",
        "processing_error",
        "payment_method_unavailable",
        "payment_failed"
      ],
      "type": "string"
    },
    "failure_message": {
      "type": "string"
    },
    "invoice_id": {
      "type": "string"
    },
    "invoice_number": {
      "type": "string"
    },
    "invoice_payment_attempt_id": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "payment_attempt_expires_at": {
      "format": "date-time",
      "type": "string"
    },
    "payment_attempt_status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    },
    "payment_attempt_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "payment_intent_id": {
      "type": "string"
    },
    "payment_rail": {
      "enum": [
        "card",
        "bank_transfer",
        "manual"
      ],
      "type": "string"
    },
    "refund_status": {
      "enum": [
        "none",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "draft",
        "open",
        "partially_paid",
        "paid",
        "void"
      ],
      "type": "string"
    },
    "target_amount_money": {
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        }
      },
      "required": [
        "amount",
        "currency"
      ],
      "type": "object"
    }
  },
  "required": [
    "invoice_id",
    "status",
    "resource_updated_at",
    "invoice_payment_attempt_id",
    "payment_attempt_status",
    "payment_attempt_updated_at"
  ],
  "type": "object"
}
Example
{
  "amount_due_money": {
    "amount": 5000,
    "currency": "USD"
  },
  "failure_code": "insufficient_funds",
  "failure_message": "The card has insufficient funds.",
  "invoice_id": "inv_123",
  "invoice_number": "1001",
  "invoice_payment_attempt_id": "invpa_123",
  "order_id": "ord_123",
  "payment_attempt_status": "failed",
  "payment_attempt_updated_at": "2026-07-03T14:30:00Z",
  "payment_intent_id": "pi_123",
  "payment_rail": "card",
  "refund_status": "none",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "open",
  "target_amount_money": {
    "amount": 5000,
    "currency": "USD"
  }
}
invoice.partially_paidAn invoice received a partial payment.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "invoice_id": {
      "type": "string"
    }
  },
  "required": [
    "invoice_id"
  ],
  "type": "object"
}
Example
{
  "invoice_id": "inv_123",
  "resource_updated_at": "2026-07-03T14:30:00Z"
}
invoice.partially_refundedPart of an invoice's payment was refunded.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "invoice_id": {
      "type": "string"
    }
  },
  "required": [
    "invoice_id"
  ],
  "type": "object"
}
Example
{
  "invoice_id": "inv_123",
  "resource_updated_at": "2026-07-03T14:30:00Z"
}
invoice.refundedAn invoice's payment was fully refunded.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "invoice_id": {
      "type": "string"
    }
  },
  "required": [
    "invoice_id"
  ],
  "type": "object"
}
Example
{
  "invoice_id": "inv_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "refunded"
}
invoice.sentAn invoice was sent to the customer.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "invoice_id": {
      "type": "string"
    }
  },
  "required": [
    "invoice_id"
  ],
  "type": "object"
}
Example
{
  "invoice_id": "inv_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "sent"
}
invoice.updatedAn invoice draft or scheduled send time was updated.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "amount_due_money": {
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "integer"
        },
        "currency": {
          "type": "string"
        }
      },
      "required": [
        "amount",
        "currency"
      ],
      "type": "object"
    },
    "customer_id": {
      "type": "string"
    },
    "invoice_id": {
      "type": "string"
    },
    "invoice_number": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "refund_status": {
      "enum": [
        "none",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "draft",
        "open",
        "partially_paid",
        "paid",
        "void"
      ],
      "type": "string"
    }
  },
  "required": [
    "invoice_id",
    "status",
    "resource_updated_at"
  ],
  "type": "object"
}
Example
{
  "amount_due_money": {
    "amount": 5000,
    "currency": "USD"
  },
  "invoice_id": "inv_123",
  "invoice_number": "1001",
  "order_id": "ord_123",
  "refund_status": "none",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "draft"
}
invoice.voidedAn invoice was voided and can no longer be paid.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "invoice_id": {
      "type": "string"
    }
  },
  "required": [
    "invoice_id"
  ],
  "type": "object"
}
Example
{
  "invoice_id": "inv_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "void"
}

Merchant

merchant.readiness.updatedA merchant's live payment, payout, or onboarding requirement readiness changed.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "business_name": {
      "type": "string"
    },
    "merchant_id": {
      "type": "string"
    },
    "observed_at": {
      "format": "date-time",
      "type": "string"
    },
    "payments": {
      "additionalProperties": false,
      "properties": {
        "next_actions": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "action_type": {
                "enum": [
                  "create_account_session"
                ],
                "type": "string"
              },
              "expires_at": {
                "format": "date-time",
                "type": "string"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "action_type"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "status": {
          "enum": [
            "ready",
            "blocked",
            "pending",
            "not_available"
          ],
          "type": "string"
        },
        "status_reason": {
          "enum": [
            "requirements_due",
            "requirements_past_due",
            "pending_verification",
            "disabled_by_platform_policy",
            "service_unavailable"
          ],
          "nullable": true,
          "type": "string"
        }
      },
      "required": [
        "status",
        "status_reason",
        "next_actions"
      ],
      "type": "object"
    },
    "payouts": {
      "additionalProperties": false,
      "properties": {
        "next_actions": {
          "items": {
            "additionalProperties": false,
            "properties": {
              "action_type": {
                "enum": [
                  "create_account_session"
                ],
                "type": "string"
              },
              "expires_at": {
                "format": "date-time",
                "type": "string"
              },
              "url": {
                "type": "string"
              }
            },
            "required": [
              "action_type"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "status": {
          "enum": [
            "ready",
            "blocked",
            "pending",
            "not_available"
          ],
          "type": "string"
        },
        "status_reason": {
          "enum": [
            "requirements_due",
            "requirements_past_due",
            "pending_verification",
            "disabled_by_platform_policy",
            "service_unavailable"
          ],
          "nullable": true,
          "type": "string"
        }
      },
      "required": [
        "status",
        "status_reason",
        "next_actions"
      ],
      "type": "object"
    },
    "requirements": {
      "additionalProperties": false,
      "properties": {
        "current_deadline_at": {
          "format": "date-time",
          "nullable": true,
          "type": "string"
        },
        "currently_due": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "disabled_reason": {
          "enum": [
            "account_attention_required",
            "account_paused",
            "account_rejected",
            "account_requirements_due",
            "account_under_review",
            "requirements_past_due",
            "requirements_pending_verification"
          ],
          "nullable": true,
          "type": "string"
        },
        "eventually_due": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "past_due": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "pending_verification": {
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "currently_due",
        "past_due",
        "eventually_due",
        "pending_verification",
        "disabled_reason"
      ],
      "type": "object"
    }
  },
  "required": [
    "merchant_id",
    "payments",
    "payouts",
    "requirements",
    "observed_at"
  ],
  "type": "object"
}
Example
{
  "business_name": "Test Shop",
  "merchant_id": "mer_123",
  "observed_at": "2026-07-03T14:30:00Z",
  "payments": {
    "next_actions": [],
    "status": "ready",
    "status_reason": null
  },
  "payouts": {
    "next_actions": [
      {
        "action_type": "create_account_session"
      }
    ],
    "status": "blocked",
    "status_reason": "requirements_due"
  },
  "requirements": {
    "current_deadline_at": "2026-07-03T14:30:00Z",
    "currently_due": [
      "business_website"
    ],
    "disabled_reason": null,
    "eventually_due": [],
    "past_due": [],
    "pending_verification": []
  }
}

Order

order.closedAn order was closed before being fully paid.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "customer_id": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "order_number": {
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "open",
        "closed",
        "paid",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    }
  },
  "required": [
    "order_id",
    "status",
    "resource_updated_at"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "order_number": "1001",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "closed"
}
order.createdAn order was created.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "customer_id": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "order_number": {
      "type": "string"
    },
    "origin": {
      "enum": [
        "virtual_terminal",
        "payment_link",
        "checkout",
        "api",
        "in_person",
        "subscription"
      ],
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "open",
        "closed",
        "paid",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    }
  },
  "required": [
    "order_id",
    "status",
    "resource_updated_at",
    "origin"
  ],
  "type": "object"
}
Example
{
  "customer_id": "cus_123",
  "order_id": "ord_123",
  "order_number": "1001",
  "origin": "api",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "open"
}
order.fulfillment.event.createdA fulfillment event was recorded from a carrier, pickup flow, appointment system, or other fulfillment source.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "order_id": {
      "type": "string"
    }
  },
  "required": [
    "order_id"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "created"
}
order.fulfillment.package.createdA shipment package was created.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "order_id": {
      "type": "string"
    }
  },
  "required": [
    "order_id"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "created"
}
order.fulfillment.package.updatedA shipment package status changed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "order_id": {
      "type": "string"
    }
  },
  "required": [
    "order_id"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "updated"
}
order.fulfillment.shipment.createdA shipment was created.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "order_id": {
      "type": "string"
    }
  },
  "required": [
    "order_id"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "created"
}
order.fulfillment.shipment.updatedA shipment status changed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "order_id": {
      "type": "string"
    }
  },
  "required": [
    "order_id"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "updated"
}
order.fulfillment.status_changedA fulfillment moved between pending, completed, and canceled.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "order_id": {
      "type": "string"
    }
  },
  "required": [
    "order_id"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "resource_updated_at": "2026-07-03T14:30:00Z"
}
order.inventory_exception.createdAn order payment succeeded but inventory could not be fully deducted.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "customer_id": {
      "type": "string"
    },
    "inventory_exception_reason": {
      "enum": [
        "inventory_deduction_failed",
        "auto_refund_required",
        "auto_refund_failed",
        "policy_resolution_failed"
      ],
      "type": "string"
    },
    "inventory_exception_status": {
      "enum": [
        "paid_inventory_failed"
      ],
      "type": "string"
    },
    "inventory_exception_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "order_number": {
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "open",
        "closed",
        "paid",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    }
  },
  "required": [
    "order_id",
    "status",
    "resource_updated_at",
    "inventory_exception_status",
    "inventory_exception_updated_at"
  ],
  "type": "object"
}
Example
{
  "inventory_exception_reason": "inventory_deduction_failed",
  "inventory_exception_status": "paid_inventory_failed",
  "inventory_exception_updated_at": "2026-07-03T14:30:00Z",
  "order_id": "ord_123",
  "order_number": "1001",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "paid"
}
order.inventory_exception.resolvedAn order inventory exception was resolved.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "customer_id": {
      "type": "string"
    },
    "inventory_exception_reason": {
      "enum": [
        "order_fully_refunded",
        "resolved_by_admin"
      ],
      "type": "string"
    },
    "inventory_exception_status": {
      "enum": [
        "resolved"
      ],
      "type": "string"
    },
    "inventory_exception_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "order_number": {
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "open",
        "closed",
        "paid",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    }
  },
  "required": [
    "order_id",
    "status",
    "resource_updated_at",
    "inventory_exception_status",
    "inventory_exception_updated_at"
  ],
  "type": "object"
}
Example
{
  "inventory_exception_reason": "resolved_by_admin",
  "inventory_exception_status": "resolved",
  "inventory_exception_updated_at": "2026-07-03T14:30:00Z",
  "order_id": "ord_123",
  "order_number": "1001",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "paid"
}
order.payment_authorization_expiredAn authorization on an order expired before capture.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "order_id": {
      "type": "string"
    }
  },
  "required": [
    "order_id"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "resource_updated_at": "2026-07-03T14:30:00Z"
}
order.payment_authorization_voidedAn authorization on an order was voided.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "order_id": {
      "type": "string"
    }
  },
  "required": [
    "order_id"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "resource_updated_at": "2026-07-03T14:30:00Z"
}
order.payment_authorizedA payment on an order was authorized and is awaiting capture.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "order_id": {
      "type": "string"
    }
  },
  "required": [
    "order_id"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "resource_updated_at": "2026-07-03T14:30:00Z"
}
order.payment_capturedAn authorized payment on an order was captured.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "order_id": {
      "type": "string"
    }
  },
  "required": [
    "order_id"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "resource_updated_at": "2026-07-03T14:30:00Z"
}
order.payment_succeededA payment on an order succeeded.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "order_id": {
      "type": "string"
    }
  },
  "required": [
    "order_id"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "paid"
}
order.reconciliation_exception.createdAn order needs reconciliation because a reversal could not be allocated automatically.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "customer_id": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "order_number": {
      "type": "string"
    },
    "reconciliation_exception_reason": {
      "enum": [
        "dispute_allocation_unmappable"
      ],
      "type": "string"
    },
    "reconciliation_exception_status": {
      "enum": [
        "reversal_allocation_failed"
      ],
      "type": "string"
    },
    "reconciliation_exception_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "open",
        "closed",
        "paid",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    }
  },
  "required": [
    "order_id",
    "status",
    "resource_updated_at",
    "reconciliation_exception_status",
    "reconciliation_exception_updated_at"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "order_number": "1001",
  "reconciliation_exception_reason": "dispute_allocation_unmappable",
  "reconciliation_exception_status": "reversal_allocation_failed",
  "reconciliation_exception_updated_at": "2026-07-03T14:30:00Z",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "paid"
}
order.refundedAn order received a full or partial refund.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "order_id": {
      "type": "string"
    }
  },
  "required": [
    "order_id"
  ],
  "type": "object"
}
Example
{
  "order_id": "ord_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "refunded"
}
order.updatedAn order was updated.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "customer_id": {
      "type": "string"
    },
    "order_id": {
      "type": "string"
    },
    "order_number": {
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "open",
        "closed",
        "paid",
        "partially_refunded",
        "refunded"
      ],
      "type": "string"
    }
  },
  "required": [
    "order_id",
    "status",
    "resource_updated_at"
  ],
  "type": "object"
}
Example
{
  "customer_id": "cus_123",
  "order_id": "ord_123",
  "order_number": "1001",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "open"
}

Payment intent

payment_intent.canceledA payment intent was canceled.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payment_intent_id": {
      "type": "string"
    }
  },
  "required": [
    "payment_intent_id"
  ],
  "type": "object"
}
Example
{
  "payment_intent_id": "pi_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "canceled"
}
payment_intent.payment_failedA payment attempt failed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payment_intent_id": {
      "type": "string"
    }
  },
  "required": [
    "payment_intent_id"
  ],
  "type": "object"
}
Example
{
  "payment_intent_id": "pi_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "failed"
}
payment_intent.requires_actionThe payment requires a customer action such as 3D Secure authentication.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payment_intent_id": {
      "type": "string"
    }
  },
  "required": [
    "payment_intent_id"
  ],
  "type": "object"
}
Example
{
  "payment_intent_id": "pi_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "requires_action"
}
payment_intent.requires_captureThe payment was authorized and is awaiting capture.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payment_intent_id": {
      "type": "string"
    }
  },
  "required": [
    "payment_intent_id"
  ],
  "type": "object"
}
Example
{
  "payment_intent_id": "pi_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "requires_capture"
}
payment_intent.succeededA payment intent succeeded.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payment_intent_id": {
      "type": "string"
    }
  },
  "required": [
    "payment_intent_id"
  ],
  "type": "object"
}
Example
{
  "payment_intent_id": "pi_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "paid"
}

Payment method

payment_method.failedSaving a payment method failed.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "customer_id": {
      "type": "string"
    },
    "failure_code": {
      "enum": [
        "card_declined",
        "insufficient_funds",
        "authentication_required",
        "expired_card",
        "incorrect_cvc",
        "processing_error",
        "payment_method_unavailable",
        "payment_failed"
      ],
      "type": "string"
    },
    "failure_message": {
      "type": "string"
    },
    "payment_method_id": {
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "payment_method_id",
    "status",
    "resource_updated_at"
  ],
  "type": "object"
}
Example
{
  "customer_id": "cus_123",
  "failure_code": "insufficient_funds",
  "failure_message": "The card has insufficient funds.",
  "payment_method_id": "pm_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "failed"
}
payment_method.removedA saved payment method was removed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payment_method_id": {
      "type": "string"
    }
  },
  "required": [
    "payment_method_id"
  ],
  "type": "object"
}
Example
{
  "payment_method_id": "pm_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "removed"
}
payment_method.savedA payment method was saved to a customer.
Payload
Schema
{
  "additionalProperties": false,
  "properties": {
    "card_brand": {
      "enum": [
        "visa",
        "mastercard",
        "amex",
        "discover",
        "diners",
        "jcb",
        "unionpay"
      ],
      "type": "string"
    },
    "card_exp_month": {
      "maximum": 12,
      "minimum": 1,
      "type": "integer"
    },
    "card_exp_year": {
      "type": "integer"
    },
    "card_last4": {
      "type": "string"
    },
    "card_wallet": {
      "enum": [
        "apple_pay",
        "google_pay"
      ],
      "type": "string"
    },
    "customer_id": {
      "type": "string"
    },
    "payment_method_id": {
      "type": "string"
    },
    "resource_updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "active"
      ],
      "type": "string"
    }
  },
  "required": [
    "payment_method_id",
    "status",
    "resource_updated_at"
  ],
  "type": "object"
}
Example
{
  "card_brand": "visa",
  "card_exp_month": 12,
  "card_exp_year": 2030,
  "card_last4": "4242",
  "card_wallet": "apple_pay",
  "customer_id": "cus_123",
  "payment_method_id": "pm_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "active"
}

Payout

payout.canceledA payout to the merchant's bank was canceled.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payout_id": {
      "type": "string"
    }
  },
  "required": [
    "payout_id"
  ],
  "type": "object"
}
Example
{
  "payout_id": "po_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "canceled"
}
payout.createdA payout to the merchant's bank was created.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payout_id": {
      "type": "string"
    }
  },
  "required": [
    "payout_id"
  ],
  "type": "object"
}
Example
{
  "payout_id": "po_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "created"
}
payout.failedA payout failed and funds were returned to the balance.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payout_id": {
      "type": "string"
    }
  },
  "required": [
    "payout_id"
  ],
  "type": "object"
}
Example
{
  "payout_id": "po_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "failed"
}
payout.paidA payout arrived at the merchant's bank.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payout_id": {
      "type": "string"
    }
  },
  "required": [
    "payout_id"
  ],
  "type": "object"
}
Example
{
  "payout_id": "po_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "paid"
}
payout.reversedA completed payout was reversed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payout_id": {
      "type": "string"
    }
  },
  "required": [
    "payout_id"
  ],
  "type": "object"
}
Example
{
  "payout_id": "po_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "reversed"
}
payout.updatedA payout changed state.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payout_id": {
      "type": "string"
    }
  },
  "required": [
    "payout_id"
  ],
  "type": "object"
}
Example
{
  "payout_id": "po_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "updated"
}

Payout destination

payout_destination.createdA payout destination (bank account) was added.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payout_destination_id": {
      "type": "string"
    }
  },
  "required": [
    "payout_destination_id"
  ],
  "type": "object"
}
Example
{
  "payout_destination_id": "pdest_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "created"
}
payout_destination.deletedA payout destination was removed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payout_destination_id": {
      "type": "string"
    }
  },
  "required": [
    "payout_destination_id"
  ],
  "type": "object"
}
Example
{
  "payout_destination_id": "pdest_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "deleted"
}
payout_destination.disabledA payout destination was disabled.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payout_destination_id": {
      "type": "string"
    }
  },
  "required": [
    "payout_destination_id"
  ],
  "type": "object"
}
Example
{
  "payout_destination_id": "pdest_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "disabled"
}
payout_destination.updatedA payout destination was updated.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payout_destination_id": {
      "type": "string"
    }
  },
  "required": [
    "payout_destination_id"
  ],
  "type": "object"
}
Example
{
  "payout_destination_id": "pdest_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "updated"
}

Payout destination session

payout_destination_session.completedA hosted payout-destination setup session completed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payout_destination_session_id": {
      "type": "string"
    }
  },
  "required": [
    "payout_destination_session_id"
  ],
  "type": "object"
}
Example
{
  "payout_destination_session_id": "pdests_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "completed"
}
payout_destination_session.updatedA hosted payout-destination setup session changed state.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payout_destination_session_id": {
      "type": "string"
    }
  },
  "required": [
    "payout_destination_session_id"
  ],
  "type": "object"
}
Example
{
  "payout_destination_session_id": "pdests_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "updated"
}

Payout settings

payout_settings.updatedThe merchant's payout schedule or settings changed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "payout_settings_id": {
      "type": "string"
    }
  },
  "required": [
    "payout_settings_id"
  ],
  "type": "object"
}
Example
{
  "payout_settings_id": "pset_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "updated"
}

Refund

refund.createdA refund was created.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "refund_id": {
      "type": "string"
    }
  },
  "required": [
    "refund_id"
  ],
  "type": "object"
}
Example
{
  "refund_id": "ref_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "created"
}
refund.failedA refund failed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "refund_id": {
      "type": "string"
    }
  },
  "required": [
    "refund_id"
  ],
  "type": "object"
}
Example
{
  "refund_id": "ref_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "failed"
}
refund.updatedA refund changed state.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "refund_id": {
      "type": "string"
    }
  },
  "required": [
    "refund_id"
  ],
  "type": "object"
}
Example
{
  "refund_id": "ref_123",
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "updated"
}

Subscription

subscription.activatedA subscription became active.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "subscription_id": {
      "type": "string"
    }
  },
  "required": [
    "subscription_id"
  ],
  "type": "object"
}
Example
{
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "active",
  "subscription_id": "sub_123"
}
subscription.canceledA subscription was canceled.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "subscription_id": {
      "type": "string"
    }
  },
  "required": [
    "subscription_id"
  ],
  "type": "object"
}
Example
{
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "canceled",
  "subscription_id": "sub_123"
}
subscription.createdA subscription was created.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "subscription_id": {
      "type": "string"
    }
  },
  "required": [
    "subscription_id"
  ],
  "type": "object"
}
Example
{
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "created",
  "subscription_id": "sub_123"
}
subscription.past_dueA subscription renewal failed and is past due.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "subscription_id": {
      "type": "string"
    }
  },
  "required": [
    "subscription_id"
  ],
  "type": "object"
}
Example
{
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "past_due",
  "subscription_id": "sub_123"
}
subscription.pausedA subscription was paused.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "subscription_id": {
      "type": "string"
    }
  },
  "required": [
    "subscription_id"
  ],
  "type": "object"
}
Example
{
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "paused",
  "subscription_id": "sub_123"
}
subscription.payment_failedA subscription billing attempt failed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "subscription_id": {
      "type": "string"
    }
  },
  "required": [
    "subscription_id"
  ],
  "type": "object"
}
Example
{
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "failed",
  "subscription_id": "sub_123"
}
subscription.payment_succeededA subscription billing attempt succeeded.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "subscription_id": {
      "type": "string"
    }
  },
  "required": [
    "subscription_id"
  ],
  "type": "object"
}
Example
{
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "paid",
  "subscription_id": "sub_123"
}
subscription.resumedA paused subscription was resumed.
Payload
Schema
{
  "additionalProperties": true,
  "properties": {
    "subscription_id": {
      "type": "string"
    }
  },
  "required": [
    "subscription_id"
  ],
  "type": "object"
}
Example
{
  "resource_updated_at": "2026-07-03T14:30:00Z",
  "status": "active",
  "subscription_id": "sub_123"
}
Rate this doc