---
title: "Get Customer Coupons"
method: GET
path: "/api/v4.0/integrations/customers/{customerId}/coupons"
---

# Get Customer Coupons

`GET /api/v4.0/integrations/customers/{customerId}/coupons`

Retrieve customer's available coupons with detailed information on each coupon's type, status, and usage.

## Path parameters

- `customerId` string, required

## Response `200`

Customer coupons found

- CustomerCouponsResponse
  - `coupons` object[] — List of coupon objects associated with the customer
    - `name` string — Name of the coupon
    - `code` string — The coupon code that the customer will use
    - `value` number — The monetary value or percentage value of the coupon
    - `type` 'Free Shipping' | 'Fixed Rate Discount' | 'Percentage' | 'Free Product' | 'Custom' | 'Percentage-based Fees Discount' | 'Percentage-based Cashback' — Type of the coupon
    - `target` 'Online' | 'POS' | 'Permanent' | 'Reward' | 'Automation' — How the coupon is associated with the customer
    - `currency` string — Currency code if the coupon has a fixed monetary value
    - `startDate` string, date-time — The date and time when the coupon becomes valid
    - `expiryDate` string, date-time — The date and time when the coupon will expire
    - `isExpired` boolean — Indicates if the coupon has expired
    - `isActive` boolean — Status of the coupon, whether it is active or not
    - `usageLimit` number — The total number of times the coupon can be used
    - `limitPerCustomer` number — The number of times a single customer can use the coupon
    - `usedCount` number — Number of times the coupon has been used
    - `customerUsedCount` number — Number of times the coupon has been used by this customer
    - `isAvailableToUse` boolean — Flag determining whether coupon can be used by customer at given time
    - `iconPath` string — Path or URL to the icon image for the coupon

---

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