Get Plan List

POST /merchant/plan/list

Get Plan List

cURL

curl --request POST \
  --url https://api.unibee.dev/merchant/plan/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billingIntervalMin": "<string>",
  "count": 123,
  "currency": "<string>",
  "intervalCounts": [
    123
  ],
  "intervalUnits": [
    "<string>"
  ],
  "page": 123,
  "planIds": [
    123
  ],
  "productIds": [
    123
  ],
  "publishStatus": 123,
  "searchKey": "<string>",
  "sortField": "<string>",
  "sortType": "<string>",
  "status": [
    123
  ],
  "type": [
    123
  ]
}
'

200

{
  "code": 123,
  "data": {
    "plans": [
      {
        "addonIds": [
          123
        ],
        "addons": [
          {
            "amount": 123,
            "bindingAddonIds": "<string>",
            "bindingOnetimeAddonIds": "<string>",
            "cancelAtTrialEnd": 123,
            "checkoutUrl": "<string>",
            "createTime": 123,
            "currency": "<string>",
            "description": "<string>",
            "disableAutoCharge": 123,
            "externalPlanId": "<string>",
            "extraMetricData": "<string>",
            "gasPayer": "<string>",
            "homeUrl": "<string>",
            "id": 123,
            "imageUrl": "<string>",
            "internalName": "<string>",
            "intervalCount": 123,
            "intervalUnit": "<string>",
            "merchantId": 123,
            "metadata": {},
            "metricLimits": [
              {
                "metricId": 123,
                "metricLimit": 123
              }
            ],
            "metricMeteredCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "metricRecurringCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "multiCurrencies": [
              {
                "amount": 123,
                "autoExchange": true,
                "currency": "<string>",
                "disable": true,
                "exchangeRate": 123
              }
            ],
            "planName": "<string>",
            "productId": 123,
            "publishStatus": 123,
            "status": 123,
            "taxPercentage": 123,
            "trialAmount": 123,
            "trialDemand": "<string>",
            "trialDurationTime": 123,
            "type": 123,
            "usVATConfig": {
              "active": true,
              "fromAddress": {
                "address": "<string>",
                "city": "<string>",
                "countryCode": "<string>",
                "state": "<string>",
                "verified": true,
                "zipCode": "<string>"
              },
              "nexusAddresses": [
                {
                  "address": "<string>",
                  "city": "<string>",
                  "countryCode": "<string>",
                  "state": "<string>",
                  "verified": true,
                  "zipCode": "<string>"
                }
              ],
              "sellOnUSOnly": true,
              "taxCode": "<string>",
              "toAddress": {
                "address": "<string>",
                "city": "<string>",
                "countryCode": "<string>",
                "state": "<string>",
                "verified": true,
                "zipCode": "<string>"
              }
            }
          }
        ],
        "checkAddressViaGateway": true,
        "globalUSVATActive": true,
        "metricMeteredCharge": [
          {
            "metricId": 123,
            "chargeType": 123,
            "graduatedAmounts": [
              {
                "endValue": 123,
                "flatAmount": 123,
                "perAmount": 123,
                "startValue": 123
              }
            ],
            "merchantMetric": {
              "aggregationProperty": "<string>",
              "aggregationType": 123,
              "archived": true,
              "carryoverProrationEnabled": true,
              "code": "<string>",
              "createTime": 123,
              "gmtModify": 123,
              "id": 123,
              "merchantId": 123,
              "metaData": {},
              "metricDescription": "<string>",
              "metricName": "<string>",
              "prorationRefundEnabled": true,
              "type": 123,
              "unit": "<string>"
            },
            "standardAmount": 123,
            "standardStartValue": 123
          }
        ],
        "metricPlanLimits": [
          {
            "createTime": 123,
            "gmtModify": 123,
            "id": 123,
            "merchantId": 123,
            "merchantMetric": {
              "aggregationProperty": "<string>",
              "aggregationType": 123,
              "archived": true,
              "carryoverProrationEnabled": true,
              "code": "<string>",
              "createTime": 123,
              "gmtModify": 123,
              "id": 123,
              "merchantId": 123,
              "metaData": {},
              "metricDescription": "<string>",
              "metricName": "<string>",
              "prorationRefundEnabled": true,
              "type": 123,
              "unit": "<string>"
            },
            "metricId": 123,
            "metricLimit": 123,
            "planId": 123,
            "quantity": 123
          }
        ],
        "metricRecurringCharge": [
          {
            "metricId": 123,
            "chargeType": 123,
            "graduatedAmounts": [
              {
                "endValue": 123,
                "flatAmount": 123,
                "perAmount": 123,
                "startValue": 123
              }
            ],
            "merchantMetric": {
              "aggregationProperty": "<string>",
              "aggregationType": 123,
              "archived": true,
              "carryoverProrationEnabled": true,
              "code": "<string>",
              "createTime": 123,
              "gmtModify": 123,
              "id": 123,
              "merchantId": 123,
              "metaData": {},
              "metricDescription": "<string>",
              "metricName": "<string>",
              "prorationRefundEnabled": true,
              "type": 123,
              "unit": "<string>"
            },
            "standardAmount": 123,
            "standardStartValue": 123
          }
        ],
        "onetimeAddonIds": [
          123
        ],
        "onetimeAddons": [
          {
            "amount": 123,
            "bindingAddonIds": "<string>",
            "bindingOnetimeAddonIds": "<string>",
            "cancelAtTrialEnd": 123,
            "checkoutUrl": "<string>",
            "createTime": 123,
            "currency": "<string>",
            "description": "<string>",
            "disableAutoCharge": 123,
            "externalPlanId": "<string>",
            "extraMetricData": "<string>",
            "gasPayer": "<string>",
            "homeUrl": "<string>",
            "id": 123,
            "imageUrl": "<string>",
            "internalName": "<string>",
            "intervalCount": 123,
            "intervalUnit": "<string>",
            "merchantId": 123,
            "metadata": {},
            "metricLimits": [
              {
                "metricId": 123,
                "metricLimit": 123
              }
            ],
            "metricMeteredCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "metricRecurringCharge": [
              {
                "chargeType": 123,
                "graduatedAmounts": [
                  {
                    "endValue": 123,
                    "flatAmount": 123,
                    "perAmount": 123,
                    "startValue": 123
                  }
                ],
                "metricId": 123,
                "standardAmount": 123,
                "standardStartValue": 123
              }
            ],
            "multiCurrencies": [
              {
                "amount": 123,
                "autoExchange": true,
                "currency": "<string>",
                "disable": true,
                "exchangeRate": 123
              }
            ],
            "planName": "<string>",
            "productId": 123,
            "publishStatus": 123,
            "status": 123,
            "taxPercentage": 123,
            "trialAmount": 123,
            "trialDemand": "<string>",
            "trialDurationTime": 123,
            "type": 123,
            "usVATConfig": {
              "active": true,
              "fromAddress": {
                "address": "<string>",
                "city": "<string>",
                "countryCode": "<string>",
                "state": "<string>",
                "verified": true,
                "zipCode": "<string>"
              },
              "nexusAddresses": [
                {
                  "address": "<string>",
                  "city": "<string>",
                  "countryCode": "<string>",
                  "state": "<string>",
                  "verified": true,
                  "zipCode": "<string>"
                }
              ],
              "sellOnUSOnly": true,
              "taxCode": "<string>",
              "toAddress": {
                "address": "<string>",
                "city": "<string>",
                "countryCode": "<string>",
                "state": "<string>",
                "verified": true,
                "zipCode": "<string>"
              }
            }
          }
        ],
        "plan": {
          "amount": 123,
          "bindingAddonIds": "<string>",
          "bindingOnetimeAddonIds": "<string>",
          "cancelAtTrialEnd": 123,
          "checkoutUrl": "<string>",
          "createTime": 123,
          "currency": "<string>",
          "description": "<string>",
          "disableAutoCharge": 123,
          "externalPlanId": "<string>",
          "extraMetricData": "<string>",
          "gasPayer": "<string>",
          "homeUrl": "<string>",
          "id": 123,
          "imageUrl": "<string>",
          "internalName": "<string>",
          "intervalCount": 123,
          "intervalUnit": "<string>",
          "merchantId": 123,
          "metadata": {},
          "metricLimits": [
            {
              "metricId": 123,
              "metricLimit": 123
            }
          ],
          "metricMeteredCharge": [
            {
              "chargeType": 123,
              "graduatedAmounts": [
                {
                  "endValue": 123,
                  "flatAmount": 123,
                  "perAmount": 123,
                  "startValue": 123
                }
              ],
              "metricId": 123,
              "standardAmount": 123,
              "standardStartValue": 123
            }
          ],
          "metricRecurringCharge": [
            {
              "chargeType": 123,
              "graduatedAmounts": [
                {
                  "endValue": 123,
                  "flatAmount": 123,
                  "perAmount": 123,
                  "startValue": 123
                }
              ],
              "metricId": 123,
              "standardAmount": 123,
              "standardStartValue": 123
            }
          ],
          "multiCurrencies": [
            {
              "amount": 123,
              "autoExchange": true,
              "currency": "<string>",
              "disable": true,
              "exchangeRate": 123
            }
          ],
          "planName": "<string>",
          "productId": 123,
          "publishStatus": 123,
          "status": 123,
          "taxPercentage": 123,
          "trialAmount": 123,
          "trialDemand": "<string>",
          "trialDurationTime": 123,
          "type": 123,
          "usVATConfig": {
            "active": true,
            "fromAddress": {
              "address": "<string>",
              "city": "<string>",
              "countryCode": "<string>",
              "state": "<string>",
              "verified": true,
              "zipCode": "<string>"
            },
            "nexusAddresses": [
              {
                "address": "<string>",
                "city": "<string>",
                "countryCode": "<string>",
                "state": "<string>",
                "verified": true,
                "zipCode": "<string>"
              }
            ],
            "sellOnUSOnly": true,
            "taxCode": "<string>",
            "toAddress": {
              "address": "<string>",
              "city": "<string>",
              "countryCode": "<string>",
              "state": "<string>",
              "verified": true,
              "zipCode": "<string>"
            }
          }
        },
        "product": {
          "createTime": 123,
          "description": "<string>",
          "homeUrl": "<string>",
          "id": 123,
          "imageUrl": "<string>",
          "isDeleted": 123,
          "merchantId": 123,
          "metaData": "<string>",
          "productName": "<string>",
          "status": 123,
          "usVATConfig": {
            "active": true,
            "fromAddress": {
              "address": "<string>",
              "city": "<string>",
              "countryCode": "<string>",
              "state": "<string>",
              "verified": true,
              "zipCode": "<string>"
            },
            "nexusAddresses": [
              {
                "address": "<string>",
                "city": "<string>",
                "countryCode": "<string>",
                "state": "<string>",
                "verified": true,
                "zipCode": "<string>"
              }
            ],
            "sellOnUSOnly": true,
            "taxCode": "<string>",
            "toAddress": {
              "address": "<string>",
              "city": "<string>",
              "countryCode": "<string>",
              "state": "<string>",
              "verified": true,
              "zipCode": "<string>"
            }
          }
        },
        "sellOnUSOnly": true
      }
    ],
    "total": 123
  },
  "merchantId": 123,
  "message": "<string>",
  "redirect": "<string>",
  "requestId": "<string>"
}

