Skip to content
UltimateTeam.ai Docs

List Coupons

GET
/api/v1/admin/coupons
curl --request GET \
  --url 'https://api.ultimateteam.ai/api/v1/admin/coupons?include_inactive=true' \
  --header 'X-API-Key: <X-API-Key>'

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

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
include_inactive
Include Inactive

Include deactivated coupons (default true).

boolean
default: true

Include deactivated coupons (default true).

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
CouponListResponse

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

object
coupons
required
Coupons
Array<object>
CouponOut

The canonical coupon JSON shape returned by every coupon endpoint.

object
active
required
Active
boolean
bonus_credits
required
Bonus Credits
integer
code
required
Code
string
created_at
required
Created At
string format: date-time
created_by
required
Any of:
string
description
required
Any of:
string
discount_type
required
Discount Type
string
discount_value
required
Discount Value
integer
duration
required
Duration
string
duration_months
required
Any of:
integer
expires_at
required
Any of:
string format: date-time
id
required
Id
string format: uuid
max_redemptions
required
Any of:
integer
plan_grant
required
Any of:
string
times_redeemed
required
Times Redeemed
integer
total
required
Total
integer
Examplegenerated
{
  "coupons": [
    {
      "active": true,
      "bonus_credits": 1,
      "code": "example",
      "created_at": "2026-04-15T12:00:00Z",
      "created_by": "example",
      "description": "example",
      "discount_type": "example",
      "discount_value": 1,
      "duration": "example",
      "duration_months": 1,
      "expires_at": "2026-04-15T12:00:00Z",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "max_redemptions": 1,
      "plan_grant": "example",
      "times_redeemed": 1
    }
  ],
  "total": 1
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}