Skip to main content

Subscription cancelled

This event is emitted when a subscription is cancelled by the merchant or the customer.

Payload schema

Webhook payload

Use this schema when validating, storing, or transforming the incoming subscriptionCancelled 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.

AllowedsubscriptionCancelled
eventDataobjectrequired

Event-specific payload. The key matches eventType.

subscriptionCancelledSubscriptionCancelledWebhookDatarequired
subscriptionIdstring<uuid>required
subscriptionTypeSubscriptionTyperequired
automatedEVMSubscriptionAutomatedEVMSubscriptionrequired
buyerAddressstringrequired
subscriptionContractAddressstringrequired
recommendedAllowanceDurationinteger<int64>nullable>= 0
emailAddressstringnullable
emailInvoiceSubscriptionEmailInvoiceSubscriptionrequired
emailAddressstringrequired
networkNetworkrequired
AllowedBitcoinBitcoinTestnetLitecoinLitecoinTestnetDogecoinDogecoinTestnetBitcoinCashBitcoinCashTestnetBitcoinSVBitcoinSVTestnetHarryPotterObamaSonic10InuHarryPotterObamaSonic10InuTestnetCardanoDashSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiat
tokenstringnullable
amountnumber<float>required>= 0
currencyCurrencyrequired
AllowedUSDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTEURCBTCTEST0ETHBNBSOLTRXAVAXMATIC
periodManagedSubscriptionPeriodrequired
Alloweddailyweeklymonthlyquarterlyannuallycustom
periodCustomDurationinteger<int64>nullable
createdAtstring<date-time>required
cancelledAtstring<date-time>required
tagsSubscriptionTagsnullable
productIdstring<uuid>nullable
namestringnullable
imageUrlstringnullable
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": "41e5d9d3-1843-42b7-b993-3f8e290b344e",
  "webhookId": "3b59ac1c-2283-491a-ae78-285d6d1481cd",
  "eventType": "subscriptionCancelled",
  "eventData": {
    "subscriptionCancelled": {
      "subscriptionId": "56786d4e-a994-4392-952a-a648a0d2870a",
      "subscriptionType": {
        "automatedEVMSubscription": {
          "buyerAddress": "0x850f184effee1f86472c056b777126bd063e4cd0",
          "subscriptionContractAddress": "0x87Fcf739aEe21FAb3b99121fA4f2D7bF243f9F15",
          "recommendedAllowanceDuration": null
        }
      },
      "network": "SepoliaTestnet",
      "token": "0x5D684d37922dAf7Aa2013E65A22880a11C475e25",
      "amount": "99.99",
      "currency": "USD",
      "period": "annually",
      "periodCustomDuration": null,
      "createdAt": "2023-06-12T09:38:13.604410Z",
      "cancelledAt": "2023-06-12T09:38:40.116346295Z",
      "tags": {
        "productId": "ff20f359-f170-4b88-b59c-9ef4c7aa097b"
      }
    }
  },
  "radomData": null
}