Loyalty API

Enum

MembershipStatus1

Customer loyalty membership status.

Exact membership rules are configured separately for each loyalty program. Ask your Bubblehouse representative to confirm what each level means for your program, especially before hiding or enabling customer actions based on this field.

In general, this value describes the current eligibility for loyalty-member behavior for the selected customer, or for an empty customer when the response is for a logged-out visitor. It should be interpreted together with program_enabled: when the program is disabled for the evaluated customer, membership is reported as none.

Kind Enum type
Used in CustomerBalance3, LoggedOutBalance1, Status2

Values

  • none

    The customer is not a loyalty program member.

    This can be returned for deleted customers, customers who opted out or have not met required opt-in rules, and customers whose loyalty program access is disabled by shop tags, email rules, or similar program configuration. Logged-out visitors can also receive this status when an empty customer is not eligible under program enablement rules.

    Usually, these customers can only use public or logged-out loyalty experiences. They normally should not be allowed to earn points, spend points, redeem rewards, enter tiers, use member-only achievements, or perform other loyalty actions that require a customer membership.

  • guest

    The customer has partial loyalty access but is not a full member.

    This commonly represents an identified customer who has not completed all requirements for full membership, such as activating their shop account or explicitly opting in when the program requires it. Logged-out visitors can also receive this status when an empty customer has partial access under those same rules.

    Usually, these customers may be shown a personalized loyalty experience and may be allowed to perform actions configured for guest access. Full member benefits, point redemptions, tiers, and member-only rewards often remain unavailable until the customer becomes full.

  • full

    The customer is a full loyalty program member.

    This usually means the customer has satisfied the program's membership requirements and is eligible for the normal loyalty experience. Logged-out visitors are also reported this way when an empty customer is eligible for the normal loyalty experience.

    Authenticated full members are normally allowed to earn and spend points, redeem rewards, participate in tiers, complete member-only actions, and use other configured loyalty features, subject to the program's ordinary limits, fraud rules, reward availability, and any feature-specific eligibility requirements. Logged-out visitors may be shown the normal loyalty experience, but actions tied to an account still require identifying or authenticating the customer.

Previous
LimitPeriod1