Skip to main content

Subscription Expired

  • Alert key: fourthwall-subscriptionExpired
  • Source: Fourthwall
  • Event list label: Subscription Ended

Default message template

{{username}} subscription ended

Template variables

Use any of these in alert text, TTS, or chat templates. The same names appear under data.extraSettings.* when you subscribe via Overlay.on('alert').

Template variableOverlay payload fieldDescription
{{username}}data.extraSettings.usernameThe username of the sender
{{email}}data.extraSettings.emailEmail of user
{{currency}}data.extraSettings.currencyThe currency used
{{amount}}data.extraSettings.amountThe amount sent
{{interval}}data.extraSettings.intervalThe interval of the alert, such as monthly, yearly, etc.
{{id}}data.extraSettings.idNo description available yet.
{{subscriptionType}}data.extraSettings.subscriptionTypeNo description available yet.
{{tierId}}data.extraSettings.tierIdNo description available yet.
{{variantId}}data.extraSettings.variantIdNo description available yet.
{{createdAt}}data.extraSettings.createdAtNo description available yet.
{{raw}}data.extraSettings.rawThe raw data that comes in through the platform for the alert. This is useful for custom code when data is needed that we don't provide by default.

Example payloads

Each scenario below mirrors what Lumia emits in Overlay.on('alert', (data) => …).

Ended

{
"alert": "fourthwall-subscriptionExpired",
"dynamic": {
"value": 100,
"currency": "USD"
},
"extraSettings": {
"username": "lumiastream",
"amount": 100,
"currency": "USD",
"interval": "MONTHLY",
"subscriptionType": "CANCELLED",
"email": "",
"id": "",
"tierId": "",
"variantId": "",
"createdAt": "",
"raw": ""
}
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_CURRENCY_NUMBER - Donation Amount is equal to
  • GREATER_CURRENCY_NUMBER - Donation Amount is greater than or equal to
  • EQUAL_VARIABLE