Skip to main content

user.subscription

Generated from spec/protocol.yaml. Do not edit by hand.

Overview

  • ID: 954
  • Header: USER_SUBSCRIPTION
  • Direction: Server to Client (s2c)
  • Realm: Subscription & Offers
  • Phase: session
  • Since: nitro-1.6.6
  • Summary: Deliver Pixels Club subscription state

Payload fields

FieldTypeRequiredDescription
productNamestringrequiredClub product identifier, e.g. "club_habbo"
daysToPeriodEndint32requiredDays remaining in the current subscription period
memberPeriodsint32requiredNumber of complete subscription periods the user has held
periodsSubscribedAheadint32requiredNumber of future periods already paid for
responseTypeint32requiredTrigger code: 1 = login refresh, 2 = new purchase, 3 = discount available, 4 = citizenship discount
hasEverBeenMemberbooleanrequiredWhether the user has ever held a Club subscription
isVipbooleanrequiredWhether the user currently has a VIP subscription
pastClubDaysint32requiredTotal days the user has been a Club member historically
pastVipDaysint32requiredTotal days the user has been a VIP member historically
minutesUntilExpirationint32requiredMinutes until the current subscription period expires
minutesSinceLastModifiedint32optionalMinutes since the subscription record was last modified; only present when bytes remain in the payload

Behavior

Sender

Sent during the post-authentication burst and after a subscription purchase or renewal. The responseType field indicates the trigger: login refresh, new purchase, or discount offer. The optional minutesSinceLastModified field is only present when the server has additional modification timestamp data.

Receiver

The client updates the Club badge, expiry countdown, and VIP indicators. responseType may trigger a purchase-success animation when set to 2.

Notes

  • No additional notes