Kick.Subscription

A new subscription.

• Platform: kick
• Shape: sub
• Source event: Kick.Subscription

Usage

Widget.on("Kick.Subscription", (event) => {
  // event.user, event.platform…
});

Fields

• user (string): Display name; «Anonymous» for anonymous gifts.
• userId (string): User id on its platform.
• userLogin (string): Login, lowercase.
• tier (1 | 2 | 3): Subscription tier.
• prime (boolean): Whether it is a Prime sub.
• months (number): Always 1 for a new sub.

It also carries platform (the source platform) and raw (the original payload).

Example

The example payload that reaches the Studio simulator:

{
  "duration": 3,
  "expiresAt": "string",
  "isTest": false,
  "subscribedAt": "string",
  "user": {
    "id": "00000001000001001",
    "isSubscribed": true,
    "login": "string",
    "name": "string",
    "profilePicture": "string",
    "role": 2
  }
}