BizKitHub
DocsAPI ReferenceSubscription/bff/subscription/list
getSubscriptionAdmin BFF

/bff/subscription/list

Returns every subscription of the contact whose activeToDate is in the future. Same primitive that powers /api/v1/subscription/active-list, scoped to the authenticated organisation. itemCount mirrors items.length so the response plugs straight into DataGrid without a separate count query.

SubscriptiongetBffSubscriptionList

Parameters

1 query

Query parameters

· 1
customerIdstringRequired

Contact external ID.

Exampleabc123def456ghij

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
externalIdstringRequired

Subscription external ID.

productSlugstringRequired

Product slug.

productCodestringRequired

Product code.

orderNumberstringRequired

Order number that initiated this subscription.

orderHashstringRequired

Order hash for admin linking.

autoRenewbooleanRequired

Whether the subscription auto-renews on renewalDate.

renewalDateDate | string | string | numberRequired

Next renewal charge attempt.

One of 4:
Variant 1
Date

Next renewal charge attempt.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
activeToDateDate | string | string | numberOptional

Access is granted until this date.

One of 4:
Variant 1
Date

Access is granted until this date.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
lastSuccessPaymentDateDate | string | string | numberOptional

Timestamp of the last successful renewal charge.

One of 4:
Variant 1
Date

Timestamp of the last successful renewal charge.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
itemCountnumberRequired

Total number of active subscriptions.

Response example

application/json
{
  "items": [
    {
      "externalId": "example_externalId",
      "productSlug": "example_productSlug",
      "productCode": "example_productCode",
      "orderNumber": "example_orderNumber",
      "orderHash": "example_orderHash",
      "autoRenew": false
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/subscription/list

get
curl -X GET "https://api.bizkithub.com/bff/subscription/list?customerId=abc123def456ghij" \
  -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