The information of the membership level that a customer is in.
Returns
invitedSuccess ● UnsignedInt64
Number of customers successfully invited by the customer within the store. This refers to the total successful completions of invitation tasks set by the merchant.
levelCode ● String
The code of current level or paid membership of the customer.
levelExpiryTime ● Date
The expiry time of current level or paid membership of the customer. If the field is empty when membershipType = LEVEL, it means the membership is valid permanently.
levelIcon ● String
The icon of current level or paid membership of the customer.
levelName ● String
The name of current level or paid membership of the customer. Up to 25 characters.
levelOrder ● Int
Relevant only when membershipType = LEVEL. Higher the field indicates a higher level.
levelUpdatedTime ● Date
The start time of current level or paid membership of the customer.
membershipType ● MembershipType
The current active membership mechanism of the store.
rewardAvailable ● Int
Number of available rewards for the customer. Includes membership benefits issued, coupons redeemed through points, etc.
Map
MembershipInfo
Was this article helpful to you?