> ## Documentation Index > Fetch the complete documentation index at: https://docs.gameball.co/llms.txt > Use this file to discover all available pages before exploring further. # Tiers Configurations > Retrieve VIP tier configurations for the loyalty program. ## OpenAPI ````yaml GET /api/v4.0/integrations/configurations/tiers openapi: 3.1.0 info: title: Gameball API description: >- Gameball REST API v4.0 - Complete API reference for integrating loyalty, gamification, and customer engagement features version: 4.0.0 servers: - url: https://api.gameball.co security: - bearerAuth: [] paths: /api/v4.0/integrations/configurations/tiers: get: summary: Tiers Configurations description: >- This API call retrieves the tiers configuration, including the benefits and rewards associated with each tier. operationId: getTiersConfigurations parameters: - name: lang in: header description: >- If the lang header is provided, the response will be returned in the specified language (e.g., en for English, fr for French). If this header is not included, the system will use the default language. required: false schema: type: string responses: '200': description: VIP tiers retrieved successfully content: application/json: schema: type: array items: $ref: '#/components/schemas/TierConfiguration' security: - apiKey: [] components: schemas: TierConfiguration: type: object properties: name: type: string description: The name of the tier. minProgress: type: number description: >- The minimum amount of progress a customer needs to reach this tier in the program. This represents the threshold that must be met for a customer to reach this tier. Example: if the minProgress is set to 2000, the customer must accumulate 2000 points, referrals, or completed orders (depending on the tiering method) to reach this tier. Possible Values: Total amount spent, Total points earned, Friends referred, Orders completed, Score. Example: If the progress value is 1500 and the tiering-up method is total points earned, this means the customer has earned a total of 1500 points toward their next tier. order: type: number description: >- This represents the numerical order of a tier. Higher numbers indicate higher tiers. icon: type: string description: >- The URL for the icon associated with the tier. You can utilize this icon URL to display tier badges or indicators in your own custom interface, such as on customer profiles. benefits: type: array description: >- It contains a list of rewards associated with the tier, each offering specific advantages to the customer. This array includes various types of benefits. items: type: object properties: type: type: string description: >- Indicates the type of benefit the customer will receive. The possible values are: Custom Benefits (Offers tailored and custom rewards to offer customization for specific customer preferences or behaviors), Lifetime Reward (A benefit that can be used once at any time during the customer's lifetime with Gameball, as long as they remain in this tier), Loyalty Points Earning Custom Configuration (Enables customized settings for how customers earn loyalty points based on their spending amount), Entry Reward (A one-time reward granted to customers upon joining this tier). description: type: - string - 'null' description: Description of the custom benefit. hyperLink: type: - string - 'null' description: Hyperlink associated with the custom benefit. rankReward: type: number description: The score rewarded for the customer as a reward. walletReward: type: number description: The number of points the customer will earn for this reward. walletRewardFactor: type: - number - 'null' description: >- This is a multiplier factor that indicates how the customer on their tier will be rewarded for each unit of currency they spend. This is returned for the benefits of type Loyalty Points Earning Custom Configuration. Example: If a tier has a walletRewardFactor of 2, it means any customer on this tier will earn 2 loyalty points for every $1 they spend. Therefore, if the customer spends $100, they would receive 200 loyalty points as a reward. couponReward: type: - object - 'null' description: A coupon object that is awarded to the customer. properties: couponType: type: - string - 'null' description: >- The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom. discountValue: type: - number - 'null' description: >- The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount. product: type: - object - 'null' properties: productId: type: - string - 'null' description: The unique identifier for the product. productName: type: - string - 'null' description: The name of the product. variantId: type: - string - 'null' description: The unique identifier for the product variant. variantName: type: - string - 'null' description: The name of the product variant. productDisplayName: type: - string - 'null' description: >- The display name associated with the product that configured on the dashboard based on required language. collections: type: - array - 'null' description: >- A list of collection IDs that the coupon can be applied to. items: type: object properties: collectionId: type: - string - 'null' description: The unique identifier for the collection. collectionName: type: - string - 'null' description: The name for the collection. group: type: - object - 'null' properties: handle: type: - string - 'null' description: >- A unique identifier used to reference the coupon group in the system. title: type: - string - 'null' description: The title of the coupon group. url: type: - string - 'null' description: The URL for the coupon group. iconPath: type: - string - 'null' description: The path to the icon of the coupon group. description: type: - string - 'null' description: A description of the coupon group. maxPerCustomer: type: - number - 'null' description: >- The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times. startDate: type: - string - 'null' format: date-time description: >- The date when the coupons within this coupon group will become active and valid for redemption. expiryDate: type: - string - 'null' format: date-time description: >- The date when the coupons within this coupon group will expire and no longer be valid for redemption. isAvailable: type: - boolean - 'null' description: >- Indicates whether the coupon group is currently available. isActive: type: - boolean - 'null' description: >- Indicates whether the coupon group is currently active. options: type: - object - 'null' properties: name: type: - string - 'null' description: >- The name of the reward rule configured on the dashboard based on required language. expiryAfter: type: - number - 'null' description: >- The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount. usageLimit: type: - number - 'null' description: >- The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid. capping: type: - number - 'null' description: >- The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher. minOrderValue: type: - number - 'null' description: >- The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount. codePrefix: type: - string - 'null' description: >- The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is "SUMMER", the generated coupon codes might look like "SUMMER12345" or "SUMMERDISCOUNT". redeemInstructions: type: - string - 'null' description: >- The instructions on how the customer can redeem the coupon. Example: "Enter the coupon code at checkout to apply the discount." securitySchemes: bearerAuth: type: http scheme: bearer apiKey: type: apiKey in: header name: apikey ````