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

api

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

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

boolean

Whether auto topup is currently active.

number

Balance threshold (in account currency) below which a recharge is triggered.

number

Amount charged each time the threshold is hit.

boolean

Whether monthly scheduled recharges are active (independent of the threshold).

number

Amount charged on the scheduled day. Required when scheduled_payment_enabled is true.

integer

Day of month (1–28) for scheduled recharges.

string

ID of the saved payment method used for charges.

number

Maximum total amount that can be charged in a single day across all auto-topup events.

integer

Number of recharges already executed today.

string

ISO 8601 timestamp of the most recent recharge.

Get Started

Concepts

API Reference

Guides

Get Auto Topup Settings

Get Auto Topup Settings

Endpoint

Request headers

Examples

Response

Response fields

​Get Auto Topup Settings

​Endpoint

​Request headers

​Examples

​Response

​Response fields

Get Auto Topup Settings

Endpoint

Request headers

Examples

Response

Response fields