Skip to main content
GET
/
merchant
/
session
/
user_sub_update_url
Get User Subscription Update Page Url
curl --request GET \
  --url https://api.unibee.dev/merchant/session/user_sub_update_url \
  --header 'Authorization: Bearer <token>'
{
  "code": 123,
  "data": {
    "url": "<string>"
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.unibee.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Endpoint Overview

GET https://api.unibee.dev/merchant/session/user_sub_update_url Get User Subscription Update Page Url

​
Authorization

All UniBee Merchant API requests require authentication via API key.
HeaderRequiredDescription
AuthorizationYesBearer <your_api_key>
Content-TypeYesapplication/json (for request body)

​
Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

​
Query parameters

NameTypeRequiredDescription
emailstringNoEmail, unique, either ExternalUserId&Email or UserId needed
userIdintegerNoUserId, unique, either ExternalUserId&Email or UserId needed
externalUserIdstringNoExternalUserId, unique, either ExternalUserId&Email or UserId needed
productIdintegerNoId of product,default product will use if productId not specified
planIdintegerNoId of plan to update
vatCountryCodestringNoVat Country Code
returnUrlstringNoReturnUrl
cancelUrlstringNoCancelUrl

​
Request examples

​
cURL

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

​
Sandbox

curl -X GET "https://api-sandbox.unibee.top/merchant/session/user_sub_update_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.
FieldTypeDescription
codeintegerResponse code. 0 = success
dataobjectResponse payload
data.urlstringUrl
messagestringHuman-readable message
requestIdstringRequest ID for support

​
Error handling

HTTP statusMeaning
400Bad request — invalid or missing parameters. Check message in the body.
401Unauthorized — missing or invalid API key.
404Not found — invalid path or resource.
500Server 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
​
merchantId
integer<int64>
​
message
string<string>
​
redirect
string<string>
​
requestId
string<string>