Get All Subscriptions

Retrieves a paginated list of all subscription records for the user, including both active and historical subscription plans.

Query Parameters

Name	Type	Required	Description
`limit`	`number`	No	Maximum number of subscription records to return per page. Default: `50`
`page`	`number`	No	Page number for pagination, starting from 1. Default: `1`

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "status": 200,
    "message": "Subscriptions fetched successfully",
    "data": {
        "subscriptions": [
            {
                "subscriptionId": "1BNTZJG2Q041JWGS3NY9E1BZ9APA",
                "subscriptionStatus": "ACTIVE",
                "totalMailboxQuantity": 1,
                "billingCycle": "MONTHLY",
                "pricePerMailbox": 8,
                "periodStart": "2025-01-10T11:18:31.479Z",
                "periodEnd": "2025-02-10T11:18:31.479Z",
                "serviceProvider": "GOOGLE",
                "autoRenew": true,
                "userId": "USR94KD7S2LQ8X5M1Z0",
                "domain": "bestpremium.org"
            },
            {
                "subscriptionId": "WMMJPPBGDV4KXFP7KG66AAJBNE6K",
                "subscriptionStatus": "ACTIVE",
                "userId": "UVR14KD8S2LQ89M5M1W0",
                "totalMailboxQuantity": 2,
                "billingCycle": "MONTHLY",
                "pricePerMailbox": 8,
                "periodStart": "2025-01-10T11:42:24.958Z",
                "periodEnd": "2025-02-10T11:42:24.958Z",
                "serviceProvider": "GOOGLE",
                "autoRenew": false,
                "domain": "myfool.org"
            }
        ],
        "pagination": {
            "totalSearchedCount": 2,
            "currentPage": 1,
            "nextPage": 2,
            "totalPages": 1
        }
    }
}

Query Parameters#

Request

Request Code Samples

Responses

Query Parameters