vellTRDocs
API ReferenceSubscriptionsList Subscriptions

List Subscriptions

GET/v1/subscriptionsOptional

List subscriptions with keyset pagination. Filters: storeId, customerId, status, from, to.

Authentication

Signature Pattern

HMAC-SHA256(secretKey, "{timestamp}\nGET\n/v1/subscriptions\n{sha256(\"\")}")
HeaderValueDescription
X-Api-Keypk_live_a1b2c3d4e5f6g7h8Merchant public API key
X-Signature{hmac_sha256_hex}Hex HMAC-SHA256 request signature
X-Timestamp2026-04-13T10:00:00ZISO 8601 UTC request time (±5 min)

Request Parameters

NameTypeRequiredDescription
storeIdstringOptionalFilter by store
customerIdstringOptionalFilter by customer
statusstringOptionaltrialing|active|past_due|paused|cancelled|expired
limitintegerOptionalPage size
cursorstringOptionalOpaque keyset cursor

Response Parameters

FieldTypeExample
itemsarray[…]
items[].idstring"sub_5e6f70819a2b"
items[].storeIdstring"sto_5a6b7c8d"
items[].statusstring"active"
items[].amountMinorinteger50000
items[].currencystring"TRY"
items[].intervalCountinteger1
items[].intervalUnitstring"month"
items[].nextChargeAtstring"2026-05-13T10:00:00Z"
items[].createdAtstring"2026-04-13T10:00:00Z"
nextCursorstring"eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTEzVDEwOjAw…

Response Example

JSONResponse
{
  "items": [
    {
      "id": "sub_5e6f70819a2b",
      "storeId": "sto_5a6b7c8d",
      "status": "active",
      "amountMinor": 50000,
      "currency": "TRY",
      "intervalCount": 1,
      "intervalUnit": "month",
      "nextChargeAt": "2026-05-13T10:00:00Z",
      "createdAt": "2026-04-13T10:00:00Z"
    }
  ],
  "nextCursor": "eyJjcmVhdGVkQXQiOiIyMDI2LTA0LTEzVDEwOjAwOjAwWiJ9"
}

Status Codes

200Success
201Created
400Bad Request
401Unauthorized
404Not Found
429Rate Limited
Try itMock
GEThttps://api.pay.sandbox.kvell.group