Endpoint Overview

POST https://api.unibee.dev/merchant/plan/list

Get Plan List

---

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
billingIntervalMin	string	No	Minimum billing interval in ISO 8601 duration (date part only, Y/M/W/D), e.g. P1M, P6M, P1Y, P2W, P10D
count	integer	No	Count Of Per Page, Default 100
currency	string	No	Filter Currency
intervalCounts	array	No	Filter by interval count; ignored when billingIntervalMin is provided
intervalUnits	array	No	Filter by interval unit (day|week|month|year); ignored when billingIntervalMin is provided
page	integer	No	Page, Start 0
planIds	array	No	filter id list of plan, default all
productIds	array	No	filter id list of product, default all product(0) used if not specified
publishStatus	integer	No	Filter, Default All，PublishStatus，1-UnPublished，2-Published
searchKey	string	No	Search Key, plan name or description
sortField	string	No	Sort Field，plan_name|gmt_create|gmt_modify，Default gmt_create
sortType	string	No	Sort Type，asc|desc，Default desc
status	array	No	Filter, Default All，,Status，1-Editing，2-Active，3-InActive，4-SoftArchive, 5-HardArchive
type	array	No	1-main plan，2-addon plan,3-onetime

---

Request examples

cURL

curl -X POST "https://api.unibee.dev/merchant/plan/list" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "billingIntervalMin": "",
  "count": 0,
  "currency": "",
  "intervalCounts": [],
  "intervalUnits": [],
  "page": 0,
  "planIds": [],
  "productIds": [],
  "publishStatus": 0,
  "searchKey": "",
  "sortField": "",
  "sortType": "",
  "status": [],
  "type": []
}'

