Query Subscriptions via API

Get all subscriptions in your account or retrieve a specific subscription.

Retrieve all subscriptions in your account

NOTE: When using the production environment (app.hel.io), set your API endpoint to api.hel.io/v1 and generate API keys there. For the development environment, use api.dev.hel.io/v1 and generate API keys from app.dev.hel.io.

You can retrieve all subscriptions set up under your account, with the added ability to filter by Pay Link ID and email.

API Endpoint: https://api.hel.io/v1/subscriptions
HTTP Method: GET
Required Headers: Authorization: Bearer {SECRET_API_KEY}

Query Parameters

Parameter

Type

Required

Description

apiKey

String

Yes

Your Public API Key

paylink

String

The Pay Link ID of the subscription

email

String

The email used to sign up for the subscription

Example URL with Query Parameters

https://api.hel.io/v1/subscriptions?apiKey=0VZWmr3rbi~Z_BN-urmGGl90bYZ8D5LLAu7QCZ3xIeQmQZo.9gEFm8M1AMaeev1Y&email=test@hel.io&paylink=67a0d1ed18c700e1cda9ebf6

Sample Response

{
        "id": "67a1e53e10905ce3927d6f1a",
        "status": "EXPIRED",
        "email": "test@hel.io",
        "renewalDate": "2025-03-04T00:00:00.000Z",
        "createdAt": "2025-02-04T10:00:30.259Z",
        "transactions": [
            {
                "id": "67a1e53810905ce3927d6e46",
                "paylinkId": "67a0d1ed18c700e1cda9ebf6",
                "fee": "2000",
                "quantity": 1,
                "createdAt": "2025-02-04T10:00:24.839Z",
                "paymentType": "PAYLINK",
                "meta": {
                    "id": "67a1e53810905ce3927d6e44",
                    "amount": "98000",
                    "senderPK": "7YancRyNQyp9s6G7YNwx9H93UqswoKWqF9GuNJPufyvW",
                    "recipientPK": "7YancRyNQyp9s6G7YNwx9H93UqswoKWqF9GuNJPufyvW",
                    "transactionType": "PAYLINK",
                    "customerDetails": {
                        "email": "jkbaffourr@gmail.com",
                        "discordUser": null
                    },
                    "productDetails": null,
                    "additionalProductDetails": [],
                    "transactionSignature": "5QCkdQSeRd3sHs9etreVn1qR7RGcGrsQoHm6vw2ddSXYjSafrkSpPg3uCzv7D2eKg4toBPPyzyAxDUZDBPyGXBoD",
                    "transactionStatus": "SUCCESS",
                    "splitRevenue": false,
                    "remainingAccounts": [],
                    "totalAmount": "98000",
                    "affiliateAmount": "0",
                    "tokenQuote": {
                        "from": "USDC",
                        "fromAmountDecimal": "0.1",
                        "to": "USDC",
                        "toAmountMinimal": "100000"
                    },
                    "shopifyPaymentDetails": null,
                    "submitGeolocation": "GB"
                }
            }
        ]
    },
    {
        "id": "67a1e561b49e0bc0ea87ca27",
        "status": "ACTIVE",
        "email": "alan@hel.io",
        "renewalDate": "2025-03-04T00:00:00.000Z",
        "createdAt": "2025-02-04T10:01:05.271Z",
        "transactions": [
            {
                "id": "67a1e55ab49e0bc0ea87c953",
                "paylinkId": "67a0d1ed18c700e1cda9ebf6",
                "fee": "2000",
                "quantity": 1,
                "createdAt": "2025-02-04T10:00:58.917Z",
                "paymentType": "PAYLINK",
                "meta": {
                    "id": "67a1e55ab49e0bc0ea87c951",
                    "amount": "98000",
                    "senderPK": "7YancRyNQyp9s6G7YNwx9H93UqswoKWqF9GuNJPufyvW",
                    "recipientPK": "7YancRyNQyp9s6G7YNwx9H93UqswoKWqF9GuNJPufyvW",
                    "transactionType": "PAYLINK",
                    "customerDetails": {
                        "email": "jb18xpsn@gmail.com",
                        "discordUser": null
                    },
                    "productDetails": null,
                    "additionalProductDetails": [],
                    "transactionSignature": "62TbrxTXQkqbGrVGLtFTLV3ReMgP85fGhrFnAmy1ME5svbX19TJc4fzUnKr6Umjyrz3ma153x4KNy5F6XosGspyx",
                    "transactionStatus": "SUCCESS",
                    "splitRevenue": false,
                    "remainingAccounts": [],
                    "totalAmount": "98000",
                    "affiliateAmount": "0",
                    "tokenQuote": {
                        "from": "USDC",
                        "fromAmountDecimal": "0.1",
                        "to": "USDC",
                        "toAmountMinimal": "100000"
                    },
                    "shopifyPaymentDetails": null,
                    "submitGeolocation": "GB"
                }
            }
        ]
    }
]

