New Discount Code

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

import requests

url = "https://api.unibee.dev/merchant/discount/new"

payload = {
    "billingType": 123,
    "code": "<string>",
    "discountType": 123,
    "endTime": 123,
    "startTime": 123,
    "advance": True,
    "currency": "<string>",
    "cycleLimit": 123,
    "discountAmount": 123,
    "discountPercentage": 123,
    "metadata": {},
    "name": "<string>",
    "planApplyGroup": {
        "currency": ["<string>"],
        "groupPlanIntervalSelector": [
            {
                "intervalCount": 123,
                "intervalUnit": "<string>"
            }
        ],
        "type": [123]
    },
    "planApplyType": 123,
    "planIds": [123],
    "quantity": 123,
    "upgradeLongPlanOnly": True,
    "upgradeOnly": True,
    "userIds": [123],
    "userLimit": 123,
    "userScope": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billingType: 123,
    code: '<string>',
    discountType: 123,
    endTime: 123,
    startTime: 123,
    advance: true,
    currency: '<string>',
    cycleLimit: 123,
    discountAmount: 123,
    discountPercentage: 123,
    metadata: {},
    name: '<string>',
    planApplyGroup: {
      currency: ['<string>'],
      groupPlanIntervalSelector: [{intervalCount: 123, intervalUnit: '<string>'}],
      type: [123]
    },
    planApplyType: 123,
    planIds: [123],
    quantity: 123,
    upgradeLongPlanOnly: true,
    upgradeOnly: true,
    userIds: [123],
    userLimit: 123,
    userScope: 123
  })
};

fetch('https://api.unibee.dev/merchant/discount/new', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unibee.dev/merchant/discount/new",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'billingType' => 123,
    'code' => '<string>',
    'discountType' => 123,
    'endTime' => 123,
    'startTime' => 123,
    'advance' => true,
    'currency' => '<string>',
    'cycleLimit' => 123,
    'discountAmount' => 123,
    'discountPercentage' => 123,
    'metadata' => [
        
    ],
    'name' => '<string>',
    'planApplyGroup' => [
        'currency' => [
                '<string>'
        ],
        'groupPlanIntervalSelector' => [
                [
                                'intervalCount' => 123,
                                'intervalUnit' => '<string>'
                ]
        ],
        'type' => [
                123
        ]
    ],
    'planApplyType' => 123,
    'planIds' => [
        123
    ],
    'quantity' => 123,
    'upgradeLongPlanOnly' => true,
    'upgradeOnly' => true,
    'userIds' => [
        123
    ],
    'userLimit' => 123,
    'userScope' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.unibee.dev/merchant/discount/new"

	payload := strings.NewReader("{\n  \"billingType\": 123,\n  \"code\": \"<string>\",\n  \"discountType\": 123,\n  \"endTime\": 123,\n  \"startTime\": 123,\n  \"advance\": true,\n  \"currency\": \"<string>\",\n  \"cycleLimit\": 123,\n  \"discountAmount\": 123,\n  \"discountPercentage\": 123,\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"planApplyGroup\": {\n    \"currency\": [\n      \"<string>\"\n    ],\n    \"groupPlanIntervalSelector\": [\n      {\n        \"intervalCount\": 123,\n        \"intervalUnit\": \"<string>\"\n      }\n    ],\n    \"type\": [\n      123\n    ]\n  },\n  \"planApplyType\": 123,\n  \"planIds\": [\n    123\n  ],\n  \"quantity\": 123,\n  \"upgradeLongPlanOnly\": true,\n  \"upgradeOnly\": true,\n  \"userIds\": [\n    123\n  ],\n  \"userLimit\": 123,\n  \"userScope\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.unibee.dev/merchant/discount/new")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billingType\": 123,\n  \"code\": \"<string>\",\n  \"discountType\": 123,\n  \"endTime\": 123,\n  \"startTime\": 123,\n  \"advance\": true,\n  \"currency\": \"<string>\",\n  \"cycleLimit\": 123,\n  \"discountAmount\": 123,\n  \"discountPercentage\": 123,\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"planApplyGroup\": {\n    \"currency\": [\n      \"<string>\"\n    ],\n    \"groupPlanIntervalSelector\": [\n      {\n        \"intervalCount\": 123,\n        \"intervalUnit\": \"<string>\"\n      }\n    ],\n    \"type\": [\n      123\n    ]\n  },\n  \"planApplyType\": 123,\n  \"planIds\": [\n    123\n  ],\n  \"quantity\": 123,\n  \"upgradeLongPlanOnly\": true,\n  \"upgradeOnly\": true,\n  \"userIds\": [\n    123\n  ],\n  \"userLimit\": 123,\n  \"userScope\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unibee.dev/merchant/discount/new")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billingType\": 123,\n  \"code\": \"<string>\",\n  \"discountType\": 123,\n  \"endTime\": 123,\n  \"startTime\": 123,\n  \"advance\": true,\n  \"currency\": \"<string>\",\n  \"cycleLimit\": 123,\n  \"discountAmount\": 123,\n  \"discountPercentage\": 123,\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"planApplyGroup\": {\n    \"currency\": [\n      \"<string>\"\n    ],\n    \"groupPlanIntervalSelector\": [\n      {\n        \"intervalCount\": 123,\n        \"intervalUnit\": \"<string>\"\n      }\n    ],\n    \"type\": [\n      123\n    ]\n  },\n  \"planApplyType\": 123,\n  \"planIds\": [\n    123\n  ],\n  \"quantity\": 123,\n  \"upgradeLongPlanOnly\": true,\n  \"upgradeOnly\": true,\n  \"userIds\": [\n    123\n  ],\n  \"userLimit\": 123,\n  \"userScope\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "data": {
    "discount": {
      "advance": true,
      "billingType": 123,
      "code": "<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,
      "upgradeLongerOnly": true,
      "upgradeOnly": true,
      "userIds": [
        123
      ],
      "userLimit": 123,
      "userScope": 123
    }
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

