---
title: "GET /api/coupon/series"
method: GET
path: "/api/coupon/series"
tags: ["api", "coupons"]
---

# GET /api/coupon/series

`GET /api/coupon/series`

Get all coupon series

## Query parameters

- `top` integer — A limit on the number of objects to be returned. Can range between 1 and 1000.
- `skip` integer — The number of objects to skip for the requested result
- `name` string — Filter coupon series by name

## Response `200`

OK

- CouponSeriesResource[]
  - `name` string, required — The Name for the coupon. Visible to public.
  - `singleUsage` boolean — Whether this coupon can only be used once
  - `active` boolean — Whether the coupon can be used
  - `maxUsage` number, float — The max amount of usages. A usage is counted as a completed transaction that used the coupon.
  - `maxUsagePerEvent` number, float, nullable — The max amount of usages per event. A usage is counted as a completed transaction that used the coupon.
  - `maxTickets` number, float, nullable — The number of tickets that can be purchased with this coupon
  - `canBeCombined` boolean — Whether this coupon can be combined with others within one transaction.
  - `discountType` 'fix' | 'var' | 'fixPerItem' | 'waiveFees'
  - `discountValue` number, float — The amount of the discount in seller's currency. eg. 50.0 -> 50 EUR
  - `discountMaxValue` number, float, nullable — When discountType is VAR the max amount of the discount in seller's currency
  - `allowAllEvents` boolean — Whether the coupon can be used across all events
  - `allowedEvents` string[] — The ID's of events where the coupon can be used
  - `allowAllTickets` boolean — Whether the coupon can be used across all tickets within the events
  - `allowedTickets` string[] — The ID's of the ticket types on which the coupon should be applied
  - `taggingEnabled` boolean — Whether this coupon tags customers
  - `tags` string[] — Which tags to add to customers which bought with this coupon
  - `validFrom` string, date-time, nullable — The date from which this coupon can be redeemed.
  - `validUntil` string, date-time, nullable — The date until this coupon can be redeemed.
  - `limitMaxTicketsInCart` boolean — Whether this coupon limits the max tickets in cart.
  - `maxTicketsInCart` number, float, nullable — If limitMaxTicketsInCart is true, the amount of the max allowed tickets.
  - `minTicketsInCart` number, float, nullable — The minimum number of tickets that need to be purchased with this coupon
  - `note` string, nullable — The Note for this coupon.
  - `revealAllowedTickets` boolean — Whether this coupon reveals the allowed tickets.
  - `unlocks` object[] — The array of the resources unlocked by undershop.
    - `target` 'underShop', required
    - `eventId` string, required — The ID of the event.
    - `underShopId` string, required — The ID of the under shop.
  - `_id` string, required — The ID of the coupon series.
  - `sellerId` string, required — The ID of the seller.
  - `createdAt` string, date-time — The date the coupon was created.
  - `updatedAt` string, date-time — The date the coupon was last updated.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized

---

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