API Reference
Sign In to Dashboard

A recurring charge failed

wbhk
subscription.payment.failed

Sent when a recurring charge fails to settle. payload.data is the
Payment record; see payload.data.failureReason.
payload.entityId is the parent subscription.

Payload

The wrapper delivered for every webhook event. payload.data holds
the event-specific resource — a Subscription or a Payment.

uuid
required

Unique id of this event (UUIDv7). Stable across redeliveries —
delivery is at-least-once and the same id is replayed on retry,
so use it to dedupe.

date-time
required

When the event was produced (ISO-8601 UTC).

uuid
required

The subscription this event concerns. Always the subscription id,
even for payment events — which route to their parent subscription.

int64
required

Monotonically increasing per subscription. Use it to order a
subscription's events and discard stale redeliveries.

payload
object
required

The inner event body. The data property — typed per event family —
carries the affected resource.

Response
2XX

Return any 2xx status to acknowledge receipt. Any other response
(or a timeout) is treated as a delivery failure and retried.

Updated 12 days ago

Did this page help you?
LoadingLoading…

Updated 12 days ago

Did this page help you?