New subscription

This event is emitted when a new subscription is created.

Payload schema

Webhook payload

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

AllowednewSubscription

eventDataobjectrequired

Event-specific payload. The key matches eventType.

newSubscriptionNewSubscriptionWebhookDatarequired

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

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": "f01fa77a-6f71-45fd-884e-4212ec76e9e9",
  "webhookId": "ad474121-b97e-479b-a180-60a21bda8532",
  "eventType": "newSubscription",
  "eventData": {
    "newSubscription": {
      "subscriptionId": "2b6081ce-51ca-4699-b3b3-dedc3aacdfe3",
      "subscriptionType": {
        "automatedEVMSubscription": {
          "buyerAddress": "0x850f184effee1f86472c056b777126bd063e4cd0",
          "subscriptionContractAddress": "0x87Fcf739aEe21FAb3b99121fA4f2D7bF243f9F15",
          "recommendedAllowanceDuration": null
        }
      },
      "network": "SepoliaTestnet",
      "token": "0x5D684d37922dAf7Aa2013E65A22880a11C475e25",
      "amount": "9.9900",
      "currency": "USD",
      "period": "monthly",
      "periodCustomDuration": null,
      "createdAt": "2023-06-12T23:54:51.445529Z",
      "tags": {
        "productId": "ad84d39a-dcc3-442f-9cbb-7e8e0be29a03"
      }
    }
  },
  "radomData": {
    "checkoutSession": {
      "checkoutSessionId": "109d5abf-1f8b-460f-9dd8-3c1486b8feba"
    }
  }
}