Edit Batch Discount Template

Edit batch discount template. CodePrefix cannot be modified. Quantity can only be increased after activation.

POST /merchant/discount/batch/template/edit

Edit Batch Discount Template

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/discount/batch/template/edit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "codePrefix": "<string>",
  "id": 123,
  "advance": true,
  "billingType": 123,
  "currency": "<string>",
  "cycleLimit": 123,
  "discountAmount": 123,
  "discountPercentage": 123,
  "discountType": 123,
  "endTime": 123,
  "metadata": {},
  "name": "<string>",
  "planApplyGroup": {
    "currency": [
      "<string>"
    ],
    "groupPlanIntervalSelector": [
      {
        "intervalCount": 123,
        "intervalUnit": "<string>"
      }
    ],
    "type": [
      123
    ]
  },
  "planApplyType": 123,
  "planIds": [
    123
  ],
  "quantity": 123,
  "startTime": 123,
  "subscriptionLimit": 123,
  "upgradeLongPlanOnly": true,
  "upgradeOnly": true,
  "userLimit": 123,
  "userScope": 123
}
'

200

{
  "code": 123,
  "data": {
    "template": {
      "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
    }
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/discount/batch/template/edit

Edit batch discount template. CodePrefix cannot be modified. Quantity can only be increased after activation.

---

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.

Request body

Name	Type	Required	Description
advance	boolean	No	AdvanceConfig, enable advanced configurations
billingType	integer	No	The billing type, 1-one-time, 2-recurring
codePrefix	string	Yes	The code prefix, must match existing value, cannot be modified
currency	string	No	The discount currency
cycleLimit	integer	No	The count limitation of subscription cycle, 0-no limit
discountAmount	integer	No	The discount amount, available when discount_type is fixed_amount
discountPercentage	integer	No	The discount percentage, 100=1%
discountType	integer	No	The discount type, 1-percentage, 2-fixed_amount
endTime	integer	No	The end time, editable after activate, utc timestamp in seconds
id	integer	Yes	The template’s Id
metadata	object	No	Metadata, custom key-value pairs
name	string	No	The batch template’s display name
planApplyGroup	string	No
planApplyType	integer	No	Plan apply type, 0-apply for all, 1-specified, 2-exclude, 3-by groups, 4-except groups
planIds	array	No	Ids of plan which discount code can effect
quantity	integer	No	Target number of child codes, can only increase after activation, max 10000
startTime	integer	No	The start time, editable after activate, utc timestamp in seconds
subscriptionLimit	integer	No	The limit of every subscription apply, 0-unlimited
upgradeLongPlanOnly	boolean	No	AdvanceConfig, true-only for upgrade to longer plan
upgradeOnly	boolean	No	AdvanceConfig, true-only for same interval upgrade
userLimit	integer	No	AdvanceConfig, Per customer limit, 0-unlimited
userScope	integer	No	AdvanceConfig, Apply user scope, 0-all, 1-new user, 2-renewals

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/discount/batch/template/edit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "advance": false,
  "billingType": 0,
  "codePrefix": "",
  "currency": "",
  "cycleLimit": 0,
  "discountAmount": 0,
  "discountPercentage": 0,
  "discountType": 0,
  "endTime": 0,
  "id": 0,
  "metadata": {},
  "name": "",
  "planApplyGroup": "",
  "planApplyType": 0,
  "planIds": [],
  "quantity": 0,
  "startTime": 0,
  "subscriptionLimit": 0,
  "upgradeLongPlanOnly": false,
  "upgradeOnly": false,
  "userLimit": 0,
  "userScope": 0
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/discount/batch/template/edit" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "advance": false,
  "billingType": 0,
  "codePrefix": "",
  "currency": "",
  "cycleLimit": 0,
  "discountAmount": 0,
  "discountPercentage": 0,
  "discountType": 0,
  "endTime": 0,
  "id": 0,
  "metadata": {},
  "name": "",
  "planApplyGroup": "",
  "planApplyType": 0,
  "planIds": [],
  "quantity": 0,
  "startTime": 0,
  "subscriptionLimit": 0,
  "upgradeLongPlanOnly": false,
  "upgradeOnly": false,
  "userLimit": 0,
  "userScope": 0
}'

---

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.template	object
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.

Body

application/json

Edit batch discount template. CodePrefix cannot be modified. Quantity can only be increased after activation.

codePrefix · string<string> · required

The code prefix, must match existing value, cannot be modified

id · integer<int64> · required

The template's Id

advance · boolean<*bool>

AdvanceConfig, enable advanced configurations

billingType · integer<int>

The billing type, 1-one-time, 2-recurring

currency · string<string>

The discount currency

cycleLimit · integer<int>

The count limitation of subscription cycle, 0-no limit

discountAmount · integer<int64>

The discount amount, available when discount_type is fixed_amount

discountPercentage · integer<int64>

The discount percentage, 100=1%

discountType · integer<int>

The discount type, 1-percentage, 2-fixed_amount

endTime · integer<*int64>

The end time, editable after activate, utc timestamp in seconds

metadata · object

Metadata, custom key-value pairs

Show child attributes

name · string<*string>

The batch template's display name

planApplyGroup · object

Show child attributes

planApplyType · integer<*int>

Plan apply type, 0-apply for all, 1-specified, 2-exclude, 3-by groups, 4-except groups

planIds · integer<int64>[]

Ids of plan which discount code can effect

quantity · integer<*int64>

Target number of child codes, can only increase after activation, max 10000

startTime · integer<*int64>

The start time, editable after activate, utc timestamp in seconds

subscriptionLimit · integer<int>

The limit of every subscription apply, 0-unlimited

upgradeLongPlanOnly · boolean<*bool>

AdvanceConfig, true-only for upgrade to longer plan

upgradeOnly · boolean<*bool>

AdvanceConfig, true-only for same interval upgrade

userLimit · integer<*int>

AdvanceConfig, Per customer limit, 0-unlimited

userScope · integer<*int>

AdvanceConfig, Apply user scope, 0-all, 1-new user, 2-renewals

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>