RevenueHogdocs
Reference

Event types and badges

Every event badge RevenueHog shows in the feed, timelines and push alerts, its color and money effect, and which Apple notifications and events map to it.

Every subscription event in RevenueHog gets one badge. The same classification drives the live feed, customer timelines and push alerts. Badges are drawn in capitals, 48 pixels wide.

Badges

BadgeMeaningColorMoney
BUYOne-time purchase, or a new or renewed-again subscriptionGreen+
RENEWSubscription renewalGreen+
TRIALFree trial startedCyan$0.00
CONVTrial converted to paidGreen+
CHURNAuto-renew turned off, expired or revokedRedShown as a loss, not subtracted
RFNDRefundAmber−
RFRQRefund requested (consumption request)Orange$0.00
RREVRefund reversed, money backGreen+
RDECRefund declined, revenue keptGreen$0.00
PLANPlan change queued (upgrade, downgrade, crossgrade)Blue$0.00
PRICPrice increase (pending consent or accepted)Amber$0.00
RISKBilling failed: in billing retry or grace periodRed$0.00
VERSApp Store version state change (approved, rejected, live) from App Store Connect webhooksViolet$0.00

Two badges replace the kind's label in special cases:

BadgeWhen
FAMILYA BUY that is a Family Sharing copy. Shown in blue because it is someone else's sale.
CANCELA CHURN while the customer was still in a free trial. Stays red.

Only BUY, RENEW, CONV and RREV add money, and RFND subtracts it. The other kinds are informational; any revenue effect arrives with a later renewal or the daily report, so counting them would double-count.

Apple server notifications

notificationTypeSubtype or conditionBadge
SUBSCRIBEDTransaction is a free trialTRIAL
SUBSCRIBEDOtherwiseBUY
ONE_TIME_CHARGEBUY
OFFER_REDEEMEDUPGRADE or DOWNGRADERENEW
OFFER_REDEEMEDOtherwiseBUY
DID_RENEWFirst renewal after a trial or short introCONV
DID_RENEWOtherwiseRENEW
EXPIRED, GRACE_PERIOD_EXPIRED, REVOKECHURN
DID_CHANGE_RENEWAL_STATUSAUTO_RENEW_DISABLEDCHURN
DID_CHANGE_RENEWAL_STATUSAUTO_RENEW_ENABLEDNot shown
REFUNDRFND
REFUND_REVERSEDRREV
REFUND_DECLINEDRDEC
CONSUMPTION_REQUESTDeduplicated to one row per transactionRFRQ
DID_CHANGE_RENEWAL_PREFPLAN
PRICE_INCREASEPENDING or ACCEPTEDPRIC
DID_FAIL_TO_RENEWIncluding GRACE_PERIODRISK
Anything else (TEST, RENEWAL_EXTENDED, EXTERNAL_PURCHASE_TOKEN, and future types)Not shown

A conversion is detected from the renewal alone: when the first period (original purchase to this purchase) is shorter than half of the current billing term.

Apple subscription report events

Daily report events are stored as snake-cased versions of Apple's event names.

Stored event typeApple eventBadgeCounted as
subscribeSubscribeBUYNew customer
reactivate, reactivate_with_upgradeReactivateBUY
start_introductory_offerStart Introductory Offer (free and paid intros)BUYTrial start, new customer
trial_startSubscribe with a free-trial offerTRIALTrial start, new customer
renew, renewal_from_billing_retryRenewRENEW
trial_convert, paid_subscription_from_introductory_offer, upgrade_from_introductory_offerPaid Subscription from Introductory OfferCONVTrial conversion
cancel, expire, canceled_from_billing_retryCancel, ExpireCHURNChurn
refundRefundRFND
billing_retry_from_introductory_offer, billing_retry_from_paid_subscriptionBilling retryNot shownChurn risk, not churn

Offer labels

Event details label the offer a transaction used: Introductory offer, Promotional offer, Offer code or Win-back offer.

Last updated on

On this page