Skip to content
UltimateTeam.ai Docs

Get Coupon

GET
/api/v1/admin/coupons/{coupon_id}
curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/admin/coupons/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Return one coupon plus its redemption row count.

Args: coupon_id: The coupon’s UUID. user: The authenticated platform operator (injected). session: Database session.

Returns: The coupon with redemption_count attached.

Raises: HTTPException 404: No coupon with that id.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
coupon_id
required
Coupon Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
CouponDetailOut

GET /api/v1/admin/coupons/{id} — coupon plus its redemption count.

redemption_count is counted from coupon_redemptions rather than read from times_redeemed: the counter is the concurrency guard and can legitimately differ from the row count if a redemption transaction rolled back after the guarded UPDATE, so showing both makes that divergence visible instead of hiding it.

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
redemption_count
required
Redemption Count
integer
times_redeemed
required
Times Redeemed
integer
Examplegenerated
{
  "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",
  "redemption_count": 1,
  "times_redeemed": 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"
    }
  ]
}