CustomerSubscriptionStatus3

Describes how long the customer been subscribed, and which milestone benefits they are receiving.

Properties

activebooleanrequired
Whether the customer has at least one active subscription.
The specific definition of active varies depending on the shop's configuration and the configuration of the subscription integration.
cycleintegerrequired
The number of cycles the customer has been subscribed for, as used by Bubblehouse to determine a milestone.
The specific way multiple subscriptions are combined to produce a cycle count varies depending on the shop's configuration. Often, this is the length of the longest-running subscription.
cur_milestoneMilestoneStatus3required but can be null
Describes the milestone corresponding to the current number of cycles. Null if no milestone is defined for the current cycle.
next_milestoneMilestoneStatus3required but can be null
Describes the next milestone that can be reached after the current subscription cycles. Null if there are no further milestones to reach.