Skip to content
UltimateTeam.ai Docs

List Coupons

GET
/api/v1/admin/coupons

List coupons newest-first, with live redemption counters.

Args: include_inactive: When False, hide deactivated coupons. user: The authenticated platform operator (injected). session: Database session.

Returns: {coupons: [...], total: n}.

Authorizations

Parameters

Query Parameters

include_inactive

Include deactivated coupons (default true).

boolean
default: true

Include deactivated coupons (default true).

Responses

200

Successful Response

GET /api/v1/admin/coupons response body.

object
coupons
required
Array<object>

The canonical coupon JSON shape returned by every coupon endpoint.

object
active
required
boolean
bonus_credits
required
integer
code
required
string
created_at
required
string format: date-time
created_by
required
Any of:
string
description
required
Any of:
string
discount_type
required
string
discount_value
required
integer
duration
required
string
duration_months
required
Any of:
integer
expires_at
required
Any of:
string format: date-time
id
required
string format: uuid
max_redemptions
required
Any of:
integer
plan_grant
required
Any of:
string
times_redeemed
required
integer
total
required
integer

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string