Subscription Plans Details

This API retrieves the subscription plan details including subscription Id, Tier Id, price etc..

Get the details of the subscription plans.

GET {API_URL}/client/subscription-plans

Auth required: YES

Please pass your API key as the username and API secret as the password as Basic Auth to access the endpoint

Query Parameters

Name	DataType	Description	Type
from	string	Start date-time for filtering subscription plans (ISO 8601 format)	Optional
to	string	End date-time for filtering subscription plans (ISO 8601 format)	Optional
subscriptionId	string	Subscription Id of the plan	Optional
pageNumber	integer	It indicates the current page of results that the client is requesting from a larger dataset. Default value is 10 Records in 1 pageNumber	Optional
showRecords	integer	Total records that you want to show in a page no.	Optional

200: OK

{
    "subscriptionPlans": [
        {
            "freeTrial": {
                "enabled": false,
                "duration": null
            },
            "_id": "66052fa93d9bc90560386b94",
            "benefits": "Digital Subscription Portable carry with you anytime anywhere , Locators- Id Portable carry with you anytime anywhere,Digital Subscription Portable carry with you anytime anywhere , Locators- Id Portable carry with you anytime anywhere,Digital Subscription Portable carry with you anytime anywhere , Locators- Id Portable carry with you anytime anywhere, Digital Subscription Portable carry with you anytime anywhere , Locators- Id Portable carry with you anytime anywhere,Digital Subscription Portable carry with you anytime anywhere , Locators- Id Portable carry with you anytime anywhere,Digital Subscription Portable carry with you anytime anywhere , Locators- Id Portable carry with you anytime anywhere, Digital Subscription Portable carry with you anytime anywhere , Locators- Id Portable carry with you anytime anywhere,Digital Subscription Portable carry with you anytime anywhere , Locators- Id Portable carry with you anytime anywhere,Digital Subscription Portable carry with you anytime anywhere , Locators- Id Portable carry with you anytime anywhere",
            "physical": true,
            "digital": true,
            "adFree": false,
            "couponsEnabled": true,
            "partialAccess": false,
            "sectionsInclude": [],
            "authorsInclude": [],
            "sectionsExclude": [],
            "authorsExclude": [],
            "tagsInclude": [],
            "tagsExclude": [],
            "title": "Pure Physcial",
            "tiers": [
                {
                    "priceOverrides": {
                        "country": []
                    },
                    "tierName": null,
                    "price": 500,
                    "currency": "INR",
                    "duration": 1,
                    "basePrice": 0,
                    "offers": [
                        "6618cc8791683113b883b45a",
                        "6618d6ab91683113b883b47b",
                        "6618da9a91683113b883b48f",
                        "6663078e93df6a052d62fdd1"
                    ],
                    "_id": "668665db404fa5123f1943cb"
                }
            ],
            "billingCycleType": "ONE_TIME",
            "iconUrl": "https://bkt-conscent-public-stage.storage.googleapis.com/V2 Client 2/subscriptions/66052fa93d9bc90560386b94-b3ad67.png"
        }
    ],
    "pagination": {
        "totalRecords": 1,
        "pageNumber": 1,
        "pageSize": 50,
        "totalPages": 1
    }
}