Get Subscription Information

Get the information of subscribed and used service capacity.

Request URL

GET {base_url}/uc-subscription/api/v1/subscription

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
Path parameters
Parameter Required Type Description
serviceKeys No String The keys for services and parameters.
Note: Use commas to separate multiple keys.

Valid value:

  • novoone: NovoOne plan.
  • call_recording_srv: Call recording service.
  • white_label_srv: White label service.
  • transcription_srv: Transcription service.
  • ai_receptionist_srv: AI receptionist service (on-demand minute pack).
  • receptionist_pack_srv: AI receptionist service (monthly rolling plan).
  • geo_redundancy_srv: Geo redundancy service.
  • users: The number of tenant users.
  • tenants: The number of tenants.
  • concurrentCalls: The number of concurrent calls.
  • retentionTime: The retention period for recordings.
  • whiteLabel: The number of white label packs.
  • awsTranscription: The number of users who can use the transcription feature.
  • receptionist: The number of AI receptionist minutes.
  • receptionistPack: The number of AI receptionist monthly capacity packs.
  • geo: The geo redundancy capacity packs.
ucid No String The UC ID of the company.
Note:
  • You can obtain the company UC ID using the Get the Current User or Search Resellers interfaces.
  • If this parameter is not specified, the company UC ID of the current logged-in user is used.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Subscription> The complete subscription information.
Subscription
Parameter Type Description
ucId Integer The company UC ID.
services Array<Service> The list of subscribed services.

Service

Parameter Type Description
serviceKey String The service key.
  • novoone: NovoOne plan.
  • call_recording_srv: Call recording service.
  • white_label_srv: White label service.
  • transcription_srv: Transcription service.
  • ai_receptionist_srv: AI receptionist service (on-demand minute pack).
  • receptionist_pack_srv: AI receptionist service (monthly rolling plan).
  • geo_redundancy_srv: Geo redundancy service.
status String

The subscription status.

  • SUBSCRIBED: The service is subscribed.
  • EXPIRED: The service is expired.
subscriptionType String

The subscription type.

  • TRIAL: The trial subscription.
  • COMMERCIAL: The commercial subscription.
serviceType String The type of the service.
  • plan
  • service
expiryTime Integer The expiration time of the subscription, in Unix timestamp format (seconds).
gracePeriodEndTime Integer The end time of the seven-day grace period after the subscription expires, in Unix timestamp format (milliseconds).
visible Boolean Whether the service is visible on the portal.
  • true
  • false
params Array<Service_Parameter> The list of service parameters.
autoRenewStatus Boolean Whether auto-renewal is enabled.
  • true
  • false

Service_Parameter

Parameter Type Description
paramKey String The parameter key.
  • users: The number of tenant users.
  • tenants: The number of tenants.
  • concurrentCalls: The number of concurrent calls.
  • retentionTime: The retention period for recordings.
  • whiteLabel: The number of white label packs.
  • awsTranscription: The number of users who can use the transcription feature.
  • receptionist: The number of AI receptionist minutes.
  • receptionistPack: The number of AI receptionist monthly capacity packs.
  • geo: The geo redundancy capacity packs.
paramId String The ID of the parameter.
used Integer The used capacity.
Note: A value of -1 indicates that the capacity is unlimited.
total Integer The subscribed total capacity.
Note:
  • A value of -1 indicates that the capacity is unlimited.
  • This parameter does not include the bonus capacity.
available Integer The available capacity.
Note:
  • A value of -1 indicates that the capacity is unlimited.
  • This parameter does not include the bonus capacity.
unit String The unit of the parameter.
  • count
  • minute
packageValue Integer The value of the package.
packageUnit String The unit of the package.
  • min
  • day
  • month
  • year
visible Boolean Whether the parameter is visible on the portal.
  • true
  • false
bonus Integer The bonus capacity.
allocationDetails Object<Allocation_Details> The allocation details of the used capacity.

Allocation_Details

