BizKitHub
DocsAPI ReferenceDashboard/bff/dashboard/upcoming-renewals
getDashboardAdmin BFF

/bff/dashboard/upcoming-renewals

Lists subscriptions due for renewal soon. Enables proactive churn prevention - better than reacting after the fact.

DashboardgetBffDashboardUpcoming-renewals

Parameters

1 query

Query parameters

· 1
daysnumberOptional

Days ahead to check. Defaults to 30.

Default: 30
Example30

Response schema

1 status code documented

200SuccessUpcoming renewals analysis.
summaryobjectRequired
totalRenewalsnumberRequired

Total renewals in period.

totalMrrAtRisknumberRequired

MRR value at risk.

autoRenewCountnumberRequired

Auto-renew subscriptions.

manualRenewCountnumberRequired

Manual renewal required.

byTimeBucketobjectRequired
thisWeekobjectRequired
countnumberRequired

Renewals this week.

mrrnumberRequired

MRR this week.

nextWeekobjectRequired
countnumberRequired

Renewals next week.

mrrnumberRequired

MRR next week.

thisMonthobjectRequired
countnumberRequired

Renewals this month.

mrrnumberRequired

MRR this month.

laterobjectRequired
countnumberRequired

Renewals later.

mrrnumberRequired

MRR later.

renewalsobject[]Required

Upcoming renewals list (max 50).

Each array item:
subscriptionIdnumberRequired

Subscription ID.

externalIdstringRequired

External subscription ID.

customerNamestringRequired

Customer name.

customerEmailstringRequired

Customer email.

productNamestringRequired

Subscription product.

renewalDatestringRequired

Renewal date (YYYY-MM-DD).

pricenumberRequired

Subscription price.

autoRenewbooleanRequired

Auto-renew enabled.

daysUntilRenewalnumberRequired

Days until renewal.

currencystringRequired

Currency code.

Response example

application/json
{
  "summary": {
    "totalRenewals": 0,
    "totalMrrAtRisk": 0,
    "autoRenewCount": 0,
    "manualRenewCount": 0
  },
  "byTimeBucket": {
    "thisWeek": {
      "count": 0,
      "mrr": 0
    },
    "nextWeek": {
      "count": 0,
      "mrr": 0
    },
    "thisMonth": {
      "count": 0,
      "mrr": 0
    },
    "later": {
      "count": 0,
      "mrr": 0
    }
  },
  "renewals": [
    {
      "subscriptionId": 0,
      "externalId": "example_externalId",
      "customerName": "example_customerName",
      "customerEmail": "example_customerEmail",
      "productName": "example_productName",
      "renewalDate": "example_renewalDate",
      "price": 0,
      "autoRenew": false,
      "daysUntilRenewal": 0
    }
  ],
  "currency": "example_currency"
}

Request example

GET /bff/dashboard/upcoming-renewals

get
curl -X GET "https://api.bizkithub.com/bff/dashboard/upcoming-renewals?days=30" \
  -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