Get User Discount Code List

curl --request GET \
  --url https://api.unibee.dev/merchant/discount/user_discount_list \
  --header 'Authorization: Bearer <token>'

{
  "code": 123,
  "data": {
    "total": 123,
    "userDiscounts": [
      {
        "applyAmount": 123,
        "code": "<string>",
        "createTime": 123,
        "currency": "<string>",
        "id": 123,
        "invoiceId": "<string>",
        "merchantId": 123,
        "paymentId": "<string>",
        "plan": {
          "amount": 123,
          "bindingAddonIds": "<string>",
          "bindingOnetimeAddonIds": "<string>",
          "cancelAtTrialEnd": 123,
          "checkoutUrl": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "description": "<string>",
          "disableAutoCharge": 123,
          "externalPlanId": "<string>",
          "extraMetricData": "<string>",
          "gasPayer": "<string>",
          "homeUrl": "<string>",
          "id": 123,
          "imageUrl": "<string>",
          "internalName": "<string>",
          "intervalCount": 123,
          "intervalUnit": "<string>",
          "merchantId": 123,
          "metadata": {},
          "metricLimits": [
            {
              "metricId": 123,
              "metricLimit": 123
            }
          ],
          "metricMeteredCharge": [
            {
              "chargeType": 123,
              "graduatedAmounts": [
                {
                  "endValue": 123,
                  "flatAmount": 123,
                  "perAmount": 123,
                  "startValue": 123
                }
              ],
              "metricId": 123,
              "standardAmount": 123,
              "standardStartValue": 123
            }
          ],
          "metricRecurringCharge": [
            {
              "chargeType": 123,
              "graduatedAmounts": [
                {
                  "endValue": 123,
                  "flatAmount": 123,
                  "perAmount": 123,
                  "startValue": 123
                }
              ],
              "metricId": 123,
              "standardAmount": 123,
              "standardStartValue": 123
            }
          ],
          "multiCurrencies": [
            {
              "amount": 123,
              "autoExchange": true,
              "currency": "<string>",
              "disable": true,
              "exchangeRate": 123
            }
          ],
          "planName": "<string>",
          "productId": 123,
          "publishStatus": 123,
          "status": 123,
          "taxPercentage": 123,
          "trialAmount": 123,
          "trialDemand": "<string>",
          "trialDurationTime": 123,
          "type": 123,
          "usVATConfig": {
            "active": true,
            "fromAddress": {
              "address": "<string>",
              "city": "<string>",
              "countryCode": "<string>",
              "state": "<string>",
              "verified": true,
              "zipCode": "<string>"
            },
            "nexusAddresses": [
              {
                "address": "<string>",
                "city": "<string>",
                "countryCode": "<string>",
                "state": "<string>",
                "verified": true,
                "zipCode": "<string>"
              }
            ],
            "sellOnUSOnly": true,
            "taxCode": "<string>",
            "toAddress": {
              "address": "<string>",
              "city": "<string>",
              "countryCode": "<string>",
              "state": "<string>",
              "verified": true,
              "zipCode": "<string>"
            }
          }
        },
        "recurring": 123,
        "status": 123,
        "subscriptionId": "<string>",
        "user": {
          "address": "<string>",
          "avatarUrl": "<string>",
          "billingType": 123,
          "birthday": "<string>",
          "city": "<string>",
          "companyName": "<string>",
          "countryCode": "<string>",
          "countryName": "<string>",
          "createTime": 123,
          "custom": "<string>",
          "email": "<string>",
          "externalUserId": "<string>",
          "facebook": "<string>",
          "firstName": "<string>",
          "gatewayId": 123,
          "gatewayPaymentType": "<string>",
          "gender": "<string>",
          "id": 123,
          "isRisk": 123,
          "isSpecial": 123,
          "language": "<string>",
          "lastLoginAt": 123,
          "lastName": "<string>",
          "linkedIn": "<string>",
          "merchantId": 123,
          "metadata": {},
          "mobile": "<string>",
          "otherSocialInfo": "<string>",
          "paymentMethod": "<string>",
          "phone": "<string>",
          "recurringAmount": 123,
          "registrationNumber": "<string>",
          "school": "<string>",
          "state": "<string>",
          "status": 123,
          "subscriptionId": "<string>",
          "subscriptionName": "<string>",
          "subscriptionStatus": 123,
          "taxPercentage": 123,
          "telegram": "<string>",
          "tikTok": "<string>",
          "timeZone": "<string>",
          "type": 123,
          "userName": "<string>",
          "vATNumber": "<string>",
          "version": 123,
          "weChat": "<string>",
          "whatsAPP": "<string>",
          "zipCode": "<string>"
        }
      }
    ]
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

GET

merchant

discount

user_discount_list

Get User Discount Code List

curl --request GET \
  --url https://api.unibee.dev/merchant/discount/user_discount_list \
  --header 'Authorization: Bearer <token>'

{
  "code": 123,
  "data": {
    "total": 123,
    "userDiscounts": [
      {
        "applyAmount": 123,
        "code": "<string>",
        "createTime": 123,
        "currency": "<string>",
        "id": 123,
        "invoiceId": "<string>",
        "merchantId": 123,
        "paymentId": "<string>",
        "plan": {
          "amount": 123,
          "bindingAddonIds": "<string>",
          "bindingOnetimeAddonIds": "<string>",
          "cancelAtTrialEnd": 123,
          "checkoutUrl": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "description": "<string>",
          "disableAutoCharge": 123,
          "externalPlanId": "<string>",
          "extraMetricData": "<string>",
          "gasPayer": "<string>",
          "homeUrl": "<string>",
          "id": 123,
          "imageUrl": "<string>",
          "internalName": "<string>",
          "intervalCount": 123,
          "intervalUnit": "<string>",
          "merchantId": 123,
          "metadata": {},
          "metricLimits": [
            {
              "metricId": 123,
              "metricLimit": 123
            }
          ],
          "metricMeteredCharge": [
            {
              "chargeType": 123,
              "graduatedAmounts": [
                {
                  "endValue": 123,
                  "flatAmount": 123,
                  "perAmount": 123,
                  "startValue": 123
                }
              ],
              "metricId": 123,
              "standardAmount": 123,
              "standardStartValue": 123
            }
          ],
          "metricRecurringCharge": [
            {
              "chargeType": 123,
              "graduatedAmounts": [
                {
                  "endValue": 123,
                  "flatAmount": 123,
                  "perAmount": 123,
                  "startValue": 123
                }
              ],
              "metricId": 123,
              "standardAmount": 123,
              "standardStartValue": 123
            }
          ],
          "multiCurrencies": [
            {
              "amount": 123,
              "autoExchange": true,
              "currency": "<string>",
              "disable": true,
              "exchangeRate": 123
            }
          ],
          "planName": "<string>",
          "productId": 123,
          "publishStatus": 123,
          "status": 123,
          "taxPercentage": 123,
          "trialAmount": 123,
          "trialDemand": "<string>",
          "trialDurationTime": 123,
          "type": 123,
          "usVATConfig": {
            "active": true,
            "fromAddress": {
              "address": "<string>",
              "city": "<string>",
              "countryCode": "<string>",
              "state": "<string>",
              "verified": true,
              "zipCode": "<string>"
            },
            "nexusAddresses": [
              {
                "address": "<string>",
                "city": "<string>",
                "countryCode": "<string>",
                "state": "<string>",
                "verified": true,
                "zipCode": "<string>"
              }
            ],
            "sellOnUSOnly": true,
            "taxCode": "<string>",
            "toAddress": {
              "address": "<string>",
              "city": "<string>",
              "countryCode": "<string>",
              "state": "<string>",
              "verified": true,
              "zipCode": "<string>"
            }
          }
        },
        "recurring": 123,
        "status": 123,
        "subscriptionId": "<string>",
        "user": {
          "address": "<string>",
          "avatarUrl": "<string>",
          "billingType": 123,
          "birthday": "<string>",
          "city": "<string>",
          "companyName": "<string>",
          "countryCode": "<string>",
          "countryName": "<string>",
          "createTime": 123,
          "custom": "<string>",
          "email": "<string>",
          "externalUserId": "<string>",
          "facebook": "<string>",
          "firstName": "<string>",
          "gatewayId": 123,
          "gatewayPaymentType": "<string>",
          "gender": "<string>",
          "id": 123,
          "isRisk": 123,
          "isSpecial": 123,
          "language": "<string>",
          "lastLoginAt": 123,
          "lastName": "<string>",
          "linkedIn": "<string>",
          "merchantId": 123,
          "metadata": {},
          "mobile": "<string>",
          "otherSocialInfo": "<string>",
          "paymentMethod": "<string>",
          "phone": "<string>",
          "recurringAmount": 123,
          "registrationNumber": "<string>",
          "school": "<string>",
          "state": "<string>",
          "status": 123,
          "subscriptionId": "<string>",
          "subscriptionName": "<string>",
          "subscriptionStatus": 123,
          "taxPercentage": 123,
          "telegram": "<string>",
          "tikTok": "<string>",
          "timeZone": "<string>",
          "type": 123,
          "userName": "<string>",
          "vATNumber": "<string>",
          "version": 123,
          "weChat": "<string>",
          "whatsAPP": "<string>",
          "zipCode": "<string>"
        }
      }
    ]
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

GET https://api.unibee.dev/merchant/discount/user_discount_list Get user discountCode list

Authorization

All UniBee Merchant API requests require authentication via API key.

Header	Required	Description
`Authorization`	Yes	Bearer `<your_api_key>`
`Content-Type`	Yes	`application/json` (for request body)

Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

Query parameters

Name	Type	Required	Description
`id`	integer	Yes	The discount’s Id
`userIds`	array	No	Filter UserIds Default All
`email`	string	No	Filter Email Default All
`planIds`	array	No	Filter PlanIds Default All
`subscriptionIds`	array	No	Filter SubscriptionIds Default All
`status`	array	No	Filter Status Default All, 1-normal, 2-rollback
`childCode`	string	No	Filter Child Code (fuzzy search), only available when Id is batch template ID
`sortField`	string	No	Sort Field，gmt_create\|gmt_modify，Default gmt_modify
`sortType`	string	No	Sort Type，asc\|desc，Default desc
`page`	integer	No	Page, Start 0
`count`	integer	No	Count Of Per Page
`createTimeStart`	integer	No	CreateTimeStart，UTC timestamp，seconds
`createTimeEnd`	integer	No	CreateTimeEnd，UTC timestamp，seconds

Request examples

cURL

curl -X GET "https://api.unibee.dev/merchant/discount/user_discount_list" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Sandbox

curl -X GET "https://api-sandbox.unibee.top/merchant/discount/user_discount_list" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json"

Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success.

Field	Type	Description
`code`	integer	Response code. `0` = success
`data`	object	Response payload
`data.total`	integer	Total
`data.userDiscounts`	array	User Discount Object List
`message`	string	Human-readable message
`requestId`	string	Request ID for support

Error handling

HTTP status	Meaning
400	Bad request — invalid or missing parameters. Check `message` in the body.
401	Unauthorized — missing or invalid API key.
404	Not found — invalid path or resource.
500	Server error — retry with backoff.

When code in the response body is non-zero, check message for details. Use requestId when contacting support.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

integer<int64>

required

The discount's Id

userIds

integer<int64>[]

Filter UserIds Default All

string<string>

Filter Email Default All

planIds

integer<int64>[]

Filter PlanIds Default All

subscriptionIds

string<string>[]

Filter SubscriptionIds Default All

status

integer<int>[]

Filter Status Default All, 1-normal, 2-rollback

childCode

string<string>

Filter Child Code (fuzzy search), only available when Id is batch template ID

sortField

string<string>

Sort Field，gmt_create|gmt_modify，Default gmt_modify

sortType

string<string>

Sort Type，asc|desc，Default desc

page

integer<int>

Page, Start 0

count

integer<int>

Count Of Per Page

createTimeStart

integer<int64>

CreateTimeStart，UTC timestamp，seconds

createTimeEnd

integer<int64>

CreateTimeEnd，UTC timestamp，seconds

Response

200 - application/json

code

integer<int>

data

object

Show child attributes

merchantId

integer<int64>

message

string<string>

redirect

string<string>

requestId

string<string>

Plan Apply Preview Customize Localization Template Sync

Start Here

Core Concepts

Guides

Reference

Migration and Deployment

Get User Discount Code List

Endpoint Overview

Authorization

Parameters

Query parameters

Request examples

cURL

Sandbox

Response

Error handling

Authorizations

Query Parameters

Response

Start Here

Core Concepts

Guides

Reference

Migration and Deployment

Documentation Index

​Endpoint Overview

​Authorization

​Parameters

​Query parameters

​Request examples

​cURL

​Sandbox

​Response

​Error handling

Authorizations

Query Parameters

Response

Endpoint Overview

Authorization

Parameters

Query parameters

Request examples

cURL

Sandbox

Response

Error handling