POST

merchant

discount

new

New Discount Code

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

import requests

url = "https://api.unibee.dev/merchant/discount/new"

payload = {
    "billingType": 123,
    "code": "<string>",
    "discountType": 123,
    "endTime": 123,
    "startTime": 123,
    "advance": True,
    "currency": "<string>",
    "cycleLimit": 123,
    "discountAmount": 123,
    "discountPercentage": 123,
    "metadata": {},
    "name": "<string>",
    "planApplyGroup": {
        "currency": ["<string>"],
        "groupPlanIntervalSelector": [
            {
                "intervalCount": 123,
                "intervalUnit": "<string>"
            }
        ],
        "type": [123]
    },
    "planApplyType": 123,
    "planIds": [123],
    "quantity": 123,
    "upgradeLongPlanOnly": True,
    "upgradeOnly": True,
    "userIds": [123],
    "userLimit": 123,
    "userScope": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billingType: 123,
    code: '<string>',
    discountType: 123,
    endTime: 123,
    startTime: 123,
    advance: true,
    currency: '<string>',
    cycleLimit: 123,
    discountAmount: 123,
    discountPercentage: 123,
    metadata: {},
    name: '<string>',
    planApplyGroup: {
      currency: ['<string>'],
      groupPlanIntervalSelector: [{intervalCount: 123, intervalUnit: '<string>'}],
      type: [123]
    },
    planApplyType: 123,
    planIds: [123],
    quantity: 123,
    upgradeLongPlanOnly: true,
    upgradeOnly: true,
    userIds: [123],
    userLimit: 123,
    userScope: 123
  })
};

