Skip to main content

Subscription payment reminder​

This event is emitted when a subscription has an upcoming payment. This event can be used to notify customers that a subscription payment is due to be charged.

id
string<uuid>
webhookId
string<uuid>
eventType
string
Allowed value:
subscriptionPaymentReminder
eventData
object
subscriptionPaymentReminder
object
subscriptionId
string<uuid>
required
subscriptionType
required
automatedEVMSubscription
object
required
buyerAddress
string
required
subscriptionContractAddress
string
required
recommendedAllowanceDuration
integer<int64> or null
>= 0
emailAddress
string or null
network
string
required
Allowed values:
BitcoinBitcoinTestnetLitecoinLitecoinTestnetCardanoMoneroDashDogecoinSolanaSolanaTestnetSolanaDevnetEthereumSepoliaTestnetPolygonPolygonTestnetBNBBNBTestnetArbitrumArbitrumTestnetZcashZcashTestnetPolkadotPolkadotTestnetPolkadotAssetHubPolkadotAssetHubTestnetTronTronTestnetAvalancheAvalancheTestnetBaseBaseTestnetOptimismOptimismTestnetFiat
token
string or null
amount
number<float>
required
>= 0
currency
string
required
Allowed values:
USDCADGBPEURAEDINRSEKBRLNZDAUDHKDNOKDKKJPYCNYCHFSGDPLNMXNCZKHUFZARSARRUBTRYILSUSDCUSDTBTCETHBNBSOLTRXAVAXMATIC
period
string
required
Allowed values:
dailyweeklymonthlyquarterlyannuallycustom
periodCustomDuration
integer<int64> or null
createdAt
string<date-time>
required
tags
object or null
productId
string<uuid> or null
name
string or null
imageUrl
string or null
radomData
allOf
paymentLink
object
required
paymentLinkId
string<uuid>
required
paymentLinkOrderId
string<uuid> or null
inputData
array[object] or null
label
string
required
value
string or null
radomData
paymentLink
object
required

{
  "id": "41e5d9d3-1843-42b7-b993-3f8e290b344e",
  "webhookId": "3b59ac1c-2283-491a-ae78-285d6d1481cd",
  "eventType": "subscriptionExpired",
  "eventData": {
    "subscriptionExpired": {
      "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",
      "tags": {
        "productId": "ff20f359-f170-4b88-b59c-9ef4c7aa097b"
      }
    }
  },
  "radomData": null
}