Получить настройки автопополнения

GET

/api/v1/account/billing/auto-topup

Для пользователей из материкового Китая: используйте https://toapis.cn в качестве эндпоинта (Base URL). Замените https://toapis.com на https://toapis.cn во всех примерах этого документа.

Аутентификация, пагинация и ошибки описаны в разделе Начало работы.

Поведение

Только основной аккаунт может читать собственные платежные данные. Для субаккаунта возвращается HTTP 403. Данные участников недоступны через этот метод.

enabled является переключателем настройки; status также отражает паузу, отсутствие карты, проверку и повторные попытки. threshold_credits задает порог, configured_amount_usd задает сумму USD, но не гарантирует итоговый платеж или зачисление. Неизвестное время равно null. reason: card_unbound, charge_failed, verification_required, failure_limit, missing_payment_method, billing_not_linked, configuration_review_required или null. action_required требует интерактивного действия. GET не пытается списать средства.

Аутентификация

Authorizationstringзаголовокобязательно

Используйте Bearer YOUR_SYSTEM_ACCESS_TOKEN. API-ключ модели не подходит. Заголовок X-User-Id не требуется.

Параметры

Параметры пути, параметры запроса и тело запроса не используются.

Пример запроса

curl --request GET \
  --url 'https://toapis.com/api/v1/account/billing/auto-topup' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'

import requests

response = requests.get(
    "https://toapis.com/api/v1/account/billing/auto-topup",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

const url = new URL("https://toapis.com/api/v1/account/billing/auto-topup");

const response = await fetch(url, {
  headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
  signal: AbortSignal.timeout(30_000),
});

if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());

Поля ответа

Данные примеров вымышлены и предполагают credits_per_usd="100". Используйте коэффициент из ответа API.

codeinteger

Числовой код результата; 0 означает успех.

messagestring

Сообщение ответа; пустое при успехе. Сообщения об ошибках локализуются.

dataobject

Объект результата текущего запроса.

data.enabledboolean

Переключатель настройки автопополнения, отдельный от рабочего status.

data.statusstring

Рабочий статус автопополнения: активно, пауза, проверка, нет карты или ожидание повтора. Значения: active, paused, requires_action, missing_payment_method, retry_wait.

data.threshold_creditsstring

Порог остатка для автопополнения в credits. Десятичная строка для сохранения точности.

data.configured_amount_usdstring

Настроенная сумма автопополнения в USD, не гарантия итогового списания или зачисления. Десятичная строка для сохранения точности.

data.last_attempt_atstring | null

Время последней попытки автопополнения. Время в RFC 3339 с часовым поясом. null, если значение неизвестно или неприменимо.

data.last_success_atstring | null

Время последнего успешного автопополнения. Время в RFC 3339 с часовым поясом. null, если значение неизвестно или неприменимо.

data.next_retry_atstring | null

Время следующей попытки автопополнения. Время в RFC 3339 с часовым поясом. null, если значение неизвестно или неприменимо.

data.action_requiredboolean

Требуется ли действие пользователя. Этот GET не инициирует платеж.

data.reasonstring | null

Код причины статуса автопополнения; null, если причина не задана.

data.sourcestring

Источник данных. Локальная конфигурация или реестр не означают актуальное состояние Stripe. Фиксированное значение: "local_configuration".

Пример ответа

{
  "code": 0,
  "message": "",
  "data": {
    "enabled": true,
    "status": "active",
    "threshold_credits": "100",
    "configured_amount_usd": "10",
    "last_attempt_at": "2026-11-01T08:00:00Z",
    "last_success_at": "2026-11-01T08:01:00Z",
    "next_retry_at": null,
    "action_required": false,
    "reason": null,
    "source": "local_configuration"
  }
}