Query a specific subscription

You can query a specific subscription to view its status or additional details. This is done using the subscription ID, which can be retrieved via the https://api.hel.io/v1/subscriptions endpoint.

API Endpoint: https://api.hel.io/v1/subscriptions/{id}
HTTP Method: GET
Required Headers: Authorization: Bearer {SECRET_API_KEY}
Required Query Parameters: ?apiKey={Your public key here}
Required Path: id

id refers to the subscription ID, which can be retrieved using the https://api.hel.io/v1/subscriptions endpoint here.

Example URL with Query Parameters

https://api.hel.io/v1/subscriptions/67a0d2ea18c700e1cda9f1b8?apiKey=0VZWmr3rbi~Z_BN-urmGGl90bYZ8D5LLAu7QCZ3xIeQmQZo.9gEFm8M1AMaeev1Y

Sample Response

{
    "id": "67a0d2ea18c700e1cda9f1b8",
    "status": "ACTIVE",
    "email": "test@hel.io",
    "renewalDate": "2025-03-03T00:00:00.000Z",
    "createdAt": "2025-02-03T14:30:02.287Z",
    "transactions": [
        {
            "id": "67a0d2e318c700e1cda9f09d",
            "paylinkId": "67a0d1ed18c700e1cda9ebf6",
            "fee": "2000",
            "quantity": 1,
            "createdAt": "2025-02-03T14:29:55.911Z",
            "paymentType": "PAYLINK",
            "meta": {
                "id": "67a0d2e318c700e1cda9f09b",
                "amount": "98000",
                "senderPK": "7YancRyNQyp9s6G7YNwx9H93UqswoKWqF9GuNJPufyvW",
                "recipientPK": "7YancRyNQyp9s6G7YNwx9H93UqswoKWqF9GuNJPufyvW",
                "transactionType": "PAYLINK",
                "customerDetails": {
                    "email": "jesse@hel.io",
                    "discordUser": null
                },
                "productDetails": null,
                "additionalProductDetails": [],
                "transactionSignature": "5UtTTc2rph145g6YRCZv5no6dfQBAVfp3Rw4KvQXpBPJ1BBu2F8JJBd7uUGoxVN7GAjjKaDPMb3VynXj4FrUbRv2",
                "transactionStatus": "SUCCESS",
                "splitRevenue": false,
                "remainingAccounts": [],
                "totalAmount": "98000",
                "totalAmountAsUSD": "98000",
                "affiliateAmount": "0",
                "tokenQuote": {
                    "from": "USDC",
                    "fromAmountDecimal": "0.1",
                    "to": "USDC",
                    "toAmountMinimal": "100000"
                },
                "shopifyPaymentDetails": null,
                "submitGeolocation": "GB"
            }
        }
    ]
}

PreviousCreate Subscriptions via API NextWebhooks

Last updated 8 days ago