| id |
int |
Coupon distribution record ID (coupon_send_issuing_log.id), used as `last_id` for cursor-based pagination |
[optional] |
| details_id |
int |
User coupon detail table primary key (separate table per type). This field is 0 for task coupons, has value for regular coupons |
[optional] |
| coupon_type |
string |
Coupon type, enum values same as the `type` parameter |
[optional] |
| name |
string |
Coupon display name (i18n translated) |
[optional] |
| amount |
string |
Coupon denomination (formatted string with thousand separators). Meaning by type: point card = balance, interest rate boost coupon = interest rate percentage (e.g., '5%'), VIP trial card = VIP level number, position voucher = face value × leverage, others = face value |
[optional] |
| origin_amount |
string |
Original denomination (string with trailing zeros removed). Only returned for point card type, other types do not have this field |
[optional] |
| currency |
string |
Denomination unit. Point card = 'POINT', interest rate boost coupon = 'APR', VIP trial card = 'VIP', Alpha cash coupon = base currency, others = uppercase currency symbol (e.g., 'USDT'/'GT') |
[optional] |
| rule_new |
string |
Coupon usage rule text. List endpoint always returns empty string "", only detail endpoint returns actual value |
[optional] |
| status |
string |
Coupon status. Regular coupon: NOT_ACTIVE (pending activation), ACTIVATED (activated), TO_BE_USED (to be used), EXPIRED (expired), RECYCLED (recycled), INVALID (invalidated), USED (used), UNKNOWN (unknown), LOCKED (locked, P2P only). Task coupon: TASK_START (task not started), TASK_WAIT (task in progress), TASK_DONE (task completed, processing), TASK_EXPIRED (task not completed, expired), TASK_NOT_STARTED_EXPIRED (not started, expired), TASK_RECEIVE_SUCCESS (reward claimed successfully), TASK_RECEIVE_FAIL (reward claim failed) |
[optional] |
| jump_url |
\GateApi\Model\ListUserCouponsResponseDataJumpUrl |
|
[optional] |
| help_url |
\GateApi\Model\ListUserCouponsResponseDataHelpUrl |
|
[optional] |
| expire_time |
int |
Expiration time (Unix timestamp). Some types replace this with actual expiration time after activation or use (e.g., contract_bonus uses expired_timest after activation). Point card type returns 0 |
[optional] |
| expire_time_order_by |
int |
Sorting expiration time (from the original expiration time of the distribution record, unaffected by activation). Used as the `expire_time` parameter for the next request in cursor-based pagination |
[optional] |
| expire_second |
int |
Seconds remaining until expiration. Returns 0 for expired or Point Card types |
[optional] |
| has_usage_history |
bool |
Whether there is a usage history. Fixed as true for point card type, determined by type for others |
[optional] |
| has_progress |
bool |
Whether to display a progress bar. Only true for commission_rebate, interest_voucher, and qualifying task coupons |
[optional] |
| progress_config |
\GateApi\Model\ListUserCouponsResponseDataProgressConfig |
|
[optional] |
| activation_info |
object |
Type-specific activation information. Types without specific fields return empty object {}. Fields by type: interest_voucher={supported_pairs,transaction_type}; contract_bonus_new={received_expired_hour}; contract_bonus={check_unified_account_mode,received_expired_days,abtest}; commission_rebate={market,market_name}; robot_bonus={designated_bots}; position_voucher={symbols,leverage,need_user_funds,user_funds_amount,position_bonus}; tradfi_position_voucher={symbols,leverage,position_bonus}; etf_voucher={currency_markets,amount} |
[optional] |
| is_task_coupon |
int |
Whether it is a task coupon. `0` = regular coupon; `1` = task coupon |
[optional] |
| upgrade_toast |
bool |
Whether to prompt the user to upgrade the App (true when app version is too old to support the coupon). Triggered types: copy_trading/alpha_voucher (Android<7320000/iOS<202507320000), commission_rebate subtype tradfi (Android<8040000/iOS<202608040000), etf_voucher (Android<8090000/iOS<202608090000), tradfi_position_voucher (Android<8100000/iOS<202508240000) |
[optional] |
| task_title |
string |
Task title (only task coupons have value, regular coupons return empty string "") |
[optional] |
| task_desc |
string |
Task description (only task coupons have value, regular coupons return empty string "") |
[optional] |
| task_start_at |
int |
Task start timestamp (Unix). Only has value for task coupons in TASK_EXPIRED status, otherwise 0 |
[optional] |
| task_expire_at |
int |
Task expiration timestamp (Unix). Currently fixed at 0, reserved field |
[optional] |
| task_completed_at |
int |
Task completion timestamp (Unix). Currently fixed at 0, reserved field |
[optional] |
| extra |
object[] |
Extension fields. List endpoint always returns empty array [], only the detail endpoint has values |
[optional] |