Skip to main content
GET
Get Subscription List

Endpoint Overview

GET https://api.unibee.dev/merchant/subscription/list Get Subscription List

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.

Query parameters


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.

Query Parameters

userId
integer<int64>

UserId

externalUserId
string<string>

ExternalUserId

searchKey
string<string>

Search SubscriptionId|Email

Email
string<string>

The filter email of subscription user

status
integer<int>[]

Filter, Default All,Status,1-Pending|2-Active|3-Suspend | 4-Cancel | 5-Expire | 6- Suspend| 7-Incomplete | 8-Processing | 9-Failed

currency
string<string>

The currency of subscription

planIds
integer<int64>[]

The filter ids of plan

planTagFilter
object

Filter by plan tags. Omit or empty tagIds = no tag filter. When planIds is also set, results use union OR.

productIds
integer<int64>[]

The filter ids of product, invalid if planIds is provided

amountStart
integer<*int64>

The filter start amount of subscription

amountEnd
integer<*int64>

The filter end amount of subscription

sortField
string<string>

Sort Field,gmt_create|gmt_modify,Default gmt_modify

sortType
string<string>

Sort Type,asc|desc,Default desc

page
integer<int>

Page, Start With 0

count
integer<int>

Count Of Page

createTimeStart
integer<int64>

CreateTimeStart,UTC timestamp,seconds

createTimeEnd
integer<int64>

CreateTimeEnd,UTC timestamp,seconds

Response

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