Customer membership level information.
Fields
levelCode ● String
The code of the customer's current membership level.
Maximum length: 25
levelName ● String
The name of the customer's current membership level.
Maximum length: 25
membershipType ● MembershipType
The membership type of the customer's current level.
More
levelOrder ● Int
Level sequence number. The larger the level_order, the higher the level and the later the sequence.
levelIcon ● String
The icon of the level.
upgradeStandard ● UpgradeStandard
The standard type of system-triggered upgrade when customers meet the upgrade criteria by purchasing regular products (including gift cards). Threshold type for the level when membershipType = BASIC or DUAL.
More
levelThreshold ● UnsignedInt64
The spending threshold amount required for a customer to upgrade their membership level via purchases. This field is only valid when membershipType is BASIC or DUAL. The value of this field is the amount in the store currency, multiplied by 100.
For example, if the threshold amount required for the upgrade is $10.00, the field value is 1000.
lockinStandard ● LockinStandard
The retention criterion type applicable to consumers who upgrade their membership via spending, when the merchant configures membership retention rules. Only valid when membershipType = BASIC or DUAL.
More
lockinRule ● UnsignedInt64
The specific amount the customer needs to spend to meet retention conditions after the merchant configures retention rules. Valid only when membershipType = BASIC or DUAL.
paidPrice ● [LevelSkuInfo]
The paid price required for upgrading when the upgrade method is consumption-based. Valid when membership_type = PAID or DUAL.
More
paidExpiryDateType ● PaidExpiryDateType
The time type of the paid membership validity period.
More
paidExpiryDateValue ● Int
Time value of the paid membership validity.
upgradePaidPriceSpu ● UpgradePaidPriceSpu
The price range required for an upgradeable membership level is only valid if the paid membership item associated with that level is a multi-item product. Customers at the membership tier corresponding to upgrade_level_code upgrade by paying the upgrade_paid_price. Only valid when membership_type = BASIC or DUAL. and paid_upgrade_standard = CUSTOMISED.
More
upgradePaidPriceSku ● [UpgradePaidPriceSku]
The price required for an upgradeable membership level is only valid if the paid membership item for that level has only a single product style. Customers at the membership tier corresponding to upgrade_level_code upgrade by paying the upgrade_paid_price. Only valid when membership_type = BASIC or DUAL. and paid_upgrade_standard = CUSTOMISED.
More
paidUpgradeStandard ● PaidUpgradeStandard
The criterion type followed by the system for membership level upgrade when a customer purchases a membership via payment. Only valid when membershipType = BASIC or DUAL.
More
Map
MemberLevel
Was this article helpful to you?