Billing status
curl --request GET \
--url https://staging-api.usetyms.com/v1/adam/referred-businesses/{business_uuid}/billing-status \
--header 'X-API-Key: <api-key>'import requests
url = "https://staging-api.usetyms.com/v1/adam/referred-businesses/{business_uuid}/billing-status"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://staging-api.usetyms.com/v1/adam/referred-businesses/{business_uuid}/billing-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Billing status retrieved successfully.",
"data": {
"business_uuid": "a1b2c3d4e5f6",
"name": "Smith Enterprises",
"billing_currency": "USD",
"subscription_status": "active",
"available_seats": 3,
"subscription_plan": "plus",
"credit_balance": 1250.5,
"subscription_expires_at": "2026-08-09T02:00:00.000000Z",
"credit_from_referral_partner": false,
"gateway": "referral_partner"
}
}{
"status": "failed",
"message": "<string>"
}{
"status": "failed",
"message": "<string>"
}{
"status": "failed",
"message": "<string>"
}Distribution Partners
Billing status
Subscription state, licensed seats, plan, and AI credit balance for one referred business.
GET
/
referred-businesses
/
{business_uuid}
/
billing-status
Billing status
curl --request GET \
--url https://staging-api.usetyms.com/v1/adam/referred-businesses/{business_uuid}/billing-status \
--header 'X-API-Key: <api-key>'import requests
url = "https://staging-api.usetyms.com/v1/adam/referred-businesses/{business_uuid}/billing-status"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://staging-api.usetyms.com/v1/adam/referred-businesses/{business_uuid}/billing-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Billing status retrieved successfully.",
"data": {
"business_uuid": "a1b2c3d4e5f6",
"name": "Smith Enterprises",
"billing_currency": "USD",
"subscription_status": "active",
"available_seats": 3,
"subscription_plan": "plus",
"credit_balance": 1250.5,
"subscription_expires_at": "2026-08-09T02:00:00.000000Z",
"credit_from_referral_partner": false,
"gateway": "referral_partner"
}
}{
"status": "failed",
"message": "<string>"
}{
"status": "failed",
"message": "<string>"
}{
"status": "failed",
"message": "<string>"
}available_seats counts only partner-provided Plus seats — 0 even if the business pays for Plus themselves. Call before Add seats or Add credits.Authorizations
Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.
Path Parameters
UUID from register-business or your referred-businesses list.
Response
Billing snapshot