BizKitHub
DocsAPI ReferenceSubscription/api/v1/subscription/active-list
getSubscriptionPublic API v1

/api/v1/subscription/active-list

No description provided.

subscriptiongetApiV1SubscriptionActive-list

Parameters

2 query

Query parameters

· 2
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
identityIdstringRequired

Logged user identity (from your frontend cookies). Learn more

ExampleZ9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg

Response schema

1 status code documented

200Success
runningSubscriptionListobject[]Required
Each array item:
externalIdstringRequired
Exampled9DfQL3ZF01t7Ykk
productSlugstringRequired
Examplepredplatne-rocni
productCodestringRequired
Examplepredplatne-rocni
orderNumberstringRequired
Example25000001
orderHashstringRequired
ExampleCuS08iXV3cOwweQsQB3TwYXtDr67K4kW
autoRenewbooleanRequired
Exampletrue
renewalDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
activeToDateDate | string | string | numberOptional
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
lastSuccessPaymentDateDate | string | string | numberOptional
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number

Response example

application/json
{
  "runningSubscriptionList": [
    {
      "externalId": "d9DfQL3ZF01t7Ykk",
      "productSlug": "predplatne-rocni",
      "productCode": "predplatne-rocni",
      "orderNumber": "25000001",
      "orderHash": "CuS08iXV3cOwweQsQB3TwYXtDr67K4kW",
      "autoRenew": true
    }
  ]
}

Request example

GET /api/v1/subscription/active-list

get
curl -X GET "https://api.bizkithub.com/api/v1/subscription/active-list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key