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

# List of coupons

`GET /api/v1/coupons`

Returns the list of coupons

## Query parameters

- `page` number
- `limit` number
- `isnull` boolean
- `notnull` boolean
- `gt` string, date-time
- `gte` string, date-time
- `lt` string, date-time
- `lte` string, date-time
- `ids` string[]
- `isEnable` boolean
- `isArchived` boolean
- `searchText` string

## Response `200`

- object
  - `page` number, required — Page number. Starts from 1
  - `limit` number, required — Number of items per page
  - `count` number, required
  - `hasMore` boolean, required
  - `query` PaginationFilterDto
    - `page` number — Page number. Starts from 1
    - `limit` number — Number of items per page
    - `createdAt` DateFilterDto
      - `isnull` boolean — Returns null values
      - `notnull` boolean — Returns not null values
      - `gt` string, date-time — Returns values greater than the given date
      - `gte` string, date-time — Returns values greater than or equal to the given date
      - `lt` string, date-time — Returns values less than the given date
      - `lte` string, date-time — Returns values less than or equal to the given date
  - `data` object[], required
    - `id` string, required — Coupon id
    - `organizationId` string, required — Organization id
    - `name` string, required — Name of the coupon displayed to customers on for instance invoices or receipts.
    - `percentOff` number — Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.
    - `amountOff` integer — Fixed amount that will be taken off the subtotal of any invoices for this customer for the duration of the coupon.
    - `currency` string — Name of the currency displayed to customers on for instance invoices or receipts.
    - `maxRedemptions` number — Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
    - `redeemBy` string, date-time — Date after which the coupon can no longer be redeemed
    - `isEnable` boolean, required — Taking account of the above properties, whether this coupon can still be applied to a customer.
    - `createdAt` string, date-time — Time at which this coupon was created.
    - `metadata` object — A set of key-value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.
    - `isArchived` boolean, required — Whether the coupon is archived.
    - `archivedAt` string, date-time — Date at which the coupon was archived
    - `promotionCodes` PromotionCodeSlimDto[], required
      - `id` string, required — Promotion code id
      - `organizationId` string, required — Organization id
      - `code` string, required — The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer.
      - `couponId` string, required — Coupon id
      - `isActive` boolean, required — Whether the promotion code is currently active. A promotion code is only active if the coupon is also enabled.
      - `expiredAt` string, date-time — Date at which the promotion code can no longer be redeemed. If the coupon has specified a redeems_by, then this value cannot be after the coupon’s redeems_by.
      - `maxRedemptions` number — Maximum number of times this promotion code can be redeemed. If the coupon has specified a max_redemptions, then this value cannot be greater than the coupon’s max_redemptions.
      - `createdAt` string, date-time — Date at which the promotion code was created
      - `metadata` object — A set of key-value pairs that you can attach to an object. It can be useful for storing additional information about the object in a structured format.
    - `status` 'active' | 'expired' | 'disabled' | 'limit_reached', required
    - `timesRedeemed` number — Number of times this coupon has been applied.

## Other responses

- `500`

---

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