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/checkout
Creates a checkout session with the appropriate payment provider for your region. The response includes a URL where the user completes payment.

Request body

plan_key
string
required
The plan to subscribe to: STARTER, BUSINESS, or ENTERPRISE.
provider
string
Payment provider to use (stripe, paystack, or flutterwave). If omitted, the provider is selected automatically based on your region. See billing configuration to check your default provider.
success_url
string
required
URL to redirect the user to after successful payment.
cancel_url
string
required
URL to redirect the user to if they cancel the checkout.

Response

checkout_url
string
The hosted checkout page URL. Redirect the user to this URL to complete payment.