fetch('https://api.unibee.dev/merchant/discount/new', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unibee.dev/merchant/discount/new",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'billingType' => 123,
    'code' => '<string>',
    'discountType' => 123,
    'endTime' => 123,
    'startTime' => 123,
    'advance' => true,
    'currency' => '<string>',
    'cycleLimit' => 123,
    'discountAmount' => 123,
    'discountPercentage' => 123,
    'metadata' => [
        
    ],
    'name' => '<string>',
    'planApplyGroup' => [
        'currency' => [
                '<string>'
        ],
        'groupPlanIntervalSelector' => [
                [
                                'intervalCount' => 123,
                                'intervalUnit' => '<string>'
                ]
        ],
        'type' => [
                123
        ]
    ],
    'planApplyType' => 123,
    'planIds' => [
        123
    ],
    'quantity' => 123,
    'upgradeLongPlanOnly' => true,
    'upgradeOnly' => true,
    'userIds' => [
        123
    ],
    'userLimit' => 123,
    'userScope' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.unibee.dev/merchant/discount/new"

	payload := strings.NewReader("{\n  \"billingType\": 123,\n  \"code\": \"<string>\",\n  \"discountType\": 123,\n  \"endTime\": 123,\n  \"startTime\": 123,\n  \"advance\": true,\n  \"currency\": \"<string>\",\n  \"cycleLimit\": 123,\n  \"discountAmount\": 123,\n  \"discountPercentage\": 123,\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"planApplyGroup\": {\n    \"currency\": [\n      \"<string>\"\n    ],\n    \"groupPlanIntervalSelector\": [\n      {\n        \"intervalCount\": 123,\n        \"intervalUnit\": \"<string>\"\n      }\n    ],\n    \"type\": [\n      123\n    ]\n  },\n  \"planApplyType\": 123,\n  \"planIds\": [\n    123\n  ],\n  \"quantity\": 123,\n  \"upgradeLongPlanOnly\": true,\n  \"upgradeOnly\": true,\n  \"userIds\": [\n    123\n  ],\n  \"userLimit\": 123,\n  \"userScope\": 123\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.unibee.dev/merchant/discount/new")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billingType\": 123,\n  \"code\": \"<string>\",\n  \"discountType\": 123,\n  \"endTime\": 123,\n  \"startTime\": 123,\n  \"advance\": true,\n  \"currency\": \"<string>\",\n  \"cycleLimit\": 123,\n  \"discountAmount\": 123,\n  \"discountPercentage\": 123,\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"planApplyGroup\": {\n    \"currency\": [\n      \"<string>\"\n    ],\n    \"groupPlanIntervalSelector\": [\n      {\n        \"intervalCount\": 123,\n        \"intervalUnit\": \"<string>\"\n      }\n    ],\n    \"type\": [\n      123\n    ]\n  },\n  \"planApplyType\": 123,\n  \"planIds\": [\n    123\n  ],\n  \"quantity\": 123,\n  \"upgradeLongPlanOnly\": true,\n  \"upgradeOnly\": true,\n  \"userIds\": [\n    123\n  ],\n  \"userLimit\": 123,\n  \"userScope\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unibee.dev/merchant/discount/new")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billingType\": 123,\n  \"code\": \"<string>\",\n  \"discountType\": 123,\n  \"endTime\": 123,\n  \"startTime\": 123,\n  \"advance\": true,\n  \"currency\": \"<string>\",\n  \"cycleLimit\": 123,\n  \"discountAmount\": 123,\n  \"discountPercentage\": 123,\n  \"metadata\": {},\n  \"name\": \"<string>\",\n  \"planApplyGroup\": {\n    \"currency\": [\n      \"<string>\"\n    ],\n    \"groupPlanIntervalSelector\": [\n      {\n        \"intervalCount\": 123,\n        \"intervalUnit\": \"<string>\"\n      }\n    ],\n    \"type\": [\n      123\n    ]\n  },\n  \"planApplyType\": 123,\n  \"planIds\": [\n    123\n  ],\n  \"quantity\": 123,\n  \"upgradeLongPlanOnly\": true,\n  \"upgradeOnly\": true,\n  \"userIds\": [\n    123\n  ],\n  \"userLimit\": 123,\n  \"userScope\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "data": {
    "discount": {
      "advance": true,
      "billingType": 123,
      "code": "<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,
      "upgradeLongerOnly": true,
      "upgradeOnly": true,
      "userIds": [
        123
      ],
      "userLimit": 123,
      "userScope": 123
    }
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/discount/new Create a new discount code, code can used in onetime or subscription purchase to make discount

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, 0-false,1-true, will enable all advance config if set true
`billingType`	integer	Yes	The billing type of the discount code, 1-one-time, 2-recurring, define the situation the code can be used, the code of one-time billing_type can used for all situation that effect only once, the code of recurring billing_tye can only used for subscription purchase
`code`	string	Yes	The discount’s unique code, customize by merchant
`currency`	string	No	The discount currency of discount code, available when discount_type is fixed_amount
`cycleLimit`	integer	No	The count limitation of subscription cycle, each subscription is valid separately , 0-no limit
`discountAmount`	integer	No	The discount amount of the discount code, available when discount_type is fixed_amount
`discountPercentage`	integer	No	The discount percentage of discount code, 100=1%, available when discount_type is percentage
`discountType`	integer	Yes	The discount type of the discount code, 1-percentage, 2-fixed_amount, the discountType of code, the discountPercentage will be effect when discountType is percentage, the discountAmount and currency will be effect when discountTYpe is fixed_amount
`endTime`	integer	Yes	The end time of discount code can effect, utc time
`metadata`	object	No	Metadata，Map
`name`	string	No	The discount’s name
`planApplyGroup`	string	No
`planApplyType`	integer	No	plan apply type, 0-apply for all, 1-apply for plans specified, 2-exclude for plans specified, 3-Apply to Plans by Groups(Billing Period Included), 4-Apply to Plans except by Groups(Billing Period Included)
`planIds`	array	No	Ids of plan which discount code can effect, default effect all plans if not set
`quantity`	integer	No	Quantity of code, default 0, set 0 to disable quantity management
`startTime`	integer	Yes	The start time of discount code can effect, utc time
`upgradeLongPlanOnly`	boolean	No	AdvanceConfig, true or false, will forbid for all except upgrade to longer plan if set true
`upgradeOnly`	boolean	No	AdvanceConfig, true or false, will forbid for all except same interval upgrade action if set true
`userLimit`	integer	No	AdvanceConfig, The limit of every customer can apply, the recurring apply not involved, 0-unlimited
`userScope`	integer	No	AdvanceConfig, Apply user scope,0-for all, 1-for only new user, 2-for only renewals, renewals is upgrade&downgrade&renew

