checkout.terminally_failed - Soap

checkout.terminally_failed is off by default. It will not be delivered until you enable it in Dashboard → Developers. See Receiving Webhooks for instructions.

Payload Structure

interface WebhookEvent {
  event_id: string;
  data: {
    id: string; // id of the checkout you originally created
    terminally_failed_at: string;
    type: "deposit" | "withdrawal";
    customer: {
      id: string;
    };
    subscription: {
      id: string;
      interval: "day" | "week" | "month" | "year";
      interval_count: number;
      line_items: Array<{
        product_id: string;
        sku: string;
        product_name: string;
        product_url: string;
        quantity: number;
        price_cents: number;
        total_amount_cents: number;
      }>;
      line_items_total_amount_cents: number | null;
    } | null; // null for non-subscription checkouts
  };
  type: "checkout.terminally_failed";
}

Example Payload

{
  "event_id": "ev_tDaWu5aTVa2kbvDjGe55rxZpaMEmVFWB",
  "data": {
    "id": "chk_9K1sgX9tUa5Lx5AgpK32xJgXDenrBbsk",
    "terminally_failed_at": "2025-05-30 06:05:22 UTC",
    "type": "deposit",
    "customer": {
      "id": "cus_LSAPLYCWD9uohSMm2pxRPB7xW3V4esMA"
    },
    "subscription": null
  },
  "type": "checkout.terminally_failed"
}

terminally_failed_at is a Ruby-formatted timestamp string ("2025-05-30 06:05:22 UTC"), not ISO 8601. Other webhook events, such as checkout.review.created, use ISO 8601 ("2026-04-08T14:30:00Z") for their timestamps. Handle both formats if you write a shared date parser across webhook events.

The terminally_failed_at timestamp indicates when the checkout session failed terminally, and the type field specifies whether it was a deposit or withdrawal attempt. Unlike temporarycheckout.failed events, terminal failures indicate that the session can no longer be continued.