> ## 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.

# Coupon Configurations

> Retrieve coupon system configuration settings for the loyalty program.

## Coupon Configurations

This API call retrieves your coupon configurations, including details about how coupons are structured, authenticated, and mapped within Gameball.

<Info>
  **Security:** Provide both apikey and secretkey headers.
</Info>


## OpenAPI

````yaml GET /api/v4.0/integrations/configurations/coupon
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/coupon:
    get:
      description: >-
        This API call retrieves your coupon configurations, including details
        about how coupons are structured, authenticated, and mapped within
        Gameball.
      responses:
        '200':
          description: Coupon configurations retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    description: The URL where the coupon configuration is applied.
                    example: https://api.mywebsite.com/coupons
                  method:
                    type: string
                    description: >-
                      The HTTP method used for the coupon configuration process
                      (e.g., POST, PUT or GET).
                    example: POST
                  queryParams:
                    type: array
                    description: List of query parameters used in the request.
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          description: The key used in the query parameter.
                          example: appId
                        value:
                          type: string
                          description: The value of the query parameter.
                          example: '12345'
                  headers:
                    type: array
                    description: List of headers used in the request.
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          description: The header key.
                          example: Authorization
                        value:
                          type: string
                          description: The header value.
                          example: Bearer token
                  payload:
                    type: string
                    description: The request payload format or template.
                    example: '{ "couponCode": "DISCOUNT10" }'
                  couponMapping:
                    type: object
                    description: >-
                      A dictionary mapping coupon types to specific keys in your
                      system.
                    properties:
                      fixed:
                        type: string
                        description: >-
                          The internal naming for the fixed discount codes in
                          your system.
                        example: fixed_discount
                      percentage:
                        type: string
                        description: >-
                          The internal naming for the percentage discount codes
                          in your system.
                        example: percentage_discount
                      freeProduct:
                        type: string
                        description: >-
                          The internal naming for the free product discount
                          codes in your system.
                        example: free_product
                      freeShipping:
                        type: string
                        description: >-
                          The internal naming for the free shipping discount
                          codes in your system.
                        example: free_delivery
                  enableFreeProduct:
                    type: boolean
                    description: Indicates whether free product coupons are enabled.
                    example: true
                  enableFixedRate:
                    type: boolean
                    description: Indicates whether fixed-rate discount coupons are enabled.
                    example: true
                  enableFreeShipping:
                    type: boolean
                    description: Indicates whether free shipping coupons are enabled.
                    example: true
                  enablePercentage:
                    type: boolean
                    description: >-
                      Indicates whether percentage-based discount coupons are
                      enabled.
                    example: true
                  platforms:
                    type: array
                    description: >-
                      List of platforms for which the coupon configurations are
                      applied.
                    items:
                      type: object
                      properties:
                        displayName:
                          type: string
                          description: The display name of the platform.
                        value:
                          type: string
                          description: The internal value used for the platform.
      security:
        - apiKey: []
          secretKey: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKey:
      type: apiKey
      in: header
      name: apikey
    secretKey:
      type: apiKey
      in: header
      name: secretkey

````