Subscription
Get company subscription
Returns plan info and credit balance for the authenticated company.
path Parameters
companyIdThe unique identifier of the company whose subscription should be returned. Example: 11111111-2222-3333-4444-555555555555
Headers
GoSmarter-Api-KeyThe GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.
Get company subscription › Responses
Payload of CompanySubscriptionDto
planIdPlan ID
planNamePlan display name
planKeyPlan key
planMonthlyCreditsMonthly credits in plan
monthlyCreditsRemainingMonthly credits remaining this period
topUpCreditsRemainingTop-up credits remaining (never expire)
totalCreditsTotal available credits
hardStopEnabledBlock uploads when credits reach zero
softAlertThresholdWarn when credits fall below this threshold; null = no alert
nextMonthlyResetAtNext monthly credit reset UTC
commitmentTypemonthly or annual
commitmentPeriodStartStart of current annual commitment period; null if monthly
commitmentPeriodEndEnd of current annual commitment period (CommitmentPeriodStart + 12 months); null if monthly
pendingPlanIdPlan to apply at next rollover; null if none pending
pendingPlanNameDisplay name of pending plan
pendingPlanEffectiveAtWhen the pending plan takes effect UTC
changeTypeResult of the last tier change: upgrade | downgrade_scheduled | lateral