Membership Tier

GET 
/client/users/:correlation_id/membership

Request

Returns all information related to membership tiers on the account. If the membership tiers are not set up or are not enabled, then an empty object is returned in the response.

Path Variables

• CorrelationId
  • Unique identifier for the session. Match with existing open session.

Body

This request does not have a body.

Response

The response is a map, the keys of which are the Program Code for the membership program. If there are none, the response will be empty.

Only active, in-flight membership programs that the user is associated with will be returned.

To see the hierarchy, view the sample Response.

Attribute	Description	Format	Note
{{program name}}	Name of the tier program.	String (Client specific)	The key for the object that contains the tier information
programCode	Code for the membership program	String (Client specific)	Repeats the key for the object
tierCode	Name of the tier of the membership program	String
tierName	Display name for current tier	String
tierRank	Rank of their current tier	Number	Optional
nextTier	Contains data about the next tier	Object	Refers to the status of the loyaltyId returned; contains id, rank, and tierName below for the next tier. You can notify users that their top-tier status (PLATINUM) will extend beyond the current period's expiration if they've made qualifying spend contributions during that period, ensuring they retain PLATINUM status into the next period.
id	Tier code for the next tier	String
rank	Rank of the next tier	Number
tierName	Name of the next tier	String
contributions	Prompt Code, contains spend or unit object (if this is used, pointsEarned is not used)	Object	What type of prompt is being returned. Can be empty. Note that pointsEarned may appear instead.
pointsEarned	Points earned for the program (if this is used, contributions is not used)	Object	What type of prompt is being returned. Can be empty. Note that contribution may appear instead.
spend or unit	Spend statistics for the program	Object	Contains total, unused, and next below
total	Total spent or earned or units purchased for the program during the current benefit period	Number	Can be attribute of contribution.spend or contribution.pointsEarned or can pertain to units. Dollars if spent.
next	Amount of progress required to attain the next tier	Number	Can be attribute of contribution.spend or contribution.pointsEarned or can pertain to units.
unused	Amount of progress since the last tier increase	Number	Can be attribute of contribution.spend or contribution.pointsEarned or can pertain to units
businessUnits	List of business units that can interact with this program	String Array
dateRange	Contains effective and expiry dates for tier, if applicable	Object	Optional
effective	Date/time at which the tier becomes effective	String	ISO 8601 format
expiry	Date/time at which the tier expires	String	ISO 8601 format
qualifyingBehaviourTypeLabel	If unit is used in contributions above, then this describes the type/name of the unit	String	For unit contributions only
qualifyingCartSelectorDesc	If unit is used in contributions above, then this describes the cart selector for the unit	String	For unit contributions only
tierContext	Identifies whether tier data applies to individual tier or household tier.	Enum: "INDIVIDUAL" or "HOUSEHOLD"	Only used when Household tier is enabled

Request

Responses

200

200 - Tier Based on Spend

Response Headers

Date
Example: Wed, 20 May 2020 23:50:01 GMT
Content-Length
Example: 290
Connection
Example: keep-alive
x-amzn-RequestId
Example: b1901c1a-1aae-4611-8967-b44020aa7c8a
Referrer-Policy
Example: no-referrer
X-XSS-Protection
Example: 1;mode=block
Access-Control-Allow-Origin
Example: *
Expect-CT
Example: max-age=86400
Strict-Transport-Security
Example: max-age=31536000
Feature-Policy
Example: vibrate 'none'; geolocation 'none'
X-Frame-Options
Example: sameorigin
Content-Security-Policy
Example: connect-src 'none';object-src https://*.cloudfront.net;script-src https://*.cloudfront.net
x-amz-apigw-id
Example: M2tGcFX8IAMFszw=
cache-control
Example: no-cache, no-store, must-revalidate
X-Content-Type-Options
Example: nosniff
X-Amzn-Trace-Id
Example: Root=1-5ec5c229-85b3c6e1065e843b5cf98b62;Sampled=0