Skip to main content

Loyalty Levels Model

A loyalty level represents a progression tier with its own threshold, benefits, and accumulation behavior.

Core operations​

ActionMethodResource
ListGET/loyalty_levels
FindGET/loyalty_levels/{loyalty_level_id}
CreatePOST/loyalty_levels
UpdatePOST/loyalty_levels/{loyalty_level_id}
DeleteDELETE/loyalty_levels/{loyalty_level_id}

The detail read and all mutations require administrator authentication.

Representative fields​

Core fields include id, name, description, benefits, minimum_points, accumulation_rate, maximum_accumulation_percentage, maximum_accumulation_fixed, expire_after_minutes, image, created_at, and updated_at.

minimum_points marks the threshold for the level, while accumulation_rate and the maximum accumulation fields control earning behavior. The meaning of maximum accumulation may vary by operation; check the field description before using it.

See Create a loyalty level and List loyalty levels.

Schema properties​

Schema: LoyaltyLevel

NameTypeDescription
accumulation_ratenumber | null—
benefitsobject | array | null—
created_atstring | null—
descriptionany—
expire_after_minutesany—
idinteger | null—
imageany—
maximum_accumulation_fixednumber | null—
maximum_accumulation_percentagenumber | null—
minimum_pointsinteger | null—
nameany—
updated_atstring | null—