Get Subscriptions

GET

/subscriptions

Returns a paginated list of subscriptions with optional filtering.

Filter by subscription ID, domain, status, or date range.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Query Params

Responses

🟢200Success

application/json

Subscriptions fetched successfully

Bodyapplication/json

🟠400Bad Request — invalid pagination

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/subscriptions?componentSubscriptionId=sub_V2M9KP3XAQZL&domain=acmecorp.com&status=undefined&startDate=2025-01-01&endDate=2025-12-31&page=1&limit=20' \
--header 'cmr-x-api-key: <api-key>'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "Subscriptions fetched successfully",
    "data": {
        "subscriptions": [
            {
                "subscriptionId": "sub_V2M9KP3XAQZL",
                "subscriptionStatus": "ACTIVE",
                "totalMailboxQuantity": 3,
                "billingCycle": "MONTHLY",
                "pricePerMailbox": 3.5,
                "periodStart": "2025-01-01T00:00:00.000Z",
                "periodEnd": "2025-02-01T00:00:00.000Z",
                "serviceProvider": "GOOGLE",
                "autoRenew": true,
                "userId": "H8M9JV2S9HMPYFQW393AZHQVD4XM",
                "domain": "acmecorp.com",
                "createdAt": "2025-01-01T00:00:00.000Z"
            }
        ],
        "pagination": {
            "totalSearchedCount": 42,
            "currentPage": 1,
            "nextPage": 2,
            "totalPages": 3
        }
    }
}

Modified at 2026-08-06 06:20:56

Recreate Subscription

Renew Subscriptions