Subscription payment attempt failure

This event is emitted when an autopay subscription payment fails. This can be due to an insufficient balance or an insufficient allowance.

Payload schema

Webhook payload

Use this schema when validating, storing, or transforming the incoming subscriptionPaymentAttemptFailure webhook payload.

idstring<uuid>required

Unique identifier for this webhook delivery.

webhookIdstring<uuid>required

Identifier of the webhook configuration that produced this delivery.

eventTypestringrequired

Discriminator for the event. Always the value shown here for this event.

AllowedsubscriptionPaymentAttemptFailure

eventDataobjectrequired

Event-specific payload. The key matches eventType.

subscriptionPaymentAttemptFailureSubscriptionPaymentAttemptFailureDatarequired

subscriptionIdstring<uuid>required

failureReasonSubscriptionPaymentAttemptFailureReasonrequired

AllowedinsufficientAllowanceinsufficientBalancegasCostGreaterThanSubscriptionCost

radomDataRadomEventData

Context for the Radom object that triggered the event.

paymentLinkPaymentLinkDatarequired

paymentLinkIdstring<uuid>required

paymentLinkOrderIdstring<uuid>nullable

inputDataInputData[]nullable

labelstringrequired

valuestringnullable

checkoutSessionCheckoutSessionDatarequired

checkoutSessionIdstring<uuid>required

metadataMetadata[]nullable

keystringrequired

valuestringrequired

invoiceInvoiceDatarequired

invoiceIdstring<uuid>required

invoicePaymentIdstring<uuid>nullable

paymentSessionPaymentSessionDatarequired

paymentSessionIdstring<uuid>required

metadataMetadata[]nullable

keystringrequired

valuestringrequired

subscriptionSubscriptionIdDatarequired

subscriptionIdstring<uuid>required

donationLinkDonationLinkDatarequired

donationLinkIdstring<uuid>required

donationLinkOrderIdstring<uuid>required

{
  "id": "8299f078-e7da-42a8-9519-5f1e575d6f08",
  "webhookId": "3b59ac1c-2283-431a-ad78-285d6d1481cd",
  "eventType": "subscriptionPaymentAttemptFailure",
  "eventData": {
    "subscriptionPaymentAttemptFailure": {
      "failureReason": "insufficientBalance",
      "subscriptionId": "60522974-030c-4db3-a8b0-6f54a0440e60"
    }
  },
  "radomData": null
}