Skip to main content
GET
/
v1
/
billing
/
config
Get billing configuration
curl --request GET \
  --url https://api.truthlocks.com/v1/billing/config \
  --header 'X-API-Key: <api-key>'
{
  "country_code": "<string>",
  "effective_provider": "<string>",
  "visible_providers": [
    "<string>"
  ],
  "current_plan": "<string>"
}
GET /v1/billing/config
Returns the payment provider routed for your region and your current plan. Use this to determine which checkout flow to present.

​
Query parameters

​
country
string
Optional ISO 3166-1 alpha-2 country code (e.g., US, NG, GH). Overrides the tenant’s stored country for provider routing. Useful for previewing checkout options in a different region.

​
Response

​
country_code
string
The country code used for provider routing.
​
effective_provider
string
The payment provider selected for this region (stripe, paystack, or flutterwave).
​
visible_providers
string[]
All providers available in this region.
​
current_plan
string
The tenant’s active plan key (FREE, STARTER, BUSINESS, or ENTERPRISE).

​
Provider routing by region

RegionAvailable providersDefault
Global (default)StripeStripe
Nigeria (NG)Paystack, FlutterwavePaystack
Africa (non-NG)FlutterwaveFlutterwave
See provider routing for more details.

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Query Parameters

​
country
string

ISO 3166-1 alpha-2 country code for provider routing override

Response

Billing configuration

​
country_code
string
​
effective_provider
string
​
visible_providers
string[]
​
current_plan
string