List coupons

GET

/v1/coupons/

List coupons with optional status filter.

Parameters

Query Parameters

skip

Skip

integer

0

limit

Limit

integer

default: 100 >= 1 <= 1000

order_by

Any of:

string

string

null

null

status

Any of:

CouponStatus

CouponStatus

string

Allowed values: active terminated

null

null

Responses

200

Successful Response

Response List Coupons V1 Coupons Get

Array<object>

CouponResponse

object

id

required

Id

string format: uuid

code

required

Code

string

name

required

Name

string

description

Any of:

string

string

null

null

coupon_type

required

Coupon Type

string

amount_cents

Any of:

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

amount_currency

Any of:

string

string

null

null

percentage_rate

Any of:

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

null

null

frequency

required

Frequency

string

frequency_duration

Any of:

integer

integer

null

null

reusable

required

Reusable

boolean

expiration

required

Expiration

string

expiration_at

Any of:

string

string format: date-time

null

null

status

required

Status

string

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

401

Unauthorized

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object