Skip to main content
GET
/
v1
/
subscriptions
/
{id}
Get a Subscription by ID
curl --request GET \
  --url https://api.hel.io/v1/subscriptions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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"
      }
    }
  ]
}
Note: When using the production environment at moonpay.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 moonpay.dev.hel.io.

Authorizations

​
Authorization
string
header
required

Authentication using JWT token

Path Parameters

​
id
string
required

The ID of the specific subscription. You can retrieve this ID using the /v1/subscriptions endpoint.

Query Parameters

​
apiKey
string
required

API key can be generated on helio dashboard settings page

Response

Successfully retrieved subscription with transactions.

​
transactions
object[]
required
​
id
string
required
​
status
enum<string>
required
Available options:
ACTIVE,
EXPIRED
​
email
string
required
​
renewalDate
string
required
​
createdAt
string
required