Parameter Type Description
selfColleagueUsed Integer The capacity assigned to your own tenants.
Note: A value of -1 indicates that the capacity is unlimited.
resellerAssigned Integer The capacity assigned to resellers.
Note: A value of -1 indicates that the capacity is unlimited.

Example

Request example

GET /uc-subscription/api/v1/subscription HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MjU2MzM1MywiaWF0IjoxNzkyNTQxNzUzLCJqdGkiOiIyZjRmYzAwMy0zNjNlLTQxYTMtOGNjMy02YTc4ODkyM2RkMDUiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.sUhcJCOi1PPz45Z88LE4MfHFifCWwnFMmpaWrIfaCLJa6f-hHf4-n4YYS1hThBtQ63D25-p-ZF-K584n3y9LKztUqaEHvI1GMmhTEJEx13EId56H0MUrxKdQEQM1MwKmTD_CAW2jh3IN3bs3LFJRIF8AUB6qoyNZGU-4nnFVS3OZlK2CcAyUiT-JiKpJpoOzluNdUI4lIcgYRUsycXtmSrf0pZuZbN-hRRpdx64S-HV4ZSKRNA34Utpgy7ZmeXyIxaVNOWKwTZyXd8SM6GXn2Br1KO7U_jOXaikQQfvZPvv_2vtKVTq-i3IflwbwhiqG2xJT9MhXDR4VWz0if3B8pg

Response example

HTTP/1.1 200 OK
{
  "result": {
    "ucId": "3076913644890832896",
    "services": [
      {
        "serviceKey": "novoone",
        "status": "SUBSCRIBED",
        "subscriptionType": "COMMERCIAL",
        "serviceType": "plan",
        "expiryTime": 1841119906000,
        "gracePeriodEndTime": 1841724706000,
        "visible": true,
        "params": [
          {
            "paramKey": "users",
            "paramId": "bb75920690924186a37f73f7ac29618d",
            "used": 232,
            "total": 1026,
            "available": 794,
            "unit": "count",
            "visible": true,
            "allocationDetails": {
              "selfColleagueUsed": 204,
              "resellerAssigned": 28
            }
          },
          {
            "paramKey": "tenants",
            "paramId": "1581cbc2-8079-41f6-9251-0380cdef0ca8",
            "used": -1,
            "total": -1,
            "available": -1,
            "unit": "count",
            "visible": false,
            "allocationDetails": {
              "selfColleagueUsed": 0,
              "resellerAssigned": -1
            }
          },
          {
            "paramKey": "concurrentCalls",
            "paramId": "088f83b467274c5b8e3c0ec38520785d",
            "used": -1,
            "total": -1,
            "available": -1,
            "unit": "count",
            "visible": true,
            "allocationDetails": {
              "selfColleagueUsed": -1,
              "resellerAssigned": -1
            }
          }
        ],
        "autoRenewStatus": false
      },
      {
        "serviceKey": "call_recording_srv",
        "status": "SUBSCRIBED",
        "subscriptionType": "COMMERCIAL",
        "serviceType": "service",
        "expiryTime": 1841119906000,
        "gracePeriodEndTime": 1841724706000,
        "visible": true,
        "params": [
            {
                "paramKey": "retentionTime",
                "paramId": "fa43ea3f65294df18d16c024f619a958",
                "used": 5,
                "total": 18,
                "available": 13,
                "unit": "count",
                "packageValue": 1,
                "packageUnit": "year",
                "visible": true,
                "allocationDetails": {
                    "selfColleagueUsed": 3,
                    "resellerAssigned": 2
                }
            },
            {
                "paramKey": "retentionTime",
                "paramId": "57348aa04ab942179e06e311d4229e3c",
                "used": 12,
                "total": 31,
                "available": 19,
                "unit": "count",
                "packageValue": 1,
                "packageUnit": "month",
                "visible": true,
                "allocationDetails": {
                    "selfColleagueUsed": 12,
                    "resellerAssigned": 2
                }
            }
        ],
        "autoRenewStatus": false
    }
    ]
  },
  "requestId": "5433d542e54146140b82281f871e150c",
  "code": "200",
  "message": "SUCCESS"
}