New Subscription Payment

POST /merchant/subscription/payment/new

New Subscription Payment

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/subscription/payment/new \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "gatewayId": 123,
  "cancelUrl": "<string>",
  "countryCode": "<string>",
  "currency": "<string>",
  "description": "<string>",
  "email": "<string>",
  "externalPaymentId": "<string>",
  "externalUserId": "<string>",
  "gasPayer": "<string>",
  "items": [
    {
      "amount": 123,
      "amountExcludingTax": 123,
      "currency": "<string>",
      "description": "<string>",
      "name": "<string>",
      "quantity": 123,
      "tax": 123,
      "taxPercentage": 123,
      "unitAmountExcludingTax": 123
    }
  ],
  "metadata": {},
  "name": "<string>",
  "planId": 123,
  "redirectUrl": "<string>",
  "totalAmount": 123,
  "userId": 123
}
'

200

{
  "code": 123,
  "data": {
    "action": {},
    "externalPaymentId": "<string>",
    "link": "<string>",
    "paymentId": "<string>",
    "status": 123
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/subscription/payment/new

New Subscription Payment

---

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
cancelUrl	string	No	CancelUrl
countryCode	string	No	CountryCode
currency	string	No	Currency, either Currency&TotalAmount or PlanId needed
description	string	No	Description
email	string	No	Email, either ExternalUserId&Email or UserId needed
externalPaymentId	string	No	ExternalPaymentId should unique for payment
externalUserId	string	No	ExternalUserId, unique, either ExternalUserId&Email or UserId needed
gasPayer	string	No	who pay the gas, merchant|user
gatewayId	integer	Yes	GatewayId
items	array	No	Items
metadata	object	No	Metadata，Map
name	string	No	Name
planId	integer	No	PlanId, either TotalAmount&Currency or PlanId needed
redirectUrl	string	No	Redirect Url
totalAmount	integer	No	Total PaymentAmount, Cent, either TotalAmount&Currency or PlanId needed
userId	integer	No	UserId, either ExternalUserId&Email or UserId needed

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/subscription/payment/new" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "cancelUrl": "https://example.com",
  "countryCode": "",
  "currency": "",
  "description": "",
  "email": "[e-mail]",
  "externalPaymentId": "id_example",
  "externalUserId": "id_example",
  "gasPayer": "",
  "gatewayId": 0,
  "items": [],
  "metadata": {},
  "name": "",
  "planId": 0,
  "redirectUrl": "https://example.com",
  "totalAmount": 0,
  "userId": 0
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/subscription/payment/new" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "cancelUrl": "https://example.com",
  "countryCode": "",
  "currency": "",
  "description": "",
  "email": "[e-mail]",
  "externalPaymentId": "id_example",
  "externalUserId": "id_example",
  "gasPayer": "",
  "gatewayId": 0,
  "items": [],
  "metadata": {},
  "name": "",
  "planId": 0,
  "redirectUrl": "https://example.com",
  "totalAmount": 0,
  "userId": 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.action	object
data.externalPaymentId	string	The external unique id of payment
data.link	string
data.paymentId	string	The unique id of payment
data.status	integer	Status, 10-Created|20-Success|30-Failed|40-Cancelled
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

gatewayId · integer<int64> · required

GatewayId

cancelUrl · string<string>

CancelUrl

countryCode · string<string>

CountryCode

currency · string<string>

Currency, either Currency&TotalAmount or PlanId needed

description · string<string>

Description

email · string<string>

Email, either ExternalUserId&Email or UserId needed

externalPaymentId · string<string>

ExternalPaymentId should unique for payment

externalUserId · string<string>

ExternalUserId, unique, either ExternalUserId&Email or UserId needed

gasPayer · string<string>

who pay the gas, merchant|user

items · object[]

Items

Show child attributes

metadata · object

Metadata，Map

Show child attributes

name · string<string>

Name

planId · integer<int64>

PlanId, either TotalAmount&Currency or PlanId needed

redirectUrl · string<string>

Redirect Url

totalAmount · integer<int64>

Total PaymentAmount, Cent, either TotalAmount&Currency or PlanId needed

userId · integer<int64>

UserId, either ExternalUserId&Email or UserId needed

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>