GET - Get Organization Subscription Info

Purpose

This API is used to retrieve the organization's subscription details, including the base plan, available add-ons, billing currency, plan expiry date, and the status of eDiscovery, backup, and retention flags.

OAuth Scope

Use the scope

ZohoMail.organization.subscriptions.ALL (or) ZohoMail.organization.subscriptions.READ

to generate the Authtoken.

ALL - Full access to the organization.

READ - Read an organization's subscription details.

Request URL

Method: GET

https://mailadmin.zoho.com/api/organization/{zoid}/subscriptionInfo

Path Parameters

zoid long
- This denotes the unique Zoho Organization Identifier for the organization.
- This parameter can be retrieved from the Get Organization Details API.

Response Body (JSON Object)

status JSON Object
This JSON object contains the status details of the response. The following parameters are included in the object:
- code int
  - Specifies the HTTP status code, where 200 indicates success.
- description string
  - Specifies the information about the returned status code.
data JSON Object
This JSON object contains the complete subscription and add-on details of the organization. The following parameters are returned.
- currencyType string
  - Specifies the currency code used in billing the organization's subscription.
  - Examples: INR, USD
- autoAllocationPercentage int
  - Specifies the threshold percentage of mailbox quota at which the add-on storage has be automatically allocated to the user.
  - This parameter is applicable only when autoAllocation parameter is set to true.
- addOns JSON array of JSON object
  The addOns is a JSON array that contains two distinct entry types.
  - Objects containing the field PLANNAME are base plan entries.
  - Objects containing the field ADDONNAME are storage add-on entries.
  Below parameters are returned for the base subscription plan(s).
  - planStorage int
    - Specifies the storage in GB, allocated per user under the plan.
  - PROPVALUE int
    - Specifies the total number of licenses purchased(Plan Purchased Count) for the plan.
  - PLANNAME string
    - Specifies the name of the plan.
    - Examples: Mail Lite, Mail Premium
  - PROPNAME int
    - Specifies the unique code to identify the base plan.
  - planCategory string
    - Specifies the plan category.
    - Examples: Mail_ONLY, WORKPLACE
  - ALLOTEDUSER int
    - Specifies the number of user licenses purchased under this plan.
  Below parameters are returned for each storage add-on SKU(Store Keeping Unit) associated with the subscription.
  - PROPVALUE int
    - Specifies the total number of licenses purchased(Plan Purchased Count) for the add-on.
  - PROPNAME int
    - Specifies the unique property code to identify the storage add-on.
  - ADDONSTORAGE int
    - Specifies the storage capacity of one unit, in GB, provided under this add-on.
  - ALLOTEDUSER int
    - Specifies the number of users in the organization currently using this add-on.
    - The value 0 indicates that the add-on has been purchased, but no users have been assigned yet.
  - ADDONNAME string
    - Specifies the display name of the add-on storage.
    - Examples: 5 gb, 100 gb
  Note:
  Preserve the legacy uppercase keys of PLANNAME, PROPNAME, PROPVALUE, ALLOTEDUSER, ADDONNAME, ADDONSTORAGE for backward compatibility.
- adminPrivilege string
  - Indicates whether admin privilege is enabled for the subscription modules.
  - Allowed values:
    - 0 - Disabled
    - 1 - Enabled
- autoAllocation boolean
  - Indicates whether the add-on storage can be automatically allocated to the users, when their mailbox quota exceeds the autoAllocationPercentage.
- iseDiscoveryStorageEnabled boolean
  - Indicates whether the eDiscovery storage is enabled for the organization.
    - true - Enabled
    - false - Disabled
- isOfflineSubscription boolean
  - Indicates whether the subscription is managed offline, via manual or enterprise billing, or managed online.
    - true - Managed offline
    - false - Managed through online store
- isMixedPlan boolean
  - Indicates whether the users in the organization are a part of multiple subscription plans.
  - True if the users are subscribed to multiple plans.
- subscriptionType int
  - Specifies the unique code of the subscription type.
    - 1 - Standard paid subscription plan
    - 11 - Trial or promotional plan
- isBackupAllowed boolean
  - Indicates whether the backup feature is included in the subscription.
    - true - Backup feature is included
    - false - Backup feature is not included
- expiryTime string(epoch ms)
  - Specifies the subscription expiry time in epoch milliseconds, that is returned as a string.
  Note:
  Since expiryTime is returned as a string(not a number), convert the value to long before performing any date arithmetic operation.
- isDocAllowed boolean
  - Indicates whether Zoho Workdrive is included in the subscription.
    - true - Available
    - false - Not available
- discountType int
  - Specifies the type of discount applied to the subscription.
  - Allowed values:
    - 0 - No discount is applied
    - -1 - Not applicable for discounts
    - Any positive value - Some promotional discount is applied
- isRetentionAllowed boolean
  - Indicates whether the email retention feature is included in the subscription.
    - true - Retention feature is included
    - false - Retention feature is not included

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mailadmin.zoho.com/api/organization/1234567890/subscriptionInfo" \
-X GET \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Zoho-oauthtoken 1***************"

Sample Success Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": {
    "currencyType": "INR",
    "autoAllocationPercentage": 100,
    "addOns": [
      {
        "planStorage": 5,
        "PROPVALUE": 291,
        "PLANNAME": "Mail Lite",
        "PROPNAME": 92,
        "planCategory": "MAIL_ONLY",
        "ALLOTEDUSER": 285
      },
      {
        "PROPVALUE": 1000,
        "PROPNAME": 12,
        "ADDONSTORAGE": 10,
        "ALLOTEDUSER": 3,
        "ADDONNAME": "10 gb"
      },
      {
        "PROPVALUE": 1000,
        "PROPNAME": 13,
        "ADDONSTORAGE": 15,
        "ALLOTEDUSER": 4,
        "ADDONNAME": "15 gb"
      }
    ],
    "adminPrivilege": "1",
    "autoAllocation": true,
    "iseDiscoveryStorageEnabled": false,
    "isOfflineSubscription": false,
    "isMixedPlan": false,
    "subscriptionType": 11,
    "isBackupAllowed": false,
    "expiryTime": "1762148966674",
    "isDocAllowed": false,
    "discountType": -1,
    "isRetentionAllowed": false
  }
}

Sample Error Response

Copied{
  "status": {
    "code": 401,
    "description": "Authentication failed",
    "moreInfo": "Invalid OAuth token"
  }
}