---
title: "GET /api/v4.0/integrations/configurations/coupon"
method: GET
path: "/api/v4.0/integrations/configurations/coupon"
---

# GET /api/v4.0/integrations/configurations/coupon

`GET /api/v4.0/integrations/configurations/coupon`

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

## Response `200`

Coupon configurations retrieved successfully

- object
  - `url` string — The URL where the coupon configuration is applied.
  - `method` string — The HTTP method used for the coupon configuration process (e.g., POST, PUT or GET).
  - `queryParams` object[] — List of query parameters used in the request.
    - `key` string — The key used in the query parameter.
    - `value` string — The value of the query parameter.
  - `headers` object[] — List of headers used in the request.
    - `key` string — The header key.
    - `value` string — The header value.
  - `payload` string — The request payload format or template.
  - `couponMapping` object — A dictionary mapping coupon types to specific keys in your system.
    - `fixed` string — The internal naming for the fixed discount codes in your system.
    - `percentage` string — The internal naming for the percentage discount codes in your system.
    - `freeProduct` string — The internal naming for the free product discount codes in your system.
    - `freeShipping` string — The internal naming for the free shipping discount codes in your system.
  - `enableFreeProduct` boolean — Indicates whether free product coupons are enabled.
  - `enableFixedRate` boolean — Indicates whether fixed-rate discount coupons are enabled.
  - `enableFreeShipping` boolean — Indicates whether free shipping coupons are enabled.
  - `enablePercentage` boolean — Indicates whether percentage-based discount coupons are enabled.
  - `platforms` object[] — List of platforms for which the coupon configurations are applied.
    - `displayName` string — The display name of the platform.
    - `value` string — The internal value used for the platform.

## Changes

- **2025-12-17** `d43ca6bdac5a` — 3 info
  - the endpoint scheme security `apiKey AND secretKey` was added to the API
  - the endpoint scheme security `apiKey` was removed from the API
  - the endpoint scheme security `secretKey` was removed from the API
- **2025-09-30** `788718651767` — 1 info
  - endpoint added
- **2025-09-02** `919eb7a392aa` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/gameballers/apis/gameball-api/changes/api/v4.0/integrations/configurations/coupon/get.md)

---

[API](https://skmtc.dev/gameballers/apis/gameball-api.md) · [All operations](https://skmtc.dev/gameballers/apis/gameball-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gameballers/gameball-api/revisions/747ba4697269/schema)