Get billing status
Get comprehensive billing status for a business including trial, subscription, and lockout info
X-Api-Key<token>
Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.
In: header
Path Parameters
businessId*unknown
Business ID (legacy path param — the effective business is the guarded X-Business-Id header, see SECURITY note below)
Response Body
application/json
curl -X GET "https://example.com/billing/status/{businessId}"{ "billingStatus": "trial_active", "isTrialActive": true, "trialDaysRemaining": 15, "trialEndsAt": "2025-02-15T00:00:00Z", "hasValidPaymentMethod": false, "currentCycleStart": {}, "currentCycleEnd": {}, "nextBillingAmount": 196, "gracePeriodEndsAt": {}, "lockedOutAt": {}, "canCreateDocuments": true, "canUsePremiumFeatures": true, "canViewData": true, "smsUsage": { "messageCount": 12, "segmentCount": 15, "estimatedCost": 1.8 }, "gracePeriodDays": 7}