---
title: "List coupons"
method: GET
path: "/coupons/"
tags: ["Billing"]
---

# List coupons

`GET /coupons/`

## Query parameters

- `page` integer
- `page_size` integer
- `ordering` string
- `name` string
- `apply_on` 'line' | 'invoice'
- `duration_scheme` 'one_time' | 'forever' | 'limited'
- `amount` number
- `currency` string

## Headers

- `x-simple-workspace` string, required
- `x-piriod-test-mode` boolean

## Response `200`

Paginated coupon list.

- object
  - `count` integer, required — Total number of items matching the filter.
  - `next` string, uri, nullable — URL of the next page, or `null` if last page.
  - `previous` string, uri, nullable — URL of the previous page, or `null` if first page.
  - `results` Coupon[], required — The items in the current page.
    - `id` string
    - `name` string, required
    - `amount` number, required
    - `currency` string, required
    - `discount_scheme` '%' | '$'
    - `duration_scheme` 'one_time' | 'forever' | 'limited'
    - `duration_times` integer, nullable — Required when `duration_scheme=limited`. Number of billing cycles.
    - `valid_until` string, date, nullable
    - `apply_on` 'line' | 'invoice'
    - `status` 'active' | 'archived'
    - `archived` string, date-time, nullable
    - `created` string, date-time
    - `updated` string, date-time

---

[API](https://skmtc.net/piriod/apis/piriod-api.md) · [All operations](https://skmtc.net/piriod/apis/piriod-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/piriod/piriod-api/versions/70cbc827dc7b/schema)