Coupons

List Coupons

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

get/api/v2/coupons

Query parameters

pageinteger

Page number, defaults to 1.

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Size of a page, defaults to 10. Maximum is 100.

search_termstring nullable

Search by coupon name.

Search by coupon name.

activeboolean nullable

Filter by active or inactive coupons.

Filter by active or inactive coupons.

is_percentageboolean nullable

Filter by percentage-based or fixed-amount coupons.

Filter by percentage-based or fixed-amount coupons.

sort_fieldstring nullable

Field to sort by, e.g., 'amount', 'scheduled_on'

Field to sort by, e.g., 'amount', 'scheduled_on'

sort_directionstring nullable

Sorting direction ('asc' or 'desc')

Sorting direction ('asc' or 'desc')

Response

Successful Response

Changes