API Reference
中文

GetCoupon

Event Type: get_coupon

  • coupon[* Object Coupon]: Coupon Information
    • coupon_id[* String]: Coupon ID
    • coupon_name[* String]: Coupon Name
    • coupon_count[* Integer]: Coupon Count
    • begin_time[* Long]: Begin Time, timestamp (milliseconds), UTC, Jan 1, 1970
    • expire_time[* Long]: Expire Time, timestamp (milliseconds), UTC, Jan 1, 1970
    • coupon_type[String]: Coupon Type, enumeration
      • fixed_discount
      • discount
      • threshold
      • other
    • coupon_rate[Double]: Coupon Discount Rate, Range: 0 - 1.00, example: 90% off: 0.9
    • coupon_threshold[String]: Coupon Threshold
    • cash_back_amount[Object Amount]: Cash_back Amount
      • currency[* String]: Local Currency Type, 3-letter code according to ISO 4217
      • amount_local[* Double]: Amount ( Local Currency )
      • amount_usd[Double]: Amount ( USD ), The USD amount is converted from the original amount by the exchange rate, (required when not access to China Server)
      • amount_cny[Double]: Amount ( CNY ), The CNY amount is converted from the original amount by the exchange rate, (required when accessing a China Server)
{
    "coupon": {
        "coupon_id": "NOHF08938",
        "coupon_name": "Limited Time Discount Coupon",
        "coupon_count": 1,
        "begin_time": 1596358039000,
        "expire_time": 1616358039000,
        "coupon_type": "discount",
        "coupon_rate": 0.85,
        "coupon_threshold": "10",
        "cash_back_amount": {
            "currency": "USD",
            "amount_local": 68,
            "amount_usd": 10,
            "amount_cny": 6.8
        }
    }
}