Get all subscriptions

GET

/v2/subscriptions

Fetch all subscriptions associated with the authenticated user, including active, cancelled, and expired subscriptions, along with plan and billing details.

Request

Query Params

Header Params

Responses

🟢200Success

application/json

Body

🟠400Badf Request

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.zapmail.ai/api/v2/subscriptions?status=ACTIVE&contains' \
--header 'x-auth-zapmail;' \
--header 'x-workspace-key;' \
--header 'x-service-provider;'

Response Example

200 - Success

{
    "status": 200,
    "message": "User subscriptions",
    "data": [
        {
            "id": "abcd1234-5678-90ef-ghij-klmn12345678",
            "subscriptionId": "sub_1XYZabc1234567890QWERTY",
            "subscriptionStatus": "ACTIVE",
            "plan": "ENTERPRISE",
            "price": 199,
            "totalMailboxQuantity": 500,
            "periodStart": "2025-01-01T08:00:00.000Z",
            "periodEnd": "2025-02-01T08:00:00.000Z",
            "subscriptionCreationDate": "2024-12-01T08:00:00.000Z",
            "planUpgradeCancelPossible": false,
            "paymentFailureMessage": null,
            "invoiceDetails": "https://invoice.example.com/i/test_invoicenumber_1"
        },
        {
            "id": "efgh5678-1234-90ij-klmn-opqr45678901",
            "subscriptionId": "sub_2XYZabc1234567890ASDFGH",
            "subscriptionStatus": "CANCELLED",
            "plan": "BASIC",
            "price": 29,
            "totalMailboxQuantity": 20,
            "periodStart": "2024-06-15T08:00:00.000Z",
            "periodEnd": "2024-07-15T08:00:00.000Z",
            "subscriptionCreationDate": "2024-05-15T08:00:00.000Z",
            "planUpgradeCancelPossible": true,
            "paymentFailureMessage": "Payment method expired",
            "invoiceDetails": "https://invoice.example.com/i/test_invoicenumber_2"
        }
    ]
}

Modified at 2026-01-31 08:17:27

Fetch Workspaces by App

Cancel subscription