subscription.charge_failed
Sent when a charge attempt fails. nextAttemptAt says when it will be tried again, or is null when this cycle has no more attempts and its status is uncollectible. Needs mandates.read to appear in the events list. Answer with any 2xx within 10 seconds. Anything else, a timeout or a redirect is retried up to 6 times over about a day. Events can arrive out of order, so compare statuses and cycles rather than trusting arrival order.
subscription.charge_failedWebhookWebhook-IdstringrequiredThe event id. The same event can arrive more than once; use this to ignore repeats.
Webhook-TimestampstringrequiredUnix seconds when this attempt was signed. Reject a delivery older than 5 minutes.
Webhook-Signaturestringrequiredv1, then a comma, then the base64 HMAC-SHA256 of "{Webhook-Id}.{Webhook-Timestamp}.{raw body}" keyed with your endpoint's signing secret. Compare in constant time.
application/jsonidstringrequiredThe event id, the same as the Webhook-Id header.
typestringrequiredcreatedAtstring<date-time>requiredWhen the change happened.
dataSubscriptionChargeEventDatarequiredThe charge attempt that failed.
Show propertiesHide properties
idstringrequiredsubscriptionIdstringrequiredsubscriptionReferencestringrequiredcycleintegerrequireddueAtstring<date-time>requiredamountstringrequiredWhat the customer is charged, fee included. A decimal string in major units.
currencystringrequiredattemptintegerrequiredstatusstringrequiredpaidfaileduncollectiblefailureReasonstringnextAttemptAtstring<date-time> | nullrequiredWhen a failed attempt will be tried again. Null when there is no further attempt this cycle.
Received. Any 2xx stops retries.