Get all subscriptions

Request

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

Example

{
    "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"
        }
    ]
}