billing

Get Subscription Status

Get current subscription status for the company.

Returns subscription tier, status, and access information. If no subscription exists, creates a FREE tier subscription.

get/api/v1/billing/status

Request

  • The document declares no server URL.
  • Auth: none declared

Headers

authorizationstring nullable
x-api-keystring nullable

Response

Successful Response

company_idinteger required
tier'free' | 'starter' | 'professional' | 'business' | 'enterprise' required

Subscription pricing tiers (consumer/prosumer model).

Maps to Stripe price IDs.

status'active' | 'past_due' | 'suspended' | 'cancelled' required

Subscription status lifecycle.

Flow: active -> past_due -> suspended -> cancelled

has_accessboolean required

Whether company has product access

current_period_startstring date-time required
current_period_endstring date-time required
cancelled_atstring date-time nullable
suspended_atstring date-time nullable

Changes

No recorded changes to this operation across all 5 revisions of this API.