Skip to main content
POST
Get Customer Portal Url

Endpoint Overview

POST https://api.unibee.dev/merchant/session/customer_portal_url Get Customer Portal Url

Authorization

All UniBee Merchant API requests require authentication via API key.

Parameters

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

Request body


Request examples

cURL

Sandbox


Response

Success responses return a JSON envelope with code, data, message, redirect, and requestId. code 0 indicates success.

Error handling

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
cancelUrl
string<string>

CancelUrl

email
string<string>

Email, unique, either ExternalUserId&Email or UserId needed

externalUserId
string<string>

ExternalUserId, unique, either ExternalUserId&Email or UserId needed

planId
integer<int64>

Id of plan to update

productId
integer<int64>

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

returnUrl
string<string>

ReturnUrl

userId
integer<int64>

UserId, unique, either ExternalUserId&Email or UserId needed

vatCountryCode
string<string>

Vat Country Code

Response

200 - application/json
code
integer<int>
data
object
merchantId
integer<int64>
message
string<string>
redirect
string<string>
requestId
string<string>