> ## 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. # Redemption Configurations > Retrieve point redemption configuration settings for the loyalty program. ## Redemption Configurations This API retrieves the configurations and rules associated with how customers can redeem points for discounts, coupons, or other rewards. **Security:** Requires **apikey** header. ## OpenAPI ````yaml GET /api/v4.0/integrations/configurations/redemption 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/redemption: get: description: >- This API retrieves the configurations and rules associated with how customers can redeem points for discounts, coupons, or other rewards. parameters: - name: customerId in: query description: >- Unique identifier for the customer that you can reference across the customer's whole lifetime. Could be a database ID, random string, email or anything that uniquely identifies the customer. If provided, the API will return redemption configurations that match the customer based on various criteria, such as RFM, tiers, segments and specific customer attributes. This approach ensures that the redemption options are personalized and relevant to each customer's unique profile and engagement history. required: false schema: type: string responses: '200': description: Redemption configurations retrieved successfully content: application/json: schema: type: object properties: redemptionFactor: type: number description: >- This factor indicates the value of each loyalty point in terms of currency, defining how many currency units can be obtained by redeeming points. Example: If the redemptionFactor is set to 0.1, this means that a customer can redeem 10 points for 1 USD. example: 0.1 redemptionRules: type: array description: >- A list of redemption rules that define how points can be redeemed for discounts and coupons. Defines the rules for redeeming points, including points required, value of points, applicable coupons, and eligibility criteria. Example: a redemption rule may allow points to be redeemed for a free product, free shipping, percentage-based discounts, or fixed-amount discounts. items: type: object properties: id: type: number description: The unique identifier for the redemption rule. example: 2138 pointsToRedeem: type: number description: >- The specific number of points needed for redemption. If null, the rule applies to all points. example: 100 valueOfPoint: type: number description: >- The value of a single point in terms of monetary value for redemption. example: 25 ruleType: type: string description: >- The type of rule governing the redemption. Possible values include: free_shipping_settings, percentage_discount_settings, free_product_settings, fixed_rate_settings. example: percentage_discount_settings coupon: type: object description: >- Defines the coupon associated with the redemption rule, if applicable. properties: couponType: type: string description: >- The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom. example: percentage_discount discountValue: type: number description: >- The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount. example: 25 product: type: object description: Product information for free product coupons. properties: productId: type: string description: The unique identifier for the product. productName: type: string description: The name of the product. variantId: type: string description: >- The unique identifier for the product variant. variantName: type: string description: The name of the product variant. productDisplayName: type: string description: >- The display name associated with the product that configured on the dashboard based on required language. collections: type: array description: >- A list of collection IDs that the coupon can be applied to. items: type: object properties: collectionId: type: string description: The unique identifier for the collection. example: '455218036961' collectionName: type: string description: The name for the collection. example: Automated Collection group: type: object description: Coupon group information. properties: handle: type: string description: >- A unique identifier used to reference the coupon group in the system (only appears in the dashboard). title: type: string description: The title of the coupon group. url: type: string description: The URL for the coupon group. iconPath: type: string description: The path to the icon of the coupon group. description: type: string description: A description of the coupon group. maxPerCustomer: type: number 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 format: date-time description: >- The date when the coupons within this coupon group will become active and valid for redemption. expiryDate: type: string 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 description: >- Indicates whether the coupon group is currently available. isActive: type: boolean description: >- Indicates whether the coupon group is currently active. options: type: object description: Coupon options and settings. properties: name: type: string description: >- The name of the redemption rule configured on the dashboard based on required language. example: Redemption Rule Name expiryAfter: type: number 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. example: 14 usageLimit: type: number 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. example: 2 capping: type: number 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. example: 50 minOrderValue: type: number 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. example: 150 codePrefix: type: string 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'. example: SUMMER redeemInstructions: type: string description: >- The instructions on how the customer can redeem the coupon. Example: 'Enter the coupon code at checkout to apply the discount.' example: >- Enter the coupon code at checkout to apply the discount. image: type: string description: >- A URL or file path for an image representing the redemption rule. example: >- https://s3.us-east-2.amazonaws.com/gameball.stg.uploads/uploads%2fClient_2933%2f936f65d8-e06d-4e28-b423-b5282999801bgameball.webp creationDate: type: string format: date-time description: The date when the redemption rule was created. example: '2025-02-10T10:12:16.783408' isActive: type: boolean description: >- Indicates whether the redemption rule is currently active and can be used to generate new coupons or not. true → The rule is active, and new coupons can be created and redeemed. false → The rule is inactive, meaning no new coupons can be generated. However, previously created coupons will still be valid and can be redeemed. Example: If isActive is false, customers cannot create new coupons, but any coupons generated before the rule became inactive can still be used. example: true security: - apiKey: [] components: securitySchemes: bearerAuth: type: http scheme: bearer apiKey: type: apiKey in: header name: apikey ````