Request examples

cURL

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

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/discount/new" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "advance": false,
  "billingType": 0,
  "code": "",
  "currency": "",
  "cycleLimit": 0,
  "discountAmount": 0,
  "discountPercentage": 0,
  "discountType": 0,
  "endTime": 0,
  "metadata": {},
  "name": "",
  "planApplyGroup": "",
  "planApplyType": 0,
  "planIds": [],
  "quantity": 0,
  "startTime": 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.discount`	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

Create a new discount code, code can used in onetime or subscription purchase to make discount

billingType

integer<int>

required

The billing type of the discount code, 1-one-time, 2-recurring, define the situation the code can be used, the code of one-time billing_type can used for all situation that effect only once, the code of recurring billing_tye can only used for subscription purchase

code

string<string>

required

The discount's unique code, customize by merchant

discountType

integer<int>

required

The discount type of the discount code, 1-percentage, 2-fixed_amount, the discountType of code, the discountPercentage will be effect when discountType is percentage, the discountAmount and currency will be effect when discountTYpe is fixed_amount

endTime

integer<*int64>

required

The end time of discount code can effect, utc time

startTime

integer<*int64>

required

The start time of discount code can effect, utc time

advance

boolean<*bool>

AdvanceConfig, 0-false,1-true, will enable all advance config if set true

currency

string<string>

The discount currency of discount code, available when discount_type is fixed_amount

cycleLimit

integer<int>

The count limitation of subscription cycle, each subscription is valid separately , 0-no limit

discountAmount

integer<int64>

The discount amount of the discount code, available when discount_type is fixed_amount

discountPercentage

integer<int64>

The discount percentage of discount code, 100=1%, available when discount_type is percentage

metadata

object

Metadata，Map

Show child attributes

name

string<*string>

The discount's name

planApplyGroup

object

Show child attributes

planApplyType

integer<*int>

plan apply type, 0-apply for all, 1-apply for plans specified, 2-exclude for plans specified, 3-Apply to Plans by Groups(Billing Period Included), 4-Apply to Plans except by Groups(Billing Period Included)

planIds

integer<int64>[]

Ids of plan which discount code can effect, default effect all plans if not set

quantity

integer<*int64>

Quantity of code, default 0, set 0 to disable quantity management

upgradeLongPlanOnly

boolean<*bool>

AdvanceConfig, true or false, will forbid for all except upgrade to longer plan if set true

upgradeOnly

boolean<*bool>

AdvanceConfig, true or false, will forbid for all except same interval upgrade action if set true

userIds

integer<int64>[]

Ids of user which discount code can effect, default effect all users if not set

userLimit

integer<*int>

AdvanceConfig, The limit of every customer can apply, the recurring apply not involved, 0-unlimited

userScope

integer<*int>

AdvanceConfig, Apply user scope,0-for all, 1-for only new user, 2-for only renewals, renewals is upgrade&downgrade&renew

Response

200 - application/json

code

integer<int>

data

object

Show child attributes

merchantId

integer<int64>

message

string<string>

redirect

string<string>

requestId

string<string>

Get Discount Code List Quantity Increment

Start Here

Core Concepts

Guides

Reference

Migration and Deployment

New Discount Code

Endpoint Overview

Authorization

Parameters

Request body

Request examples

cURL

Sandbox

Response

Error handling

Authorizations

Body

Response

​Endpoint Overview

​Authorization

​Parameters

​Request body

​Request examples

​cURL

​Sandbox

​Response

​Error handling

Authorizations

Body

Response

Endpoint Overview

Authorization

Parameters

Request body

Request examples

cURL

Sandbox

Response

Error handling