Skip to main content
WEBHOOK
customer.payment_failed
{
  "type": "customer.payment_failed",
  "messageId": "a6ce...",
  "traceId": "549a...",
  "timestamp": "2022-08-24T14:11:54.525Z",
  "customer": {
    "entityId": "customer-uuid",
    "id": "customer-test-id",
    "name": "customer-test",
    "email": "john@example.com",
    "billingId": "1111-1234-4223",
    "metadata": {
      "testKey": "example value"
    },
    "excludeFromExperiment": false,
    "experimentInfo": {
      "id": "free-vs-paid-trial",
      "name": "Free vs Paid trial",
      "groupName": "Control group",
      "groupType": "CONTROL"
    },
    "billingCurrency": "ILS"
  },
  "originatingEventId": "evt_3LaJOI...",
  "subscription": {
    "entityId": "59f78766-8eae-463e-8315-9f5da46e1535",
    "id": "subscription-plan-revvenu-essentials-0ecc92",
    "billingId": "sub_1LaJOI...",
    "status": "PAYMENT_PENDING",
    "startDate": "2022-08-24T13:13:06.000Z",
    "currentBillingPeriodStart": "2022-08-24T13:13:06.000Z",
    "currentBillingPeriodEnd": "2023-08-24T13:13:06.000Z",
    "isTrialSubscription": false,
    "metadata": null,
    "plan": {
      "id": "plan-revvenu-essentials",
      "name": "Essentials",
      "description": null,
      "metadata": null
    },
    "addons": []
  },
  "error": {
    "message": "Your card has insufficient funds.",
    "code": "card_declined",
    "details": "insufficient_funds"
  }
}

Body

application/json
​
type
string
Allowed value: "customer.payment_failed"
​
messageId
string
​
traceId
string
​
timestamp
string<date-time>
​
customer
object

Minimal customer object embedded in events.

​
originatingEventId
string
​
subscription
object

Minimal subscription object embedded in events.

​
error
object

Standard error payload used in events.