Sandbox

curl -X POST "https://api-sandbox.unibee.top/merchant/plan/list" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "billingIntervalMin": "",
  "count": 0,
  "currency": "",
  "intervalCounts": [],
  "intervalUnits": [],
  "page": 0,
  "planIds": [],
  "productIds": [],
  "publishStatus": 0,
  "searchKey": "",
  "sortField": "",
  "sortType": "",
  "status": [],
  "type": []
}'

---

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.plans	array	Plans
data.total	integer	Total
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

billingIntervalMin · string<string>

Minimum billing interval in ISO 8601 duration (date part only, Y/M/W/D), e.g. P1M, P6M, P1Y, P2W, P10D

count · integer<int>

Count Of Per Page, Default 100

currency · string<string>

Filter Currency

intervalCounts · integer<int>[]

Filter by interval count; ignored when billingIntervalMin is provided

intervalUnits · string<string>[]

Filter by interval unit (day|week|month|year); ignored when billingIntervalMin is provided

page · integer<int>

Page, Start 0

planIds · integer<int64>[]

filter id list of plan, default all

productIds · integer<int64>[]

filter id list of product, default all product(0) used if not specified

publishStatus · integer<int>

Filter, Default All，PublishStatus，1-UnPublished，2-Published

searchKey · string<string>

Search Key, plan name or description

sortField · string<string>

Sort Field，plan_name|gmt_create|gmt_modify，Default gmt_create

sortType · string<string>

Sort Type，asc|desc，Default desc

status · integer<int>[]

Filter, Default All，,Status，1-Editing，2-Active，3-InActive，4-SoftArchive, 5-HardArchive

type · integer<int>[]

1-main plan，2-addon plan,3-onetime

Response

200 - application/json

code · integer<int>

data · object

Show child attributes

merchantId · integer<int64>

message · string<string>

redirect · string<string>

requestId · string<string>