Get Customer Portal Url

GET /merchant/session/customer_portal_url

Get Customer Portal Url

cURL

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

200

{
  "code": 123,
  "data": {
    "url": "<string>"
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

GET https://api.unibee.dev/merchant/session/customer_portal_url

Get Customer Portal Url

---

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
email	string	No	Email, unique, either ExternalUserId&Email or UserId needed
userId	integer	No	UserId, unique, either ExternalUserId&Email or UserId needed
externalUserId	string	No	ExternalUserId, unique, either ExternalUserId&Email or UserId needed
productId	integer	No	Id of product, default product will use if productId not specified
planId	integer	No	Id of plan to update
vatCountryCode	string	No	Vat Country Code
returnUrl	string	No	ReturnUrl
cancelUrl	string	No	CancelUrl

---

Request examples

cURL

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

Sandbox

curl -X GET "https://api-sandbox.unibee.top/merchant/session/customer_portal_url" \
  -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.url	string	Url
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

email · string<string>

Email, unique, either ExternalUserId&Email or UserId needed

userId · integer<int64>

UserId, unique, either ExternalUserId&Email or UserId needed

externalUserId · string<string>

ExternalUserId, unique, either ExternalUserId&Email or UserId needed

productId · integer<int64>

Id of product, default product will use if productId not specified

planId · integer<int64>

Id of plan to update

vatCountryCode · string<string>

Vat Country Code

returnUrl · string<string>

ReturnUrl

cancelUrl · string<string>

CancelUrl

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>