Skip to main content
GET
/
api
/
v1
/
auto-topup
/
settings
curl "https://app.talkover.ai/api/v1/auto-topup/settings" \
  -H "Authorization: Bearer talq_your_environment_token_here"

{
  "success": true,
  "data": {
    "is_enabled": true,
    "threshold_amount": 50.00,
    "recharge_amount": 100.00,
    "scheduled_payment_enabled": false,
    "scheduled_amount": null,
    "day_of_month": null,
    "payment_method_id": "pm_uuid_1",
    "daily_limit": 500.00,
    "recharge_count_today": 0,
    "last_recharge_at": "2024-01-10T14:30:00Z",
    "currency": "USD"
  }
}

​
Get Auto Topup Settings

Retrieve the current auto topup configuration for your environment. Auto topup automatically recharges your account balance when it falls below a threshold, or on a scheduled day each month.

​
Endpoint

GET /api/v1/auto-topup/settings

​
Request headers

​
Authorization
string
required
Bearer token. Format: Bearer talq_your_environment_token_here

​
Examples

curl "https://app.talkover.ai/api/v1/auto-topup/settings" \
  -H "Authorization: Bearer talq_your_environment_token_here"

​
Response

{
  "success": true,
  "data": {
    "is_enabled": true,
    "threshold_amount": 50.00,
    "recharge_amount": 100.00,
    "scheduled_payment_enabled": false,
    "scheduled_amount": null,
    "day_of_month": null,
    "payment_method_id": "pm_uuid_1",
    "daily_limit": 500.00,
    "recharge_count_today": 0,
    "last_recharge_at": "2024-01-10T14:30:00Z",
    "currency": "USD"
  }
}

​
Response fields

​
data.is_enabled
boolean
Whether auto topup is currently active.
​
data.threshold_amount
number
Balance threshold (in account currency) below which a recharge is triggered.
​
data.recharge_amount
number
Amount charged each time the threshold is hit.
​
data.scheduled_payment_enabled
boolean
Whether monthly scheduled recharges are active (independent of the threshold).
​
data.scheduled_amount
number
Amount charged on the scheduled day. Required when scheduled_payment_enabled is true.
​
data.day_of_month
integer
Day of month (1–28) for scheduled recharges.
​
data.payment_method_id
string
ID of the saved payment method used for charges.
​
data.daily_limit
number
Maximum total amount that can be charged in a single day across all auto-topup events.
​
data.recharge_count_today
integer
Number of recharges already executed today.
​
data.last_recharge_at
string
ISO 8601 timestamp of the most recent recharge.