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.

POST /v1/billing/cancel
Cancels your active subscription. The cancellation takes effect at the end of the current billing period — you retain full access until then. After the period ends, your account downgrades to the Developer (free) plan.

​
Response

Returns the updated subscription object with cancel_at_period_end set to true.
​
status
string
Subscription status. Remains active until the period ends, then changes to canceled.
​
plan_key
string
The current plan identifier (e.g., plan_starter, plan_business).
​
current_period_end
string
ISO 8601 timestamp for when the current billing period ends and the cancellation takes effect.
​
cancel_at_period_end
boolean
true after a successful cancellation request.
Cancellation is immediate but takes effect at the end of your billing period. You cannot undo a cancellation via the API — to resubscribe, create a new checkout session.