Skip to main content
GET
/
merchant
/
discount
/
batch
/
template
/
list
Get Batch Template List
curl --request GET \
  --url https://api.unibee.dev/merchant/discount/batch/template/list \
  --header 'Authorization: Bearer <token>'
{
  "code": 123,
  "data": {
    "activeTemplateCount": 123,
    "templates": [
      {
        "advance": true,
        "billingType": 123,
        "childCodeCount": 123,
        "code": "<string>",
        "codePrefix": "<string>",
        "createTime": 123,
        "currency": "<string>",
        "cycleLimit": 123,
        "discountAmount": 123,
        "discountPercentage": 123,
        "discountType": 123,
        "endTime": 123,
        "id": 123,
        "isDeleted": 123,
        "merchantId": 123,
        "metadata": {},
        "name": "<string>",
        "planApplyGroup": {
          "currency": [
            "<string>"
          ],
          "groupPlanIntervalSelector": [
            {
              "intervalCount": 123,
              "intervalUnit": "<string>"
            }
          ],
          "type": [
            123
          ]
        },
        "planApplyType": 123,
        "planIds": [
          123
        ],
        "quantity": 123,
        "startTime": 123,
        "status": 123,
        "type": 123,
        "upgradeLongerOnly": true,
        "upgradeOnly": true,
        "usedChildCodeCount": 123,
        "userLimit": 123,
        "userScope": 123
      }
    ],
    "total": 123,
    "totalChildCodeCount": 123,
    "usageRate": 123,
    "usedChildCodeCount": 123
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Authorizations

Authorization
string
header
required

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

Query Parameters

discountType
integer<int>[]

Filter by discount_type, 1-percentage, 2-fixed_amount

billingType
integer<int>[]

Filter by billing_type, 1-one-time, 2-recurring

status
integer<int>[]

Filter by status, 1-editable, 2-active, 3-deactive, 4-expire, 10-archive

codePrefix
string<string>

Filter by code prefix

searchKey
string<string>

Search by code prefix or name

currency
string<string>

Filter by currency

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 number, start from 0

count
integer<int>

Count per page

createTimeStart
integer<int64>

Filter by create time start, UTC timestamp in seconds

createTimeEnd
integer<int64>

Filter by create time end, UTC timestamp in seconds

Response

200 - application/json
code
integer<int>
data
object
merchantId
integer<int64>
message
string<string>
redirect
string<string>
requestId
string<string>