---
title: "List Coupons"
method: GET
path: "/api/v2/coupons"
tags: ["Coupons"]
---

# List Coupons

`GET /api/v2/coupons`

List all coupons with pagination, filtering, and sorting options.

## Query parameters

- `page` integer — Page number, defaults to 1.
- `limit` integer — Size of a page, defaults to 10. Maximum is 100.
- `search_term` string, nullable — Search by coupon name.
- `active` boolean, nullable — Filter by active or inactive coupons.
- `is_percentage` boolean, nullable — Filter by percentage-based or fixed-amount coupons.
- `sort_field` string, nullable — Field to sort by, e.g., 'amount', 'scheduled_on'
- `sort_direction` string, nullable — Sorting direction ('asc' or 'desc')

## Response `200`

Successful Response

- ListResourceCouponDetailed
  - `data` CouponDetailed[]
    - `created_at` string, date-time — Creation timestamp of the object.
    - `updated_at` string, date-time, nullable — Last modification timestamp of the object.
    - `id` string, uuid4 — Unique identifier (UUID) of the coupon
    - `name` string — Name of the coupon.
    - `discount_value` string — Discount value of the coupon (either percentage or fixed).
    - `currency` 'SAR' | 'USD' | 'EUR' | 'GBP' | 'AED' | 'BHD' | 'KWD' | 'OMR' | 'QAR' — ISO 4217 currency codes supported by Moyasar. Includes all currencies supported by Moyasar payment gateway.
    - `is_percentage` boolean — True if the discount is a percentage, False if it is a fixed amount.
    - `is_active` boolean — Indicates if the coupon is currently active.
    - `redemptions` integer — Indicates how many times this coupon has been used.
  - `pagination` Pagination
    - `total_count` integer
    - `max_page` integer
    - `current_page` integer
    - `limit` integer
    - `has_next_page` boolean
    - `has_previous_page` boolean

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/streampay/apis/stream-app.md) · [All operations](https://skmtc.dev/streampay/apis/stream-app/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/streampay/stream-app/revisions/515eeea7d260/schema)