Skip to main content
GET
/
v1
/
billing
/
subscription
Get subscription details
curl --request GET \
  --url https://api.truthlocks.com/v1/billing/subscription \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "plan": "<string>",
  "status": "<string>",
  "current_period_end": "<string>"
}
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.

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Response

Subscription details

​
id
string
​
plan
string
​
status
string
​
current_period_end
string