Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt

Use this file to discover all available pages before exploring further.

GET /v1/billing/subscription
Returns the active subscription for your tenant, including the current plan, billing status, and period end date.

​
Response

​
status
string
Subscription status: active, past_due, canceled, or trialing.
​
plan_key
string
The active plan identifier (e.g., plan_starter, plan_business).
​
current_period_end
string
ISO 8601 timestamp for when the current billing period ends.
​
cancel_at_period_end
boolean
Whether the subscription is set to cancel at the end of the current period.
To see detailed usage counters for the current billing cycle, use the usage endpoint.